Skip to content
Server Panel

Overview

Server Panel API 1.0.0

Section titled “Server Panel API 1.0.0”

Errors are application/problem+json with a stable code. Integrations authenticate with an API token (Authorization: Bearer …).

Information

  • OpenAPI version: 3.1.1

Operations

Section titled “Operations”
POST
/api/v1/auth/confirm-email
POST
/api/v1/auth/login
POST
/api/v1/auth/login/2fa
POST
/api/v1/auth/login/recovery
POST
/api/v1/auth/passkey/options
POST
/api/v1/auth/passkey/login
POST
/api/v1/auth/logout
GET
/api/v1/auth/me
GET
/api/v1/auth/providers
GET
/api/v1/auth/external/{provider}
GET
/api/v1/auth/external/complete
POST
/api/v1/auth/forgot-password
POST
/api/v1/auth/reset-password
GET
/api/v1/invitations/{token}
POST
/api/v1/invitations/{token}/accept
GET
/api/v1/tenants/{tenantId}/nodes
GET
/api/v1/nodes
POST
/api/v1/nodes
POST
/api/v1/nodes/{nodeId}/enrollment
PUT
/api/v1/nodes/{nodeId}
DELETE
/api/v1/nodes/{nodeId}
PUT
/api/v1/nodes/{nodeId}/isolation
GET
/api/v1/nodes/{nodeId}/metrics
GET
/api/v1/nodes/{nodeId}/allocations
POST
/api/v1/nodes/{nodeId}/allocations
DELETE
/api/v1/nodes/{nodeId}/allocations/{allocationId}
GET
/api/v1/permissions
GET
/api/v1/tenants/{tenantId}/tokens
POST
/api/v1/tenants/{tenantId}/tokens
DELETE
/api/v1/tenants/{tenantId}/tokens/{tokenId}
GET
/api/v1/exposure/providers
PUT
/api/v1/nodes/{nodeId}/forward-target
GET
/api/v1/nodes/{nodeId}/exposures
POST
/api/v1/nodes/{nodeId}/exposures
PUT
/api/v1/nodes/{nodeId}/exposures/{exposureId}
DELETE
/api/v1/nodes/{nodeId}/exposures/{exposureId}
POST
/api/v1/nodes/{nodeId}/exposures/{exposureId}/test
GET
/api/v1/nodes/{nodeId}/exposures/{exposureId}/preview
POST
/api/v1/nodes/{nodeId}/exposures/{exposureId}/enable
POST
/api/v1/nodes/{nodeId}/exposures/{exposureId}/disable
POST
/api/v1/nodes/{nodeId}/exposures/{exposureId}/apply
GET
/api/v1/setup
POST
/api/v1/setup
PUT
/api/v1/account/profile
PUT
/api/v1/account/password
POST
/api/v1/account/2fa/setup
POST
/api/v1/account/2fa/enable
POST
/api/v1/account/2fa/disable
POST
/api/v1/account/2fa/recovery-codes
GET
/api/v1/account/passkeys
POST
/api/v1/account/passkeys
POST
/api/v1/account/passkeys/options
DELETE
/api/v1/account/passkeys/{id}
GET
/api/v1/account/logins
DELETE
/api/v1/account/logins/{provider}
GET
/api/v1/account/ssh-keys
POST
/api/v1/account/ssh-keys
DELETE
/api/v1/account/ssh-keys/{id}
GET
/api/v1/account/export
POST
/api/v1/account/delete
POST
/api/v1/account/email
GET
/api/v1/account/push
POST
/api/v1/account/push
PUT
/api/v1/account/push/{id}
DELETE
/api/v1/account/push/{id}
POST
/api/v1/account/push/test
GET
/api/v1/tenants
POST
/api/v1/tenants
PUT
/api/v1/tenants/{tenantId}
GET
/api/v1/tenants/{tenantId}/invitations
DELETE
/api/v1/tenants/{tenantId}/invitations/{invitationId}
GET
/api/v1/tenants/{tenantId}/members
POST
/api/v1/tenants/{tenantId}/members
PUT
/api/v1/tenants/{tenantId}/members/{userId}
DELETE
/api/v1/tenants/{tenantId}/members/{userId}
GET
/api/v1/tenants/{tenantId}/audit
GET
/api/v1/templates
POST
/api/v1/templates
GET
/api/v1/templates/{templateId}
PUT
/api/v1/templates/{templateId}
DELETE
/api/v1/templates/{templateId}
GET
/api/v1/templates/formats
POST
/api/v1/templates/import
GET
/api/v1/templates/catalogue
POST
/api/v1/templates/catalogue/refresh
POST
/api/v1/templates/catalogue/{gameId}
POST
/api/v1/templates/rules/check
POST
/api/v1/templates/preview
GET
/api/v1/tenants/{tenantId}/servers
POST
/api/v1/tenants/{tenantId}/servers
GET
/api/v1/tenants/{tenantId}/servers/backups
POST
/api/v1/tenants/{tenantId}/servers/{serverId}/move
GET
/api/v1/tenants/{tenantId}/servers/{serverId}
DELETE
/api/v1/tenants/{tenantId}/servers/{serverId}
PUT
/api/v1/tenants/{tenantId}/servers/{serverId}/settings
PUT
/api/v1/tenants/{tenantId}/servers/{serverId}/port-forwarding
PUT
/api/v1/tenants/{tenantId}/servers/{serverId}/steam
PUT
/api/v1/tenants/{tenantId}/servers/{serverId}/variables
GET
/api/v1/tenants/{tenantId}/servers/{serverId}/startup
POST
/api/v1/tenants/{tenantId}/servers/{serverId}/power
POST
/api/v1/tenants/{tenantId}/servers/{serverId}/command
GET
/api/v1/tenants/{tenantId}/servers/{serverId}/metrics
GET
/api/v1/tenants/{tenantId}/servers/{serverId}/console/log
POST
/api/v1/tenants/{tenantId}/servers/{serverId}/rcon
GET
/api/v1/tenants/{tenantId}/servers/{serverId}/console/stream
POST
/api/v1/tenants/{tenantId}/servers/{serverId}/prompts/{promptId}
POST
/api/v1/tenants/{tenantId}/servers/{serverId}/reinstall
POST
/api/v1/tenants/{tenantId}/servers/{serverId}/update
GET
/api/v1/tenants/{tenantId}/servers/{serverId}/job
POST
/api/v1/tenants/{tenantId}/servers/{serverId}/job/input
GET
/api/v1/tenants/{tenantId}/servers/{serverId}/files
DELETE
/api/v1/tenants/{tenantId}/servers/{serverId}/files
GET
/api/v1/tenants/{tenantId}/servers/{serverId}/files/content
PUT
/api/v1/tenants/{tenantId}/servers/{serverId}/files/content
GET
/api/v1/tenants/{tenantId}/servers/{serverId}/files/archive
GET
/api/v1/tenants/{tenantId}/servers/{serverId}/files/download
POST
/api/v1/tenants/{tenantId}/servers/{serverId}/files/rename
POST
/api/v1/tenants/{tenantId}/servers/{serverId}/files/delete
POST
/api/v1/tenants/{tenantId}/servers/{serverId}/files/move
POST
/api/v1/tenants/{tenantId}/servers/{serverId}/files/directory
GET
/api/v1/tenants/{tenantId}/servers/{serverId}/grants
PUT
/api/v1/tenants/{tenantId}/servers/{serverId}/grants/{userId}
DELETE
/api/v1/tenants/{tenantId}/servers/{serverId}/grants/{userId}
GET
/api/v1/tenants/{tenantId}/servers/{serverId}/backups
POST
/api/v1/tenants/{tenantId}/servers/{serverId}/backups
POST
/api/v1/tenants/{tenantId}/servers/{serverId}/backups/uploads
PUT
/api/v1/tenants/{tenantId}/servers/{serverId}/backups/{backupId}/upload
POST
/api/v1/tenants/{tenantId}/servers/{serverId}/backups/{backupId}/lock
POST
/api/v1/tenants/{tenantId}/servers/{serverId}/backups/{backupId}/restore
DELETE
/api/v1/tenants/{tenantId}/servers/{serverId}/backups/{backupId}
GET
/api/v1/tenants/{tenantId}/servers/{serverId}/backups/{backupId}/download
PUT
/api/v1/tenants/{tenantId}/servers/{serverId}/backup-limit
GET
/api/v1/tenants/{tenantId}/servers/{serverId}/schedules
POST
/api/v1/tenants/{tenantId}/servers/{serverId}/schedules
PUT
/api/v1/tenants/{tenantId}/servers/{serverId}/schedules/{scheduleId}
DELETE
/api/v1/tenants/{tenantId}/servers/{serverId}/schedules/{scheduleId}
POST
/api/v1/tenants/{tenantId}/servers/{serverId}/schedules/{scheduleId}/run
GET
/api/v1/tenants/{tenantId}/webhooks
POST
/api/v1/tenants/{tenantId}/webhooks
GET
/api/v1/tenants/{tenantId}/webhooks/events
PUT
/api/v1/tenants/{tenantId}/webhooks/{webhookId}
DELETE
/api/v1/tenants/{tenantId}/webhooks/{webhookId}
POST
/api/v1/tenants/{tenantId}/webhooks/{webhookId}/ping
GET
/api/v1/tenants/{tenantId}/webhooks/{webhookId}/deliveries
POST
/api/v1/tenants/{tenantId}/webhooks/{webhookId}/secret
GET
/api/v1/tenants/{tenantId}/steam-accounts
POST
/api/v1/tenants/{tenantId}/steam-accounts
PUT
/api/v1/tenants/{tenantId}/steam-accounts/{accountId}
DELETE
/api/v1/tenants/{tenantId}/steam-accounts/{accountId}
POST
/api/v1/tenants/{tenantId}/steam-accounts/{accountId}/sign-out
POST
/api/v1/tenants/{tenantId}/steam-accounts/{accountId}/sign-in
GET
/api/v1/tenants/{tenantId}/steam-accounts/{accountId}/jobs/latest
POST
/api/v1/tenants/{tenantId}/steam-accounts/{accountId}/jobs/{jobId}/input
GET
/api/v1/admin/settings
PUT
/api/v1/admin/settings
POST
/api/v1/admin/settings/test-email
GET
/api/v1/admin/login-providers
POST
/api/v1/admin/login-providers
PUT
/api/v1/admin/login-providers/{providerId}
DELETE
/api/v1/admin/login-providers/{providerId}
GET
/api/v1/admin/registries
POST
/api/v1/admin/registries
PUT
/api/v1/admin/registries/{registryId}
DELETE
/api/v1/admin/registries/{registryId}
GET
/api/v1/admin/users
POST
/api/v1/admin/users
DELETE
/api/v1/admin/users/invitations/{invitationId}
PUT
/api/v1/admin/users/{userId}
DELETE
/api/v1/admin/users/{userId}
POST
/api/v1/admin/users/{userId}/lock
POST
/api/v1/admin/users/{userId}/unlock
POST
/api/v1/admin/users/{userId}/reset-2fa
POST
/api/v1/admin/users/{userId}/password-reset
GET
/api/v1/admin/tenants
POST
/api/v1/admin/tenants
PUT
/api/v1/admin/tenants/{tenantId}
DELETE
/api/v1/admin/tenants/{tenantId}