Ludus API
    • Host Management
      • Retrieve the ludus version
      • Retrieve the ludus license
      • Diagnostics
      • Retrieve the Ludus OpenAPI specification
    • Ansible Management
      • Retrieve available subscription roles
      • Install subscription roles
      • Get role variables for one or more Ansible roles
      • Install an Ansible collection
      • Retrieve available Ansible roles and collections
      • Move or copy roles between global and local scopes
      • Install or Remove an Ansible role
      • Install an Ansible role from local directory
    • User Management
      • whoami
      • Get Default Range ID
      • Set Default Range ID
      • Get user group memberships
      • List user details
      • Add a user to the system
      • Remove a user from the system
      • Get proxmox creds for a user
      • Set the Ludus and Proxmox creds for the user
      • Reset and retrieve the Ludus API key for a user
      • List all users
      • Retrieve a WireGuard configuration file for a user
    • Range Management
      • VM Management
      • Create a new range
      • List range VMs, power state, and testing state
      • Delete a range from the database and proxmox host
      • Stop the range deployment ansible process
      • Stop and delete all range VMs
      • List all tags available to use with deploy
      • List summary information for all ranges
      • Retrieve range configuration
      • Update the range configuration
      • Retrieve an example range configuration
      • Deploy the range
      • Retrieve the latest range logs
      • Retrieve /etc/hosts file for the range
      • Retrieve a ssh config
      • Retrieve a zip file of RDP configs
      • Retrieve an ansible inventory
      • Assign a range to a user (admin only)
      • Revoke range access from a user (admin only)
      • List users with access to a range (admin only)
      • List ranges accessible to the user
      • List range deploy log history
      • Retrieve a specific range log history entry
      • Retrieve auto-shutdown configuration (enterprise)
      • Update auto-shutdown (enterprise)
    • Power State Management
      • Power on range VMs
      • Power off range VMs
    • Testing State Management
      • Snapshot and enter testing state
      • Revert and exit testing state
      • Allow a domain
      • Deny a domain
      • Update a VM or group
    • Anti-Sandbox Management
      • Enable anti-sandbox for a VM or multiple VMs (enterprise)
      • Install the custom QEMU/OMVF packages
      • Install the standard QEMU/OMVF packages
    • Template Management
      • Retrieve a list of VM templates
      • Build templates
      • Install an Ansible role from local directory
      • Delete a template
      • Kill packer processes for user
      • Retrieve the latest packer logs
      • Get the status of packer builds
      • List template build log history
      • Retrieve a specific template log history entry
    • Snapshot Management
      • Get all snapshots for a range
      • Take a snapshot of a VM or multiple VMs
      • Roll back to a snapshot of a VM or multiple VMs
      • Delete a snapshot from a VM or multiple VMs
    • KMS Management
      • Setup the KMS VM and install the KMS server
      • License Windows VMs using the KMS server
    • Group Management
      • Create a new group
      • List all groups
      • Delete a group
      • List group members
      • Add users to group
      • Remove users from group
      • List group ranges
      • Add ranges to group
      • Remove ranges from group
    • Migration
      • SDN Migration Status
      • Migrate to SDN networking
      • Migrate SQLite to PocketBase
    • Blueprint Management
      • List blueprints
      • Create blueprint
      • Create blueprint from range
      • Copy blueprint
      • Import blueprint
      • Apply blueprint to range
      • Get blueprint config
      • Update blueprint config
      • List blueprint access users
      • Share blueprint with users
      • Unshare blueprint from users
      • List blueprint access groups
      • Share blueprint with groups
      • Unshare blueprint from groups
      • Get blueprint detail
      • Install blueprint dependencies
      • Export blueprint
      • Delete blueprint
    • Quota Management
      • Get quota status for the current user
      • Set quotas for one or more users (admin only)
      • Get quota status for all users (admin only)
      • Get system-wide default quotas (admin only)
      • Get default quotas for all groups (admin only)
      • Set default quotas for one or more groups (admin only)
    • Sources
      • Create source
      • Get source catalog
      • Install items from source
      • Sync source
      • Update source
      • List sources
      • Get source metadata
      • List source blueprints
      • List source templates
      • List source roles
      • List source collections
      • Delete source
    • VM Management
      • Destroy VM
      • Get Console Websocket Ticket
      • Connect to VM Console WebSocket
    • Schemas
      • userID
      • BlueprintListItem
      • BulkAddUsersToGroupRequest
      • rangeID
      • CreateBlueprintFromRangeRequest
      • BulkRemoveUsersFromGroupRequest
      • UserObject
      • CopyBlueprintRequest
      • BulkAddRangesToGroupRequest
      • ApplyBlueprintRequest
      • BulkRemoveRangesFromGroupRequest
      • UserAPIKeyObject
      • UpdateBlueprintConfigRequest
      • UserCredentialObject
      • BulkGroupOperationResponse
      • RangeObject
      • UserMembershipObject
      • BulkGroupOperationErrorItem
      • BulkShareBlueprintWithGroupsRequest
      • BlueprintAccessUserItem
      • BulkUnshareBlueprintWithGroupsRequest
      • BlueprintAccessGroupItem
      • BulkShareBlueprintWithUsersRequest
      • Domain
      • BulkUnshareBlueprintWithUsersRequest
      • IP
      • AllowPayload
      • BulkBlueprintOperationErrorItem
      • SnapshotInfo
      • BulkBlueprintOperationResponse
      • BlueprintMutationResponse
      • ErrorInfo
      • SnapshotCreatePayload
      • LicenseDataObject
      • AnsibleInstallResult
      • UndeclaredDependency
      • SyncResultResponse
      • InstallBlueprintDepsRequest
      • BlueprintDetail
      • CatalogItem
      • CatalogBlueprint
      • SourceResponse
      • SourceCatalog
      • UpdateSourceRequest
      • RegisterSourceResponse
      • SyncSourceRequest
      • SyncResult
      • InstallRequest
      • InstallSelection
      • DeleteSourceResponse
      • VMObject
      • BlueprintCreatedResponse
      • CreateBlueprintRequest
      • LogHistoryEntry
      • CopyBlueprintResponse
      • LogHistoryDetailResponse
      • UpdateBlueprintMetadataRequest
      • JobAcceptedResponse
      • TemplateStatusEntry
      • RoleStatusEntry
      • SourceCreateResponse
      • DeleteSourceRequest
      • ArtifactResult
      • RoleInstallResult
      • DryRunPlan
      • SourceBlueprintListItem
      • ListSourceTemplatesResponseItem
      • ListSourceCollectionsResponseItem
      • ListSourceRolesResponseItem
      • BlueprintCreatedResponseRoleResult
      • BlueprintCreatedResponseAnsibleResult
      • CatalogBlueprints

    CatalogBlueprints

    The source's blueprints plus the dependency closure they pull in: galaxy roles/collections and subscription roles unioned across every blueprint's requirements.yml, plus any config.yml role references that aren't declared there.

    {
    "items": [
        {
            "id": "string",
            "name": "string",
            "description": "string",
            "version": "string",
            "state": "not_installed",
            "installedVersion": "string",
            "requiredTemplates": [
                "string"
            ],
            "requiredLocalRoles": [
                "string"
            ],
            "requiredRoles": [
                "string"
            ],
            "requiredCollections": [
                "string"
            ]
        }
    ],
    "requiredRoles": [
        {
            "name": "string",
            "description": "string",
            "version": "string",
            "state": "not_installed",
            "installedVersion": "string",
            "global": true,
            "scopes": [
                {
                    "scope": "string",
                    "version": "string",
                    "state": "installed"
                }
            ],
            "type": "string",
            "fqcn": "string",
            "requiredBy": [
                "string"
            ],
            "versionByBlueprint": {
                "property1": "string",
                "property2": "string"
            }
        }
    ],
    "requiredCollections": [
        {
            "name": "string",
            "description": "string",
            "version": "string",
            "state": "not_installed",
            "installedVersion": "string",
            "global": true,
            "scopes": [
                {
                    "scope": "string",
                    "version": "string",
                    "state": "installed"
                }
            ],
            "type": "string",
            "fqcn": "string",
            "requiredBy": [
                "string"
            ],
            "versionByBlueprint": {
                "property1": "string",
                "property2": "string"
            }
        }
    ],
    "subscriptionRoles": [
        {
            "name": "string",
            "description": "string",
            "version": "string",
            "state": "not_installed",
            "installedVersion": "string",
            "global": true,
            "scopes": [
                {
                    "scope": "string",
                    "version": "string",
                    "state": "installed"
                }
            ],
            "type": "string",
            "fqcn": "string",
            "requiredBy": [
                "string"
            ],
            "versionByBlueprint": {
                "property1": "string",
                "property2": "string"
            }
        }
    ],
    "undeclaredDependencies": [
        {
            "blueprintID": "string",
            "role": "string",
            "kind": "missing_role",
            "parentCollection": "string"
        }
    ]
}
    Built with