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
- Application Deployments Summary
  - get
    Retrieve the application deployment summary
- Application Icon
- Applications
- 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
Scheduler State
- All Service Instances
- Service Instances
Image Registry
- Image Registry Diagnostics
- Image Repositories
- Image Repository
  - post
    Invoke the auto-delete operation
- Image Repository Digests
- Remote Registries
- Remote Registry Operations
- Remote Registry Settings
Volumes
- Volumes
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
- Logout
- 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
Authorization
- Policy
- Policy Log Level
Tenants
- Tenants
- UI Customization
Assigned Sites
- Assigned Sites
DNS
- DNS Zones
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
- Volga Infras
System
- Cluster
- Cluster Hosts
- Diagnostics
- Hardware Resource Profiles
- Ingress Allocation
  - get
    Retrieve the ingress allocation
- OS upgrade host state
  - get
    Retrieve all host states
  - get
    Retrieve a host state
- OS upgrade management
- 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
- Sites
- Software
  - post
    Invoke the upgrade operation
  - post
    Invoke the upgrade-host operation
- System Settings
- Update Location
  - post
    Invoke the update-location operation
Call Home Server
- Call Home Hosts
- Call Home Settings
- Call Home Stats
  - get
    Retrieve the host init stats
- Call Home Summary
  - get
    Retrieve the call home summary
- Client Certificates
- Site Progress
  - get
    Retrieve the sites in progress
Resource Profiles
- Resource Profiles
Site Profiles
- Tenant Site Profiles
Custom Alerts
- Custom Alerts
  - post
    Invoke the alert operation
  - post
    Invoke the clear operation
Subtenant Applications
- Subtenant Application Deployments
- Subtenant Application Deployments Summary
  - get
    Retrieve the application deployment summary
- Subtenant Application Icon
- Subtenant Applications
- 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
Subtenant Image Registry
- Subtenant Image Registry Diagnostics
- Subtenant Image Repositories
- Subtenant Image Repository
  - post
    Invoke the auto-delete operation
- Subtenant Image Repository Digests
- Subtenant Remote Registries
- Subtenant Remote Registry Operations
- Subtenant Remote Registry Settings
Subtenant Volumes
- Subtenant Volumes
Subtenant Authorization
- Subtenant Policy
- Subtenant Policy Log Level
Subtenant Tenants
- Subtenant Tenant Icon
- Subtenant UI Customization
Subtenant Assigned Sites
- Subtenant Assigned Site Settings
- Subtenant Assigned Sites
Subtenant DNS
- Subtenant DNS Zones
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
Subtenant System
- Subtenant OS upgrade host state
  - get
    Retrieve all host states
  - get
    Retrieve a host state
- Subtenant OS upgrade management
Subtenant Resource Profiles
- Subtenant Resource Profiles
Subtenant Site Profiles
- Subtenant Tenant Site Profiles

Internal conf and ops

➔ Next to ACME