Skip to content

REST API Reference

Exhaustive route inventory (296 routes total) for Levelrail's control plane HTTP API, organized by resource group matching docs/feature-catalog.md.

System

System endpoints for:

  • Status checks and diagnostics
  • Admin operations
  • Configuration retrieval and management
MethodPathAbilityHandler
GET/healthzPublichandleHealthz
GET/api/v1/brandPublichandleBrand
GET/api/v1/dev-modePublichandleDevMode
GET/api/v1/system/statusAbilityReadhandleSystemStatus
GET/api/v1/system/doctorAbilityReadhandleSystemDoctor
GET/api/v1/system/containersAbilityReadhandleListContainers
POST/api/v1/system/pruneAbilityRoothandleSystemPrune
POST/api/v1/system/master-key/rotateAbilityRoothandleRotateMasterKey
GET/api/v1/onboardingAbilityReadhandleGetOnboardingState
POST/api/v1/onboarding/completeAbilityWritehandleCompleteOnboarding
GET/api/v1/updatesAbilityReadhandleGetUpdates

Auth / 2FA / Users / Roles / IAM / Device Auth / OAuth

Endpoints for:

  • Authentication and session management
  • Two-factor authentication setup and verification
  • User and role management
  • IAM policies and attachment
  • Device login flows
  • OAuth provider configuration
MethodPathAbilityHandler
POST/api/v1/auth/loginPublichandleLogin
POST/api/v1/auth/registerPublichandleRegister
POST/api/v1/auth/logoutSessionhandleLogout
PUT/api/v1/auth/passwordSessionhandleChangePassword
GET/api/v1/auth/sessionSessionhandleGetSession
POST/api/v1/auth/sessions/revoke-othersSessionhandleRevokeOtherSessions
GET/api/v1/auth/2faSessionhandleGetTwoFactorStatus
POST/api/v1/auth/2fa/setupSessionhandleSetupTwoFactor
POST/api/v1/auth/2fa/confirmSessionhandleConfirmTwoFactor
POST/api/v1/auth/2fa/disableSessionhandleDisableTwoFactor
POST/api/v1/auth/2fa/recovery-codes/regenerateSessionhandleRegenerateRecoveryCodes
POST/api/v1/auth/2fa/verifyPublichandleVerifyTwoFactor
POST/api/v1/auth/usersAbilityRoothandleCreateUser
GET/api/v1/usersAbilityReadhandleListUsers
DELETE/api/v1/users/AbilityRoothandleDeleteUser
PUT/api/v1/users/{id}/abilitiesAbilityRoothandleUpdateUserAbilities
GET/api/v1/rolesAbilityReadhandleListRoles
POST/api/v1/invitesAbilityWritehandleCreateInvite
GET/api/v1/invitesAbilityReadhandleListInvites
DELETE/api/v1/invites/AbilityWritehandleRevokeInvite
POST/api/v1/invites/acceptPublichandleAcceptInvite
POST/api/v1/iam/policiesAbilityRoothandleCreatePolicy
GET/api/v1/iam/policiesAbilityReadhandleListPolicies
GET/api/v1/iam/policies/AbilityReadhandleGetPolicy
PUT/api/v1/iam/policies/AbilityRoothandleUpdatePolicy
DELETE/api/v1/iam/policies/AbilityRoothandleDeletePolicy
GET/api/v1/iam/policies/{id}/attachmentsAbilityReadhandleListPolicyAttachments
POST/api/v1/iam/policies/{id}/attachmentsAbilityRoothandleAttachPolicy
DELETE/api/v1/iam/policies/{id}/attachments/{principal_type}/AbilityRoothandleDetachPolicy
POST/api/v1/auth/device/startPublichandleDeviceAuthStart
POST/api/v1/auth/device/tokenPublichandleDeviceAuthToken
GET/api/v1/auth/device/requestsSessionhandleListDeviceAuthRequests
POST/api/v1/auth/device/{user_code}/approveSessionhandleApproveDeviceAuthRequest
POST/api/v1/auth/device/{user_code}/denySessionhandleDenyDeviceAuthRequest
GET/api/v1/auth/oauth/providersPublichandleListPublicOAuthProviders
GET/api/v1/auth/oauth/{provider}/startPublichandleOAuthStart
GET/api/v1/auth/oauth/{provider}/callbackPublichandleOAuthCallback
GET/api/v1/auth/oauth/{provider}/link/startSessionhandleOAuthLinkStart
GET/api/v1/settings/oauthAbilityReadhandleListOAuthSettings
PUT/api/v1/settings/oauth/AbilityRoothandleUpdateOAuthProviderSettings
POST/api/v1/auth/forgot-passwordPublichandleForgotPassword
POST/api/v1/auth/reset-passwordPublichandleResetPassword
POST/api/v1/auth/tokensSessionhandleCreateToken
GET/api/v1/auth/tokensSessionhandleListTokens
DELETE/api/v1/auth/tokens/SessionhandleRevokeToken

Apps CRUD / Lifecycle / Deploy

Endpoints for:

  • Application creation, retrieval, update, and deletion
  • Deployment triggers and history
  • Application control (restart, stop, start)
  • Logs, metrics, and diagnostics
  • Build operations and deployment comparisons
  • Image and network information
MethodPathAbilityHandler
GET/api/v1/appsAbilityReadhandleListApps
POST/api/v1/appsAbilityWritehandleCreateApp
GET/api/v1/apps/AbilityReadhandleGetApp
PUT/api/v1/apps/AbilityWritehandleUpdateApp
DELETE/api/v1/apps/AbilityWritehandleDeleteApp
GET/api/v1/apps/{name}/groupAbilityReadhandleGetAppGroup
GET/api/v1/apps/{name}/hook-runsAbilityReadhandleGetAppHookRuns
POST/api/v1/apps/{name}/composeAbilityDeployhandleDeployCompose
GET/api/v1/service-templatesAbilityReadhandleListServiceTemplates
GET/api/v1/service-templates/AbilityReadhandleGetServiceTemplate
POST/api/v1/apps/{name}/cloneAbilityWritehandleCloneApp
PUT/api/v1/apps/{name}/nodeAbilityRoothandleSetAppNode
POST/api/v1/apps/{name}/deploysAbilityDeployhandleTriggerDeploy
GET/api/v1/apps/{name}/deploysAbilityReadhandleDeployHistory
POST/api/v1/apps/{name}/restartAbilityDeployhandleRestartApp
POST/api/v1/apps/{name}/stopAbilityDeployhandleStopApp
POST/api/v1/apps/{name}/startAbilityDeployhandleStartApp
POST/api/v1/apps/{name}/execAbilityRoothandleExecApp
GET/api/v1/apps/{name}/terminalAbilityRoothandleAppTerminal
GET/api/v1/apps/{name}/deploy-attemptsAbilityReadhandleListDeployAttempts
GET/api/v1/apps/{name}/deploys/compareAbilityReadhandleCompareDeploys
GET/api/v1/apps/{name}/promote/previewAbilityReadhandlePromotePreview
POST/api/v1/apps/{name}/promoteAbilityDeployhandlePromoteApp
GET/api/v1/apps/{name}/deploys/{deployId}/logsAbilityReadhandleDeployLogStream
GET/api/v1/apps/{name}/deploys/{deployId}/logs/downloadAbilityReadhandleDownloadDeployLog
GET/api/v1/apps/{name}/diagnoseAbilityReadhandleDiagnoseApp
GET/api/v1/apps/{name}/resource-recommendationAbilityReadhandleAppResourceRecommendation
POST/api/v1/apps/{name}/buildsAbilityDeployhandleTriggerBuild
POST/api/v1/apps/{name}/deploy-specAbilityDeployhandleDeploySpec
POST/api/v1/git/branchesAbilityDeployhandleListGitBranches
GET/api/v1/apps/{name}/imagesAbilityReadhandleListImages
GET/api/v1/apps/{name}/networkAbilityReadhandleGetAppNetwork

Secrets / Git Source / Webhooks / Preview Environments

Endpoints for:

  • Encrypted secrets management and locking
  • Git repository connections and configuration
  • Webhook delivery history and replay
  • Preview environment configuration and lifecycle
MethodPathAbilityHandler
PUT/api/v1/apps/{name}/secrets/AbilityWriteSensitivehandleSetSecret
GET/api/v1/apps/{name}/secretsAbilityReadhandleListSecrets
POST/api/v1/apps/{name}/secrets/{key}/lockAbilityWriteSensitivehandleSetSecretLock
GET/api/v1/apps/{name}/git-sourceAbilityReadhandleGetGitSource
PUT/api/v1/apps/{name}/git-sourceAbilityWriteSensitivehandleSetGitSource
DELETE/api/v1/apps/{name}/git-sourceAbilityWriteSensitivehandleDeleteGitSource
POST/api/v1/webhooks/github/PublichandleGitPushWebhook
GET/api/v1/apps/{name}/webhook-deliveriesAbilityReadhandleListWebhookDeliveries
POST/api/v1/apps/{name}/webhook-deliveries/{id}/replayAbilityDeployhandleReplayWebhookDelivery
PUT/api/v1/apps/{name}/preview-settingsAbilityWriteSensitivehandleSetPreviewEnabled
GET/api/v1/apps/{name}/previewsAbilityReadhandleListPreviewEnvironments
POST/api/v1/apps/{name}/previews/{number}/teardownAbilityDeployhandleTeardownPreviewEnvironment
POST/api/v1/previews/sweepAbilityDeployhandleSweepPreviewEnvironments

Telemetry

Endpoints for:

  • Metrics queries with filtering and aggregation
  • Log retrieval, search, and live streaming
  • Resource usage ranking and monitoring
MethodPathAbilityHandler
GET/api/v1/apps/{name}/metricsAbilityReadhandleQueryMetrics
GET/api/v1/apps/{name}/logsAbilityReadhandleQueryLogs
GET/api/v1/apps/resource-usageAbilityReadhandleAppResourceUsage
GET/api/v1/apps/{name}/logs/streamAbilityReadhandleLiveLogStream
GET/api/v1/apps/{name}/logs/downloadAbilityReadhandleDownloadLogs

Alerts / Scheduled Tasks / Feature Flags / Notification Channels

Endpoints for:

  • Alert rule creation and management
  • Scheduled task configuration and execution
  • Feature flag configuration and evaluation
  • Notification channel management and delivery tracking
MethodPathAbilityHandler
POST/api/v1/apps/{name}/alertsAbilityWritehandleCreateAlertRule
GET/api/v1/apps/{name}/alertsAbilityReadhandleListAlertRules
PUT/api/v1/apps/{name}/alerts/AbilityWritehandleUpdateAlertRule
DELETE/api/v1/apps/{name}/alerts/AbilityWritehandleDeleteAlertRule
POST/api/v1/apps/{name}/scheduled-tasksAbilityWritehandleCreateScheduledTask
GET/api/v1/apps/{name}/scheduled-tasksAbilityReadhandleListScheduledTasks
GET/api/v1/apps/{name}/scheduled-tasks/AbilityReadhandleGetScheduledTask
PUT/api/v1/apps/{name}/scheduled-tasks/AbilityWritehandleUpdateScheduledTask
DELETE/api/v1/apps/{name}/scheduled-tasks/AbilityWritehandleDeleteScheduledTask
POST/api/v1/apps/{name}/scheduled-tasks/{id}/runAbilityDeployhandleRunScheduledTaskNow
POST/api/v1/apps/{name}/flagsAbilityWritehandleCreateFeatureFlag
GET/api/v1/apps/{name}/flagsAbilityReadhandleListFeatureFlags
GET/api/v1/apps/{name}/flags/AbilityReadhandleGetFeatureFlag
PUT/api/v1/apps/{name}/flags/AbilityWritehandleUpdateFeatureFlag
DELETE/api/v1/apps/{name}/flags/AbilityWritehandleDeleteFeatureFlag
GET/api/v1/flags/evaluate/AbilityReadhandleEvaluateFeatureFlag
POST/api/v1/apps/{name}/deploy-notify-targetsAbilityWritehandleCreateDeployNotifyTarget
GET/api/v1/apps/{name}/deploy-notify-targetsAbilityReadhandleListDeployNotifyTargets
DELETE/api/v1/apps/{name}/deploy-notify-targets/AbilityWritehandleDeleteDeployNotifyTarget
GET/api/v1/notification-channelsAbilityReadhandleListNotificationChannels
POST/api/v1/notification-channelsAbilityWritehandleCreateNotificationChannel
PUT/api/v1/notification-channels/AbilityWritehandleUpdateNotificationChannel
DELETE/api/v1/notification-channels/AbilityWritehandleDeleteNotificationChannel
POST/api/v1/notification-channels/testAbilityWritehandleTestNotificationChannel
POST/api/v1/notification-channels/{id}/testAbilityWritehandleTestExistingNotificationChannel
GET/api/v1/notification-channels/{id}/deliveriesAbilityReadhandleListNotificationDeliveries
POST/api/v1/prometheus/readAbilityReadhandlePrometheusRead

Databases CRUD / Engines / Resources

Endpoints for:

  • Database creation, retrieval, and deletion
  • Engine registry and telemetry
  • Resource recommendations and node placement
MethodPathAbilityHandler
GET/api/v1/database-enginesAbilityReadhandleListDatabaseEngines
GET/api/v1/databasesAbilityReadhandleListDatabases
POST/api/v1/databasesAbilityWritehandleCreateDatabase
GET/api/v1/databases/AbilityReadhandleGetDatabase
DELETE/api/v1/databases/AbilityWritehandleDeleteDatabase
GET/api/v1/databases/{name}/statusAbilityReadhandleDatabaseStatus
GET/api/v1/databases/{name}/metricsAbilityReadhandleQueryDatabaseMetrics
GET/api/v1/databases/{name}/logsAbilityReadhandleQueryDatabaseLogs
GET/api/v1/databases/{name}/logs/streamAbilityReadhandleLiveDatabaseLogStream
GET/api/v1/databases/{name}/resource-recommendationAbilityReadhandleDatabaseResourceRecommendation
PUT/api/v1/databases/{name}/nodeAbilityRoothandleSetDatabaseNode

Projects / Organizations / Environments

Endpoints for:

  • Project and organization management
  • Environment definitions and configuration
  • Environment variable and configuration inheritance
  • Bulk lifecycle operations (restart, stop, start)
MethodPathAbilityHandler
GET/api/v1/projectsAbilityReadhandleListProjects
POST/api/v1/projectsAbilityWritehandleCreateProject
GET/api/v1/projects/AbilityReadhandleGetProject
DELETE/api/v1/projects/AbilityWritehandleDeleteProject
POST/api/v1/projects/{id}/restartAbilityDeployhandleRestartProject
POST/api/v1/projects/{id}/stopAbilityDeployhandleStopProject
POST/api/v1/projects/{id}/startAbilityDeployhandleStartProject
GET/api/v1/organizationsAbilityReadhandleListOrganizations
POST/api/v1/organizationsAbilityWritehandleCreateOrganization
GET/api/v1/organizations/AbilityReadhandleGetOrganization
DELETE/api/v1/organizations/AbilityWritehandleDeleteOrganization
PUT/api/v1/projects/{id}/organizationAbilityWritehandleSetProjectOrganization
GET/api/v1/organizations/{id}/envAbilityReadhandleGetOrganizationEnv
PUT/api/v1/organizations/{id}/envAbilityWritehandleSetOrganizationEnv
GET/api/v1/projects/{id}/environmentsAbilityReadhandleListEnvironments
POST/api/v1/projects/{id}/environmentsAbilityWritehandleCreateEnvironment
PATCH/api/v1/environments/AbilityWritehandleUpdateEnvironment
DELETE/api/v1/environments/AbilityWritehandleDeleteEnvironment
PUT/api/v1/apps/{name}/environmentAbilityWritehandleSetAppEnvironment
GET/api/v1/environments/{id}/envAbilityReadhandleGetEnvironmentEnv
PUT/api/v1/environments/{id}/envAbilityWritehandleSetEnvironmentEnv
GET/api/v1/projects/{id}/envAbilityReadhandleGetProjectEnv
PUT/api/v1/projects/{id}/envAbilityWritehandleSetProjectEnv
PUT/api/v1/apps/{name}/projectAbilityWritehandleSetAppProject
PUT/api/v1/databases/{name}/projectAbilityWritehandleSetDatabaseProject
PUT/api/v1/databases/{name}/resourcesAbilityWritehandleSetDatabaseResources

Nodes

Endpoints for:

  • Physical infrastructure management and monitoring
  • Node health and status
  • Workload assignment and placement
  • Cordon, drain, and lifecycle operations
  • Node-level metrics and patch status
MethodPathAbilityHandler
GET/api/v1/nodesAbilityRoothandleListNodes
GET/api/v1/nodes/AbilityRoothandleGetNode
DELETE/api/v1/nodes/AbilityRoothandleDeleteNode
PUT/api/v1/nodes/{id}/workloadsAbilityRoothandleSetNodeWorkloads
POST/api/v1/nodes/join-tokensAbilityRoothandleCreateNodeJoinToken
GET/api/v1/nodes/{id}/healthAbilityRoothandleGetNodeHealth
POST/api/v1/nodes/{id}/cordonAbilityRoothandleCordonNode
POST/api/v1/nodes/{id}/uncordonAbilityRoothandleUncordonNode
POST/api/v1/nodes/{id}/drainAbilityRoothandleDrainNode
GET/api/v1/nodes/{id}/metricsAbilityRoothandleQueryNodeMetrics
GET/api/v1/nodes/{id}/patch-statusAbilityRoothandleGetNodePatchStatus

Ingress / Certificates / Domains / Email / Cloudflare

Endpoints for:

  • TLS certificate lifecycle and management
  • ACME configuration and certificate validation
  • Domain routing and DNS configuration
  • Domain-level controls (basic auth, maintenance mode, redirects, custom error pages, WAF)
  • Email configuration for notifications
  • Cloudflare, Route 53, and Vault integrations
  • External secret management
MethodPathAbilityHandler
GET/api/v1/certificatesAbilityReadhandleListCertificates
GET/api/v1/settings/ingressAbilityReadhandleGetIngressSettings
PUT/api/v1/settings/ingressAbilityRoothandleUpdateIngressSettings
GET/api/v1/settings/ingress/checkAbilityRoothandleCheckIngressDomain
GET/api/v1/apps/{name}/domains/{domain}/checkAbilityReadhandleCheckDomain
GET/api/v1/apps/{name}/domains/{domain}/authAbilityReadhandleGetDomainBasicAuth
PUT/api/v1/apps/{name}/domains/{domain}/authAbilityRoothandleSetDomainBasicAuth
DELETE/api/v1/apps/{name}/domains/{domain}/authAbilityRoothandleClearDomainBasicAuth
GET/api/v1/apps/{name}/domains/{domain}/maintenanceAbilityReadhandleGetDomainMaintenance
PUT/api/v1/apps/{name}/domains/{domain}/maintenanceAbilityDeployhandleSetDomainMaintenance
DELETE/api/v1/apps/{name}/domains/{domain}/maintenanceAbilityDeployhandleClearDomainMaintenance
GET/api/v1/apps/{name}/domains/{domain}/redirectAbilityReadhandleGetDomainRedirect
PUT/api/v1/apps/{name}/domains/{domain}/redirectAbilityDeployhandleSetDomainRedirect
DELETE/api/v1/apps/{name}/domains/{domain}/redirectAbilityDeployhandleClearDomainRedirect
GET/api/v1/apps/{name}/domains/{domain}/tls-certAbilityReadhandleGetDomainTLSCert
PUT/api/v1/apps/{name}/domains/{domain}/tls-certAbilityRoothandleSetDomainTLSCert
DELETE/api/v1/apps/{name}/domains/{domain}/tls-certAbilityRoothandleClearDomainTLSCert
GET/api/v1/apps/{name}/domains/{domain}/wafAbilityReadhandleGetDomainWAF
PUT/api/v1/apps/{name}/domains/{domain}/wafAbilityDeployhandleSetDomainWAF
DELETE/api/v1/apps/{name}/domains/{domain}/wafAbilityDeployhandleClearDomainWAF
GET/api/v1/apps/{name}/domains/{domain}/error-pagesAbilityReadhandleGetDomainErrorPages
PUT/api/v1/apps/{name}/domains/{domain}/error-pagesAbilityDeployhandleSetDomainErrorPage
DELETE/api/v1/apps/{name}/domains/{domain}/error-pagesAbilityDeployhandleClearDomainErrorPages
GET/api/v1/settings/emailAbilityReadhandleGetEmailSettings
PUT/api/v1/settings/emailAbilityRoothandleUpdateEmailSettings
GET/api/v1/settings/cloudflare-tunnelAbilityReadhandleGetCloudflareTunnelSettings
PUT/api/v1/settings/cloudflare-tunnelAbilityRoothandleUpdateCloudflareTunnelSettings
DELETE/api/v1/settings/cloudflare-tunnelAbilityRoothandleDisconnectCloudflareTunnel
GET/api/v1/settings/cloudflare-dnsAbilityReadhandleGetCloudflareDNSSettings
PUT/api/v1/settings/cloudflare-dnsAbilityRoothandleUpdateCloudflareDNSSettings
DELETE/api/v1/settings/cloudflare-dnsAbilityRoothandleDisconnectCloudflareDNS
GET/api/v1/settings/route53-dnsAbilityReadhandleGetRoute53DNSSettings
PUT/api/v1/settings/route53-dnsAbilityRoothandleUpdateRoute53DNSSettings
DELETE/api/v1/settings/route53-dnsAbilityRoothandleDisconnectRoute53DNS
GET/api/v1/settings/vaultAbilityReadhandleGetVaultSettings
PUT/api/v1/settings/vaultAbilityRoothandleUpdateVaultSettings
DELETE/api/v1/settings/vaultAbilityRoothandleDisconnectVault
PUT/api/v1/apps/{name}/vault-env/AbilityWritehandleSetAppVaultEnv
DELETE/api/v1/apps/{name}/vault-env/AbilityWritehandleClearAppVaultEnv
PUT/api/v1/apps/{name}/preview-env/AbilityWritehandleSetAppPreviewEnvOverride
DELETE/api/v1/apps/{name}/preview-env/AbilityWritehandleClearAppPreviewEnvOverride

Static Sites / Backup Targets / Registry Credentials

Endpoints for:

  • Static site configuration and visibility
  • S3-compatible backup target management and testing
  • External registry credentials for image pull authentication
  • Domain enumeration
MethodPathAbilityHandler
GET/api/v1/static-sitesAbilityReadhandleListStaticSites
GET/api/v1/backup-targetsAbilityReadhandleListBackupTargets
POST/api/v1/backup-targetsAbilityWriteSensitivehandleCreateBackupTarget
GET/api/v1/backup-targets/AbilityReadhandleGetBackupTarget
PUT/api/v1/backup-targets/AbilityWriteSensitivehandleUpdateBackupTarget
DELETE/api/v1/backup-targets/AbilityWriteSensitivehandleDeleteBackupTarget
POST/api/v1/backup-targets/{id}/testAbilityWriteSensitivehandleTestBackupTarget
GET/api/v1/registry-credentialsAbilityReadhandleListRegistryCredentials
POST/api/v1/registry-credentialsAbilityWriteSensitivehandleCreateRegistryCredential
GET/api/v1/registry-credentials/AbilityReadhandleGetRegistryCredential
PUT/api/v1/registry-credentials/AbilityWriteSensitivehandleUpdateRegistryCredential
DELETE/api/v1/registry-credentials/AbilityWriteSensitivehandleDeleteRegistryCredential
POST/api/v1/registry-credentials/{id}/testAbilityWriteSensitivehandleTestRegistryCredential
GET/api/v1/registry-credentials/{id}/repositoriesAbilityReadSensitivehandleListRegistryCredentialRepositories
GET/api/v1/registry-credentials/{id}/tagsAbilityReadSensitivehandleListRegistryCredentialTags
GET/api/v1/domainsAbilityReadhandleListDomains

Built-in Container Registry

Endpoints for:

  • Registry configuration and management
  • Image repository and tag browsing
MethodPathAbilityHandler
GET/api/v1/settings/registryAbilityReadhandleGetRegistrySettings
PUT/api/v1/settings/registryAbilityRoothandleUpdateRegistrySettings
DELETE/api/v1/settings/registryAbilityRoothandleDisableRegistry
GET/api/v1/registry/repositoriesAbilityReadhandleListRegistryRepositories
GET/api/v1/registry/tagsAbilityReadhandleListRegistryTags

Git Provider Apps

Endpoints for:

  • GitHub App integration and repository browsing
  • GitLab App integration and project browsing
  • Bitbucket App integration and repository browsing
  • OAuth flow management and provider status
MethodPathAbilityHandler
GET/api/v1/git-providersAbilityReadSensitivehandleListGitProviders
GET/api/v1/github-appAbilityRoothandleGetGitHubAppStatus
DELETE/api/v1/github-appAbilityRoothandleDisconnectGitHubApp
PUT/api/v1/github-app/manualAbilityRoothandleConnectGitHubAppManually
GET/api/v1/github-app/register/previewAbilityRoothandleGetGitHubAppManifestPreview
GET/api/v1/github-app/register/startAbilityRoothandleStartGitHubAppRegistration
GET/api/v1/github-app/callbackAbilityRoothandleGitHubAppCallback
GET/api/v1/github-app/installedAbilityRoothandleGitHubAppInstalled
GET/api/v1/github-app/reposAbilityReadSensitivehandleListGitHubAppRepos
GET/api/v1/github-app/repos/{owner}/{repo}/branchesAbilityReadSensitivehandleListGitHubAppBranches
POST/api/v1/github-app/repos/{owner}/{repo}/use-as-sourceAbilityWriteSensitivehandleUseGitHubRepoAsSource
GET/api/v1/gitlab-appAbilityRoothandleGetGitLabAppStatus
PUT/api/v1/gitlab-appAbilityRoothandleConnectGitLabApp
DELETE/api/v1/gitlab-appAbilityRoothandleDisconnectGitLabApp
GET/api/v1/gitlab-app/connectAbilityRoothandleStartGitLabAppConnect
GET/api/v1/gitlab-app/callbackAbilityRoothandleGitLabAppCallback
GET/api/v1/gitlab-app/projectsAbilityReadSensitivehandleListGitLabAppProjects
GET/api/v1/gitlab-app/projects/{id}/branchesAbilityReadSensitivehandleListGitLabAppBranches
POST/api/v1/gitlab-app/projects/{id}/use-as-sourceAbilityWriteSensitivehandleUseGitLabProjectAsSource
GET/api/v1/bitbucket-appAbilityRoothandleGetBitbucketAppStatus
PUT/api/v1/bitbucket-appAbilityRoothandleConnectBitbucketApp
DELETE/api/v1/bitbucket-appAbilityRoothandleDisconnectBitbucketApp
GET/api/v1/bitbucket-app/connectAbilityRoothandleStartBitbucketAppConnect
GET/api/v1/bitbucket-app/callbackAbilityRoothandleBitbucketAppCallback
GET/api/v1/bitbucket-app/reposAbilityReadSensitivehandleListBitbucketAppRepos
GET/api/v1/bitbucket-app/repos/{workspace}/{repoSlug}/branchesAbilityReadSensitivehandleListBitbucketAppBranches
POST/api/v1/bitbucket-app/repos/{workspace}/{repoSlug}/use-as-sourceAbilityWriteSensitivehandleUseBitbucketRepoAsSource

Database Backups / Restore / Clone Restore

Endpoints for:

  • Backup history and manual triggers
  • Backup verification and scheduled retention
  • Database control (stop, start, public access)
  • Restore and clone-restore operations
MethodPathAbilityHandler
GET/api/v1/backupsAbilityReadhandleListAllBackups
POST/api/v1/databases/{name}/backupsAbilityWriteSensitivehandleTriggerBackup
GET/api/v1/databases/{name}/backupsAbilityReadhandleListBackupHistory
GET/api/v1/databases/{name}/backups/{historyId}/downloadAbilityReadSensitivehandleDownloadBackup
POST/api/v1/databases/{name}/backups/{historyId}/verifyAbilityWriteSensitivehandleVerifyBackup
GET/api/v1/databases/{name}/backups/{historyId}/verificationsAbilityReadhandleListBackupVerifications
PUT/api/v1/databases/{name}/backup-scheduleAbilityWriteSensitivehandleSetBackupSchedule
DELETE/api/v1/databases/{name}/backup-scheduleAbilityWriteSensitivehandleClearBackupSchedule
PUT/api/v1/databases/{name}/public-accessAbilityWriteSensitivehandleSetDatabasePublicAccess
DELETE/api/v1/databases/{name}/public-accessAbilityWriteSensitivehandleClearDatabasePublicAccess
POST/api/v1/databases/{name}/stopAbilityWriteSensitivehandleStopDatabase
POST/api/v1/databases/{name}/startAbilityWriteSensitivehandleStartDatabase
POST/api/v1/databases/{name}/restoreAbilityRoothandleTriggerRestore
GET/api/v1/databases/{name}/restoresAbilityReadhandleListRestoreHistory
POST/api/v1/databases/{name}/restore-as-newAbilityWriteSensitivehandleCloneRestore
GET/api/v1/databases/{name}/clone-restoresAbilityReadhandleListCloneRestores

App Volume Backups / Restore

Endpoints for:

  • Named volume backup history and scheduling
  • Backup verification and retention management
  • Volume restore operations (in-place and non-destructive clone)
MethodPathAbilityHandler
POST/api/v1/apps/{name}/volumes/{volume}/backupsAbilityWriteSensitivehandleTriggerVolumeBackup
GET/api/v1/apps/{name}/volumes/{volume}/backupsAbilityReadhandleListVolumeBackupHistory
GET/api/v1/apps/{name}/volumes/{volume}/backups/{historyId}/downloadAbilityReadSensitivehandleDownloadVolumeBackup
POST/api/v1/apps/{name}/volumes/{volume}/backups/{historyId}/verifyAbilityWriteSensitivehandleVerifyVolumeBackup
GET/api/v1/apps/{name}/volumes/{volume}/backups/{historyId}/verificationsAbilityReadhandleListVolumeBackupVerifications
GET/api/v1/apps/{name}/volumes/{volume}/backup-scheduleAbilityReadhandleGetVolumeBackupSchedule
PUT/api/v1/apps/{name}/volumes/{volume}/backup-scheduleAbilityWriteSensitivehandleSetVolumeBackupSchedule
DELETE/api/v1/apps/{name}/volumes/{volume}/backup-scheduleAbilityWriteSensitivehandleClearVolumeBackupSchedule
POST/api/v1/apps/{name}/volumes/{volume}/restoreAbilityRoothandleTriggerVolumeRestore
GET/api/v1/apps/{name}/volumes/{volume}/restoresAbilityReadhandleListVolumeRestoreHistory
POST/api/v1/apps/{name}/volumes/{volume}/restore-as-newAbilityWriteSensitivehandleVolumeCloneRestore
GET/api/v1/apps/{name}/volumes/{volume}/clone-restoresAbilityReadhandleListVolumeCloneRestores

App Storage / Database Attach

Endpoints for:

  • Object storage bucket attachment and configuration
  • Database connectivity for applications
MethodPathAbilityHandler
PUT/api/v1/apps/{name}/storageAbilityWriteSensitivehandleSetAppStorage
DELETE/api/v1/apps/{name}/storageAbilityWriteSensitivehandleClearAppStorage
PUT/api/v1/apps/{name}/databaseAbilityWritehandleSetAppDatabase
DELETE/api/v1/apps/{name}/databaseAbilityWritehandleClearAppDatabase
GET/api/v1/storage-env-keysAbilityReadhandleListStorageEnvKeys

Audit Log / Log Drain

Endpoints for:

  • Fleet-wide audit trail and log management
  • External log sink configuration per application
MethodPathAbilityHandler
GET/api/v1/audit-logAbilityRoothandleListAuditLog
POST/api/v1/audit-log/purgeAbilityRoothandlePurgeAuditLog
GET/api/v1/apps/{name}/log-drainAbilityReadhandleGetAppLogDrain
PUT/api/v1/apps/{name}/log-drainAbilityWriteSensitivehandleSetAppLogDrain
DELETE/api/v1/apps/{name}/log-drainAbilityWriteSensitivehandleClearAppLogDrain

Released under the Apache 2.0 License.