Search
Introduction
API URLs
Configuration and Operational State
URIs and Methods
PATCH
ETag Usage
The /v1/config Endpoint
The /v1/state Endpoint
Error Handling
Common Query Parameters
fields
where
dry-run
Variable Expansion
Applications
Application Deployments
post
Create a new application deployment
get
Retrieve the configuration of all application deployments
patch
Update an application deployment
del
Delete an application deployment
put
Replace or create a new application deployment
get
Retrieve the configuration of an application deployment
get
Retrieve the state of all application deployments
get
Retrieve the state of an application deployment
post
Invoke the canary-continue operation
post
Invoke the redeploy operation
Application Deployments Summary
get
Retrieve the application deployment summary
Application Icon
patch
Update the application icon
del
Delete the application icon
put
Replace or create the application icon
get
Retrieve the configuration of application icon
get
Retrieve the the state of application icon
Applications
Application Versioning
post
Create a new application
get
Retrieve the configuration of all applications
patch
Update an application
del
Delete an application
put
Replace or create a new application
get
Retrieve the configuration of an application
get
Retrieve the state of all applications
get
Retrieve the state of an application
Applications Sites Summary
get
Retrieve all application sites summaries
get
Retrieve an application sites summary
Applications Summary
get
Retrieve the application summary
Match Site Labels
post
Invoke the eval-match-site-labels operation
Queued Applications
get
Retrieve the queued applications
post
Invoke the delete operation
post
Invoke the force-upgrade operation
post
Invoke the force-upgrades operation
Scheduler State
All Service Instances
get
Retrieve all service instance with tenants
get
Retrieve a service instance with tenant
get
Retrieve all service instance with tenants
get
Retrieve a service instance with tenant
Service Instances
get
Retrieve all service instances
get
Retrieve a service instance
get
Invoke the connect operation
post
Invoke the exec operation in a container
get
Invoke the exec-interactive operation in a container
post
Invoke the inspect-allocated-resources operation
post
Invoke the debug operation
post
Invoke the debug operation
post
Invoke the exec operation in an init-container
get
Invoke the exec-interactive operation in an init-container
post
Invoke the inspect-allocated-resources operation
post
Invoke the restart operation
post
Invoke the exec operation in a vm container
get
Invoke the exec-interactive operation in a vm container
post
Invoke the inspect-allocated-resources operation
Image Registry
Image Registry Diagnostics
post
Invoke the get-stats operation
post
Invoke the prune operation
post
Invoke the reset operation
Image Repositories
get
Retrieve all repositories
get
Retrieve a repository
post
Invoke the delete operation
post
Invoke the create-tag operation
post
Invoke the delete operation
Image Repository
post
Invoke the auto-delete operation
Image Repository Digests
get
Retrieve all manifest lists
get
Retrieve a manifest list
post
Invoke the create-tag operation
post
Invoke the delete operation
Remote Registries
post
Create a new remote registry
get
Retrieve the configuration of all remote registries
patch
Update a remote registry
del
Delete a remote registry
put
Replace or create a new remote registry
get
Retrieve the configuration of a remote registry
get
Retrieve the state of all remote registries
get
Retrieve the state of a remote registry
post
Invoke the list-images operation
post
Invoke the list-repositories operation
post
Invoke the pull operation
post
Invoke the verify-credentials operation
Remote Registry Operations
post
Invoke the list-remote-images operation
post
Invoke the pull operation
post
Invoke the verify-credentials operation
Remote Registry Settings
patch
Update the registry settings
del
Delete the registry settings
put
Replace or create the registry settings
get
Retrieve the configuration of registry settings
get
Retrieve the the state of registry settings
Volumes
Volumes
get
Retrieve all volumes
get
Retrieve a volume
post
Invoke the delete-from-all-sites operation
post
Invoke the delete operation
Authentication
Approle Login
post
Invoke the approle-login operation
Certificate
post
Invoke the get-api-ca-cert operation
Create Root Token
post
Invoke the create-root operation
Create Token
post
Invoke the create-token operation
post
Invoke the list-accessors operation
Disable Authentication Token
post
Invoke the disable operation
Limit Authentication Token
post
Invoke the set-bound-cidrs operation
Login
post
Invoke the id-provider-auth-callback operation
post
Invoke the id-provider-info-callback operation
post
Invoke the kubernetes-login operation
post
Invoke the login operation
post
Invoke the oidc-callback operation
get
Invoke the oidc-callback operation
post
Invoke the oidc-login operation
post
Invoke the oidc-validate-state operation
post
Invoke the passkey-challenge operation
post
Invoke the passkey-login operation
post
Invoke the passkey-login-assertion operation
post
Invoke the re-authenticate operation
Logout
post
Invoke the logout operation
post
Invoke the oidc-logout operation
get
Invoke the oidc-logout operation
Release Authentication Token
post
Invoke the release operation
Revoke Authentication Token
post
Invoke the revoke operation
Token Info
post
Invoke the info operation
post
Invoke the token-info operation
Token Refresh
post
Invoke the refresh operation
Token TTL
patch
Update the token tenant settings
del
Delete the token tenant settings
put
Replace or create the token tenant settings
get
Retrieve the configuration of token tenant settings
get
Retrieve the the state of token tenant settings
Authorization
Policy
post
Create a new policy
get
Retrieve the configuration of all policies
patch
Update a policy
del
Delete a policy
put
Replace or create a new policy
get
Retrieve the configuration of a policy
get
Retrieve the state of all policies
get
Retrieve the state of a policy
post
Invoke the test-rest-rule operation
Policy Log Level
patch
Update the log level
del
Delete the log level
put
Replace or create the log level
get
Retrieve the configuration of log level
get
Retrieve the the state of log level
Tenants
Tenants
post
Create a new tenant
get
Retrieve the configuration of all tenants
patch
Update a tenant
del
Delete a tenant
put
Replace or create a new tenant
get
Retrieve the configuration of a tenant
get
Retrieve the state of all tenants
get
Retrieve the state of a tenant
UI Customization
patch
Update the ui customization
del
Delete the ui customization
put
Replace or create the ui customization
get
Retrieve the configuration of ui customization
get
Retrieve the the state of ui customization
Assigned Sites
Assigned Sites
post
Create a new assigned site
get
Retrieve the configuration of all assigned sites
patch
Update an assigned site
del
Delete an assigned site
put
Replace or create a new assigned site
get
Retrieve the configuration of an assigned site
get
Retrieve the state of all assigned sites
get
Retrieve the state of an assigned site
DNS
DNS Zones
patch
Update the dns
del
Delete the dns
put
Replace or create the dns
get
Retrieve the configuration of dns
get
Retrieve the the state of dns
Strongbox
Internal conf and ops
ACME
post
Create a new acme services
get
Retrieve the configuration of all acme serviceses
patch
Update an acme services
del
Delete an acme services
put
Replace or create a new acme services
get
Retrieve the configuration of an acme services
post
Create a new static requests
get
Retrieve the configuration of all static requestses
patch
Update a static requests
del
Delete a static requests
put
Replace or create a new static requests
get
Retrieve the configuration of a static requests
get
Retrieve the state of all acme serviceses
get
Retrieve the state of an acme services
post
Invoke the request-cert operation
post
Invoke the delete operation
get
Retrieve the state of all static requestses
get
Retrieve the state of a static requests
Approle
get
Retrieve all approle secret id accessors
get
Retrieve an approle secret id accessor
Approles
post
Create a new approle
get
Retrieve the configuration of all approles
patch
Update an approle
del
Delete an approle
put
Replace or create a new approle
get
Retrieve the configuration of an approle
get
Retrieve the state of all approles
get
Retrieve the state of an approle
post
Invoke the create-secret-id operation
post
Invoke the delete-secret-id operation
Audit
post
Invoke the hmac operation
Crypto Misc
post
Invoke the bcrypt-pw operation
post
Invoke the bcrypt-verify operation
post
Invoke the hash-data operation
post
Invoke the random-bytes operation
Entities
post
Create a new entity
get
Retrieve the configuration of all entities
patch
Update an entity
del
Delete an entity
put
Replace or create a new entity
get
Retrieve the configuration of an entity
get
Retrieve the state of all entities
get
Retrieve the state of an entity
Entity Aliases
post
Create a new entity alias
get
Retrieve the configuration of all entity aliases
patch
Update an entity alias
del
Delete an entity alias
put
Replace or create a new entity alias
get
Retrieve the configuration of an entity alias
get
Retrieve the state of all entity aliases
get
Retrieve the state of an entity alias
Kubernetes Authentication
post
Create a new kubernetes
get
Retrieve the configuration of all kuberneteses
patch
Update a kubernetes
del
Delete a kubernetes
put
Replace or create a new kubernetes
get
Retrieve the configuration of a kubernetes
post
Create a new kubernetes role
get
Retrieve the configuration of all kubernetes roles
patch
Update a kubernetes role
del
Delete a kubernetes role
put
Replace or create a new kubernetes role
get
Retrieve the configuration of a kubernetes role
get
Retrieve the state of all kuberneteses
get
Retrieve the state of a kubernetes
get
Retrieve the state of all kubernetes roles
get
Retrieve the state of a kubernetes role
Mount Accessors
get
Retrieve all mount accessors
get
Retrieve a mount accessor
Open ID Connect
post
Create a new oidc service
get
Retrieve the configuration of all oidc services
patch
Update an oidc service
del
Delete an oidc service
put
Replace or create a new oidc service
get
Retrieve the configuration of an oidc service
post
Create a new oidc service role
get
Retrieve the configuration of all oidc service roles
patch
Update an oidc service role
del
Delete an oidc service role
put
Replace or create a new oidc service role
get
Retrieve the configuration of an oidc service role
patch
Update the oidc settings
del
Delete the oidc settings
put
Replace or create the oidc settings
get
Retrieve the configuration of oidc settings
post
Invoke the list-oidc-services operation
get
Retrieve the state of all oidc services
get
Retrieve the state of an oidc service
post
Invoke the auth-url operation
get
Retrieve the state of all oidc service roles
get
Retrieve the state of an oidc service role
get
Retrieve the the state of oidc settings
SSH CA Roles
post
Create a new ssh ca role
get
Retrieve the configuration of all ssh ca roles
patch
Update an ssh ca role
del
Delete an ssh ca role
put
Replace or create a new ssh ca role
get
Retrieve the configuration of an ssh ca role
get
Retrieve the state of all ssh ca roles
get
Retrieve the state of an ssh ca role
post
Invoke the get-otp operation
post
Invoke the issue-cert operation
post
Invoke the validate-otp operation
SSH CAs
OTPs
post
Create a new ssh ca
get
Retrieve the configuration of all ssh cas
patch
Update an ssh ca
del
Delete an ssh ca
put
Replace or create a new ssh ca
get
Retrieve the configuration of an ssh ca
get
Retrieve the state of all ssh cas
get
Retrieve the state of an ssh ca
post
Invoke the issue-cert operation
System Operations
post
Invoke the block-tenant operation
post
Invoke the create-root-token operation
post
Invoke the debug-key operation
post
Invoke the reveal-sealkey operation
post
Invoke the rotate-seal operation
post
Invoke the seal operation
post
Invoke the set-state-hmac-key operation
post
Invoke the setup-tenant operation
post
Invoke the unblock-tenant operation
post
Invoke the unseal operation
post
Invoke the update-api-ca-site operation
post
Invoke the update-api-cert-site operation
post
Invoke the update-dist-ca-site operation
post
Invoke the update-dist-cert-site operation
post
Invoke the get-remote-sealkey operation
post
Invoke the reauthorize operation
post
Invoke the revoke-reauthorize operation
post
Invoke the quarantine-site operation
post
Invoke the quarantine-site-host operation
post
Invoke the reallow-site-unwrap operation
post
Invoke the unquarantine-site operation
post
Invoke the unquarantine-site-host operation
TLS CA Roles
post
Create a new tls ca role
get
Retrieve the configuration of all tls ca roles
patch
Update a tls ca role
del
Delete a tls ca role
put
Replace or create a new tls ca role
get
Retrieve the configuration of a tls ca role
get
Retrieve the state of all tls ca roles
get
Retrieve the state of a tls ca role
post
Invoke the check-ca operation
post
Invoke the get-ca-cert operation
post
Invoke the issue-cert operation
post
Invoke the renew-cert operation
post
Invoke the revoke-cert operation
post
Invoke the rotate-ca operation
TLS CAs
post
Create a new tls ca
get
Retrieve the configuration of all tls cas
patch
Update a tls ca
del
Delete a tls ca
put
Replace or create a new tls ca
get
Retrieve the configuration of a tls ca
get
Retrieve the state of all tls cas
get
Retrieve the state of a tls ca
post
Invoke the check-ca operation
post
Invoke the destroy-private-key operation
post
Invoke the export-wrapped-private-key operation
post
Invoke the get-ca-cert operation
post
Invoke the get-crl operation
post
Invoke the get-crls operation
post
Invoke the import-new-ca-cert operation
post
Invoke the import-wrapped-private-key operation
post
Invoke the issue-cert operation
post
Invoke the renew-cert operation
post
Invoke the revoke-cert operation
post
Invoke the rotate-ca operation
TOTP
post
Create a new totp
get
Retrieve the configuration of all totps
patch
Update a totp
del
Delete a totp
put
Replace or create a new totp
get
Retrieve the configuration of a totp
get
Retrieve the state of all totps
get
Retrieve the state of a totp
post
Invoke the get-code operation
post
Invoke the get-qr-code operation
post
Invoke the verify-code operation
Transform Data
post
Invoke the decode operation
post
Invoke the encode operation
Transform Roles
post
Create a new transform role
get
Retrieve the configuration of all transform roles
patch
Update a transform role
del
Delete a transform role
put
Replace or create a new transform role
get
Retrieve the configuration of a transform role
get
Retrieve the state of all transform roles
get
Retrieve the state of a transform role
Transit Keys
post
Create a new transit key
get
Retrieve the configuration of all transit keys
patch
Update a transit key
del
Delete a transit key
put
Replace or create a new transit key
get
Retrieve the configuration of a transit key
get
Retrieve the state of all transit keys
get
Retrieve the state of a transit key
post
Invoke the backup operation
post
Invoke the check-rotate operation
post
Invoke the decrypt operation
post
Invoke the encrypt operation
post
Invoke the export operation
post
Invoke the generate-data-key operation
post
Invoke the hmac operation
post
Invoke the import operation
post
Invoke the restore operation
post
Invoke the rewrap operation
post
Invoke the rotate operation
post
Invoke the sign operation
post
Invoke the trim operation
post
Invoke the verify operation
User Passwords
post
Create a new userpass
get
Retrieve the configuration of all userpasses
patch
Update the userpass settings
del
Delete the userpass settings
put
Replace or create the userpass settings
get
Retrieve the configuration of userpass settings
patch
Update an userpass
del
Delete an userpass
put
Replace or create a new userpass
get
Retrieve the configuration of an userpass
get
Retrieve the state of all userpasses
get
Retrieve the the state of userpass settings
get
Retrieve the state of an userpass
Userpass
post
Invoke the change-password operation
post
Invoke the create-passkey operation
post
Invoke the disable-totp operation
post
Invoke the enable-totp operation
post
Invoke the enable-totp-verify operation
post
Invoke the register-passkey operation
post
Invoke the remove-passkey operation
Vault
post
Create a new vault
get
Retrieve the configuration of all vaults
patch
Update a vault
del
Delete a vault
put
Replace or create a new vault
get
Retrieve the configuration of a vault
post
Create a new vault secret
get
Retrieve the configuration of all vault secrets
patch
Update a vault secret
del
Delete a vault secret
put
Replace or create a new vault secret
get
Retrieve the configuration of a vault secret
get
Retrieve the state of all vaults
get
Retrieve the state of a vault
get
Retrieve the state of all vault secrets
get
Retrieve the state of a vault secret
post
Invoke the delete operation
post
Invoke the destroy operation
post
Invoke the undelete operation
Wrapped data
post
Invoke the unwrap operation
post
Invoke the wrap operation
Volga
Clients
get
Retrieve all client infos
get
Retrieve a client info
Query Topics
post
Invoke the query-topics operation
Topics
post
Invoke the create-topic operation
get
Retrieve all topic infos
get
Retrieve a topic info
post
Invoke the change-options operation
post
Invoke the consume operation
post
Invoke the delete operation
post
Invoke the produce operation
post
Invoke the redistribute operation
Volga Infras
post
Create a new volga infra
get
Retrieve the configuration of all volga infras
patch
Update a volga infra
del
Delete a volga infra
put
Replace or create a new volga infra
get
Retrieve the configuration of a volga infra
get
Retrieve the state of all volga infras
get
Retrieve the state of a volga infra
post
Invoke the consume operation
post
Invoke the produce operation
System
Cluster
get
Retrieve the cluster
post
Invoke the drain-host operation
post
Invoke the reschedule operation
post
Invoke the update-use-proxy-settings operation
Cluster Hosts
get
Retrieve all cluster hosts
get
Retrieve a cluster host
post
Invoke the create-auto-volume operation
post
Invoke the drain operation
post
Invoke the get-udevs operation
post
Invoke the reload-volumes operation
post
Invoke the update-use-proxy-settings operation
Diagnostics
post
Invoke the generate-debug-dump operation
post
Invoke the get-connections operation
Hardware Resource Profiles
post
Create a new resource profile
get
Retrieve the configuration of all resource profiles
patch
Update a resource profile
del
Delete a resource profile
put
Replace or create a new resource profile
get
Retrieve the configuration of a resource profile
get
Retrieve the state of all resource profiles
get
Retrieve the state of a resource profile
Ingress Allocation
get
Retrieve the ingress allocation
OS upgrade host state
get
Retrieve all host states
get
Retrieve a host state
OS upgrade management
patch
Update the os upgrade
del
Delete the os upgrade
put
Replace or create the os upgrade
get
Retrieve the configuration of os upgrade
get
Retrieve the the state of os upgrade
post
Invoke the trigger-upgrade-site operation
Resolved Policy Rules
post
Invoke the resolve-policy-rules operation
Site Allocations
get
Retrieve the site allocation
Site Hosts Summary
get
Retrieve the hosts summary
Site Summary
get
Retrieve all site summaries
get
Retrieve a site summary
Site profiles
post
Create a new site profile
get
Retrieve the configuration of all site profiles
patch
Update a site profile
del
Delete a site profile
put
Replace or create a new site profile
get
Retrieve the configuration of a site profile
get
Retrieve the state of all site profiles
get
Retrieve the state of a site profile
Sites
post
Create a new site
get
Retrieve the configuration of all sites
patch
Update a site
del
Delete a site
put
Replace or create a new site
get
Retrieve the configuration of a site
get
Retrieve the state of all sites
get
Retrieve the state of a site
Software
post
Invoke the upgrade operation
post
Invoke the upgrade-host operation
System Settings
patch
Update the system settings
del
Delete the system settings
put
Replace or create the system settings
get
Retrieve the configuration of system settings
get
Retrieve the certificate ttls
get
Retrieve the the state of system settings
Update Location
post
Invoke the update-location operation
Call Home Server
Call Home Hosts
post
Invoke the clear operation
get
Retrieve all duplicates
get
Retrieve a duplicate
post
Invoke the clear operation
get
Retrieve all unclaimeds
get
Retrieve an unclaimed
post
Invoke the assign-site operation
post
Invoke the clear operation
Call Home Settings
patch
Update the settings
del
Delete the settings
put
Replace or create the settings
get
Retrieve the configuration of settings
get
Retrieve the the state of settings
Call Home Stats
get
Retrieve the host init stats
Call Home Summary
get
Retrieve the call home summary
Client Certificates
post
Invoke the issue-host-cert operation
post
Invoke the issue-site-cert operation
post
Invoke the issue-system-cert operation
Site Progress
get
Retrieve the sites in progress
Resource Profiles
Resource Profiles
post
Create a new tenant resource profile
get
Retrieve the configuration of all tenant resource profiles
patch
Update a tenant resource profile
del
Delete a tenant resource profile
put
Replace or create a new tenant resource profile
get
Retrieve the configuration of a tenant resource profile
get
Retrieve the state of all tenant resource profiles
get
Retrieve the state of a tenant resource profile
Site Profiles
Tenant Site Profiles
post
Create a new tenant site profile
get
Retrieve the configuration of all tenant site profiles
patch
Update a tenant site profile
del
Delete a tenant site profile
put
Replace or create a new tenant site profile
get
Retrieve the configuration of a tenant site profile
get
Retrieve the state of all tenant site profiles
get
Retrieve the state of a tenant site profile
Custom Alerts
Custom Alerts
post
Invoke the alert operation
post
Invoke the clear operation
Subtenant Applications
Subtenant Application Deployments
post
Create a new application deployment
get
Retrieve the configuration of all application deployments
patch
Update an application deployment
del
Delete an application deployment
put
Replace or create a new application deployment
get
Retrieve the configuration of an application deployment
get
Retrieve the state of all application deployments
get
Retrieve the state of an application deployment
post
Invoke the canary-continue operation
post
Invoke the redeploy operation
Subtenant Application Deployments Summary
get
Retrieve the application deployment summary
Subtenant Application Icon
patch
Update the application icon
del
Delete the application icon
put
Replace or create the application icon
get
Retrieve the configuration of application icon
get
Retrieve the the state of application icon
Subtenant Applications
Application Versioning
post
Create a new application
get
Retrieve the configuration of all applications
patch
Update an application
del
Delete an application
put
Replace or create a new application
get
Retrieve the configuration of an application
get
Retrieve the state of all applications
get
Retrieve the state of an application
Subtenant Applications Sites Summary
get
Retrieve all application sites summaries
get
Retrieve an application sites summary
Subtenant Applications Summary
get
Retrieve the application summary
Subtenant Match Site Labels
post
Invoke the eval-match-site-labels operation
Subtenant Queued Applications
get
Retrieve the queued applications
Subtenant Scheduler State
Subtenant Service Instances
get
Retrieve all service instances
get
Retrieve a service instance
post
Invoke the inspect-allocated-resources operation
post
Invoke the debug operation
post
Invoke the debug operation
post
Invoke the inspect-allocated-resources operation
post
Invoke the restart operation
post
Invoke the inspect-allocated-resources operation
Subtenant Image Registry
Subtenant Image Registry Diagnostics
post
Invoke the get-stats operation
post
Invoke the prune operation
post
Invoke the reset operation
Subtenant Image Repositories
get
Retrieve all repositories
get
Retrieve a repository
post
Invoke the delete operation
post
Invoke the create-tag operation
post
Invoke the delete operation
Subtenant Image Repository
post
Invoke the auto-delete operation
Subtenant Image Repository Digests
get
Retrieve all manifest lists
get
Retrieve a manifest list
post
Invoke the create-tag operation
post
Invoke the delete operation
Subtenant Remote Registries
post
Create a new remote registry
get
Retrieve the configuration of all remote registries
patch
Update a remote registry
del
Delete a remote registry
put
Replace or create a new remote registry
get
Retrieve the configuration of a remote registry
get
Retrieve the state of all remote registries
get
Retrieve the state of a remote registry
post
Invoke the list-images operation
post
Invoke the list-repositories operation
post
Invoke the pull operation
post
Invoke the verify-credentials operation
Subtenant Remote Registry Operations
post
Invoke the list-remote-images operation
post
Invoke the pull operation
post
Invoke the verify-credentials operation
Subtenant Remote Registry Settings
patch
Update the registry settings
del
Delete the registry settings
put
Replace or create the registry settings
get
Retrieve the configuration of registry settings
get
Retrieve the the state of registry settings
Subtenant Volumes
Subtenant Volumes
get
Retrieve all volumes
get
Retrieve a volume
post
Invoke the delete-from-all-sites operation
post
Invoke the delete operation
Subtenant Authorization
Subtenant Policy
post
Create a new policy
get
Retrieve the configuration of all policies
patch
Update a policy
del
Delete a policy
put
Replace or create a new policy
get
Retrieve the configuration of a policy
get
Retrieve the state of all policies
get
Retrieve the state of a policy
post
Invoke the test-rest-rule operation
Subtenant Policy Log Level
patch
Update the log level
del
Delete the log level
put
Replace or create the log level
get
Retrieve the configuration of log level
get
Retrieve the the state of log level
Subtenant Tenants
Subtenant Tenant Icon
patch
Update the tenant icon
del
Delete the tenant icon
put
Replace or create the tenant icon
get
Retrieve the configuration of tenant icon
get
Retrieve the the state of tenant icon
Subtenant UI Customization
patch
Update the ui customization
del
Delete the ui customization
put
Replace or create the ui customization
get
Retrieve the configuration of ui customization
get
Retrieve the the state of ui customization
Subtenant Assigned Sites
Subtenant Assigned Site Settings
patch
Update the assigned site settings
del
Delete the assigned site settings
put
Replace or create the assigned site settings
get
Retrieve the configuration of assigned site settings
get
Retrieve the the state of assigned site settings
Subtenant Assigned Sites
post
Create a new assigned site
get
Retrieve the configuration of all assigned sites
patch
Update an assigned site
del
Delete an assigned site
put
Replace or create a new assigned site
get
Retrieve the configuration of an assigned site
get
Retrieve the state of all assigned sites
get
Retrieve the state of an assigned site
Subtenant DNS
Subtenant DNS Zones
patch
Update the dns
del
Delete the dns
put
Replace or create the dns
get
Retrieve the configuration of dns
get
Retrieve the the state of dns
Subtenant Volga
Subtenant Clients
get
Retrieve all client infos
get
Retrieve a client info
Subtenant Topics
get
Retrieve all topic infos
get
Retrieve a topic info
Subtenant Volga Infras
post
Create a new volga infra
get
Retrieve the configuration of all volga infras
patch
Update a volga infra
del
Delete a volga infra
put
Replace or create a new volga infra
get
Retrieve the configuration of a volga infra
get
Retrieve the state of all volga infras
get
Retrieve the state of a volga infra
Subtenant System
Subtenant OS upgrade host state
get
Retrieve all host states
get
Retrieve a host state
Subtenant OS upgrade management
patch
Update the os upgrade
del
Delete the os upgrade
put
Replace or create the os upgrade
get
Retrieve the configuration of os upgrade
get
Retrieve the the state of os upgrade
Subtenant Resource Profiles
Subtenant Resource Profiles
post
Create a new tenant resource profile
get
Retrieve the configuration of all tenant resource profiles
patch
Update a tenant resource profile
del
Delete a tenant resource profile
put
Replace or create a new tenant resource profile
get
Retrieve the configuration of a tenant resource profile
get
Retrieve the state of all tenant resource profiles
get
Retrieve the state of a tenant resource profile
Subtenant Site Profiles
Subtenant Tenant Site Profiles
post
Create a new tenant site profile
get
Retrieve the configuration of all tenant site profiles
patch
Update a tenant site profile
del
Delete a tenant site profile
put
Replace or create a new tenant site profile
get
Retrieve the configuration of a tenant site profile
get
Retrieve the state of all tenant site profiles
get
Retrieve the state of a tenant site profile
Powered by Redocly
Internal conf and ops
➔ Next to
ACME