- Host Management
- Ansible Management
- Retrieve available subscription roles
- Install subscription roles
- Get role variables for one or more Ansible roles
- Install or Remove 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
- Testing State Management
- Anti-Sandbox Management
- Template Management
- Snapshot Management
- KMS Management
- Group Management
- Migration
- 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
- Sources
- VM Management
- 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
InstallRequest
{
"selection": {
"blueprints": [
"string"
],
"templates": [
"string"
],
"localRoles": [
"string"
],
"localCollections": [
"string"
]
},
"global": true,
"force": true,
"noDeps": true
}