Copy Page
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
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
Install an Ansible collection
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
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)
Update range label fields
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
Connect to VM Console WebSocket
Blueprint Management
List accessible blueprints
Create blueprint from range
Delete blueprint
Copy 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
Create blueprint
Get blueprint detail
Update blueprint metadata
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
List sources
Sync source
Create source
Get source
Delete source
Share source with users
Share source with groups
Unshare source from users
Unshare source from groups
List blueprints in a source
List all source blueprints
Get source blueprint manifest
Schemas
BulkAddUsersToGroupRequest
userID
BlueprintListItem
SyncResultResponse
BulkRemoveUsersFromGroupRequest
rangeID
CreateBlueprintFromRangeRequest
BulkAddRangesToGroupRequest
CopyBlueprintRequest
UserObject
ApplyBlueprintRequest
UserAPIKeyObject
BulkRemoveRangesFromGroupRequest
UpdateBlueprintConfigRequest
BulkGroupOperationResponse
UserCredentialObject
BulkGroupOperationErrorItem
BlueprintAccessUserItem
RangeObject
BulkShareBlueprintWithGroupsRequest
UserMembershipObject
BlueprintAccessGroupItem
BulkUnshareBlueprintWithGroupsRequest
BulkShareBlueprintWithUsersRequest
Domain
IP
BulkUnshareBlueprintWithUsersRequest
AllowPayload
BulkBlueprintOperationErrorItem
BulkBlueprintOperationResponse
SnapshotInfo
BlueprintMutationResponse
ErrorInfo
SnapshotCreatePayload
LicenseDataObject
VMObject
CreateBlueprintRequest
LogHistoryEntry
LogHistoryDetailResponse
CopyBlueprintResponse
UpdateBlueprintMetadataRequest
InstallBlueprintDepsRequest
JobAcceptedResponse
BlueprintDetail
TemplateStatusEntry
RoleStatusEntry
SourceResponse
SourceCreateResponse
UpdateSourceRequest
DeleteSourceRequest
SyncSourceRequest
SyncResult
ArtifactResult
RoleInstallResult
DryRunPlan
SourceBlueprintListItem
UpdateSourceRequest
Copy Page
{
"ref"
:
"string"
,
"globalRoles"
:
true
,
"force"
:
true
}