Ludus 2 is in BETA. This API is subject to change until Ludus 2 is released.
- Host Management
- Ansible Management
- Retrieve available subscription rolesGET
- Install subscription rolesPOST
- Get role variables for one or more Ansible rolesPOST
- Move or copy roles between global and local scopesPATCH
- Retrieve available Ansible roles and collectionsGET
- Install or Remove an Ansible rolePOST
- Install an Ansible role from local directoryPUT
- Install an Ansible collectionPOST
- Retrieve available subscription roles
- 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
- 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
- Create a new range
- 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
- Power State Management
- Testing State Management
- Anti-Sandbox Management
- Template Management
- Snapshot Management
- KMS Management
- Group Management
- Migration
- Virtual Consoles
- Schemas
VMObject
{
"ID": 53,
"proxmoxID": 146,
"rangeNumber": 3,
"name": "JD-ad-dc-win2019-server-x64",
"poweredOn": true,
"ip": "string",
"isRouter": false,
"cpu": 4,
"ram": 8
}