1. Virtual Consoles
Ludus API
  • Host Management
    • Retrieve the ludus version
      GET
    • Retrieve the ludus license
      GET
    • Diagnostics
      GET
    • Retrieve the Ludus OpenAPI specification
      GET
  • Ansible Management
    • Retrieve available subscription roles
      GET
    • Install subscription roles
      POST
    • Get role variables for one or more Ansible roles
      POST
    • Retrieve available Ansible roles and collections
      GET
    • Move or copy roles between global and local scopes
      PATCH
    • Install or Remove an Ansible role
      POST
    • Install an Ansible role from local directory
      PUT
    • Install an Ansible collection
      POST
  • User Management
    • whoami
      GET
    • Get Default Range ID
      GET
    • Set Default Range ID
      POST
    • Get user group memberships
      GET
    • List user details
      GET
    • Add a user to the system
      POST
    • Remove a user from the system
      DELETE
    • Get proxmox creds for a user
      GET
    • Set the Ludus and Proxmox creds for the user
      POST
    • Reset and retrieve the Ludus API key for a user
      GET
    • List all users
      GET
    • Retrieve a WireGuard configuration file for a user
      GET
  • Range Management
    • VM Management
      • Destroy VM
    • 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
  • Virtual Consoles
    • Get Console Websocket Ticket
      GET
    • Connect to VM Console WebSocket
      GET
  • Blueprint Management
    • List accessible blueprints
    • Create blueprint
    • Create blueprint from range
    • Get blueprint detail
    • Copy blueprint
    • Delete blueprint
    • Import blueprint
    • Apply blueprint to range
    • Get blueprint config
    • Update blueprint config
    • Share blueprint with groups
    • Unshare blueprint from groups
    • Share blueprint with users
    • Unshare blueprint from users
    • List blueprint access users
    • List blueprint access groups
    • Export blueprint
    • Install blueprint dependencies
  • 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
    • Update source
    • Get source
    • Delete source
    • List sources
    • Create source
    • Sync source
    • Get source catalog
    • Install items from a source
    • List source collections
    • List blueprints in a source
    • List all source blueprints
    • Get source blueprint manifest
    • List source templates
    • List source roles
  • Schemas
    • BlueprintListItem
    • BulkAddUsersToGroupRequest
    • userID
    • BulkRemoveUsersFromGroupRequest
    • SyncResultResponse
    • CreateBlueprintFromRangeRequest
    • rangeID
    • BulkAddRangesToGroupRequest
    • UserObject
    • CopyBlueprintRequest
    • ApplyBlueprintRequest
    • BulkRemoveRangesFromGroupRequest
    • UserAPIKeyObject
    • UpdateBlueprintConfigRequest
    • BulkGroupOperationResponse
    • UserCredentialObject
    • BulkGroupOperationErrorItem
    • BulkShareBlueprintWithGroupsRequest
    • UserMembershipObject
    • RangeObject
    • BlueprintAccessUserItem
    • BulkUnshareBlueprintWithGroupsRequest
    • BlueprintAccessGroupItem
    • BulkShareBlueprintWithUsersRequest
    • Domain
    • BulkUnshareBlueprintWithUsersRequest
    • IP
    • BulkBlueprintOperationErrorItem
    • AllowPayload
    • BulkBlueprintOperationResponse
    • SnapshotInfo
    • ErrorInfo
    • BlueprintMutationResponse
    • SnapshotCreatePayload
    • InstallSelection
    • LicenseDataObject
    • InstallRequest
    • RegisterSourceResponse
    • SourceCatalog
    • CatalogBlueprint
    • CatalogItem
    • UndeclaredDependency
    • VMObject
    • BlueprintDetail
    • CreateBlueprintRequest
    • LogHistoryEntry
    • LogHistoryDetailResponse
    • CopyBlueprintResponse
    • UpdateBlueprintMetadataRequest
    • InstallBlueprintDepsRequest
    • JobAcceptedResponse
    • TemplateStatusEntry
    • RoleStatusEntry
    • SourceResponse
    • SourceCreateResponse
    • UpdateSourceRequest
    • DeleteSourceRequest
    • SyncSourceRequest
    • SyncResult
    • ArtifactResult
    • RoleInstallResult
    • DryRunPlan
    • SourceBlueprintListItem
    • ListSourceCollectionsResponseItem
    • ListSourceTemplatesResponseItem
    • BlueprintCreatedResponse
    • ListSourceRolesResponseItem
    • BlueprintCreatedResponseRoleResult
    • DeleteSourceResponse
  1. Virtual Consoles

Get Console Websocket Ticket

Cloud Mock
https://mock.apidog.com/m1/1126461-0-default
Cloud Mock
https://mock.apidog.com/m1/1126461-0-default
GET
/vm/console/ticket
Generates a one-time VNC ticket for a specific VM if the calling user has access

Request

Authorization
JWT Bearer
Add the parameter
Authorization
to Headers
Example:
Authorization: ********************
or
API Key
Add parameter in header
X-API-KEY
Example:
X-API-KEY: ********************
or
Query Params

Header Params

Responses

🟢200Success
application/json
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://mock.apidog.com/m1/1126461-0-default/vm/console/ticket?VMID=120' \
--header 'x-api-key: {{ SO_API_KEY}}' \
--header 'X-API-KEY: <api-key>'
Response Response Example
{
    "ticket": "string",
    "password": "string",
    "port": 0
}
Modified at 2025-12-15 18:16:27
Previous
Migrate SQLite to PocketBase
Next
Connect to VM Console WebSocket
Built with