Skip to main content
API docs by Redocly

PDS API (121)

Download OpenAPI specification:Download

Portworx Data Services API Server

AccountsRoleInvitations

Delete AccountRoleInvitation

Removes a single AccountRoleInvitation

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

AccountRoleInvitation ID (must be valid UUID)

Responses

Patch AccountRoleInvitation role_name

Patches AccountRoleInvitation role_name

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

AccountRoleInvitation ID (must be valid UUID)

Request Body schema: application/json

Object with patched role name

role_name
string

Responses

Request samples

Content type
application/json
{
  • "role_name": "string"
}

Accounts

List Accounts

Lists Accounts.

Authorizations:
ApiKeyAuth
query Parameters
sort_by
string

A given Accounts attribute to sort results by (one of: id, name, created_at)

limit
string

Maximum number of rows to return (could be less)

continuation
string

Use a token returned by a previous query to continue listing with the next batch of rows

id
string

Filter results by Accounts id

name
string

Filter results by Accounts name

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Create Account

Creates a new Account

Authorizations:
ApiKeyAuth
Request Body schema: application/json

Request body containing name of the account

baas_features_enabled
boolean

Whether BAAS should be enabled for this account.

object (models.DNSDetails)
object (models.MAASDetails)
name
string

Name of the account.

pds_features_enabled
boolean

Whether PDS should be enabled for this account.

pxone_features_enabled
boolean

Whether PX-ONE should be enabled for this account.

subdomain
string

(optional) Account subdomain name.

Responses

Request samples

Content type
application/json
{
  • "baas_features_enabled": true,
  • "dns_details": {
    },
  • "maas_details": {
    },
  • "name": "string",
  • "pds_features_enabled": true,
  • "pxone_features_enabled": true,
  • "subdomain": "string"
}

Response samples

Content type
application/json
{
  • "baas_features_enabled": true,
  • "created_at": "string",
  • "eula": {
    },
  • "global_config": {
    },
  • "id": "string",
  • "name": "string",
  • "pds_features_enabled": true,
  • "pxone_features_enabled": true,
  • "updated_at": "string"
}

Get Account

Fetches a single Account

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Account ID (must be valid UUID)

Responses

Response samples

Content type
application/json
{
  • "baas_features_enabled": true,
  • "created_at": "string",
  • "eula": {
    },
  • "global_config": {
    },
  • "id": "string",
  • "name": "string",
  • "pds_features_enabled": true,
  • "pxone_features_enabled": true,
  • "updated_at": "string"
}

Update Account

Modify Account meta: currently only name update allowed

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Account ID (must be valid UUID)

Request Body schema: application/json

Request body containing the name. .

name
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

List Account Role Invitations

Lists Account Role Invitations

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Account ID (must be valid UUID)

query Parameters
sort_by
string

A given User attribute to sort results by (one of: id, email, role_name, created_at)

limit
string

Maximum number of rows to return (could be less)

continuation
string

Use a token returned by a previous query to continue listing with the next batch of rows

id
string

Filter results by invitation id

email
string

Filter results by User email

role_name
string

Filter results by assigned role name

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Accept EULA

Accept a specific EULA version

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Account ID (must be valid UUID)

Request Body schema: application/json

Request body containing the version of the EULA.

version
string

Version of the EULA.

Responses

Request samples

Content type
application/json
{
  • "version": "string"
}

Update AccountGlobalConfig

Modify AccountGlobalConfig for this Account

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Account ID (must be valid UUID)

Request Body schema: application/json

Request body containing the global config values. Empty values are ignored.

tls_preview_enabled
string
Value: "all"

Specify if the TLS Preview feature should be enabled for this account.

version_availability
string
Value: "all"

Specify what data service versions are available for deployment for this account.

version_updatability
string
Value: "all"

Specify what data service versions are updatable for this account.

Responses

Request samples

Content type
application/json
{
  • "tls_preview_enabled": "all",
  • "version_availability": "all",
  • "version_updatability": "all"
}

List Account Users

Lists Account Users

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Account ID (must be valid UUID)

query Parameters
sort_by
string

A given User attribute to sort results by (one of: id, email, created_at)

limit
string

Maximum number of rows to return (could be less)

continuation
string

Use a token returned by a previous query to continue listing with the next batch of rows

id
string

Filter results by User id

email
string

Filter results by User email

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Accounts DNS

Update DNS Details

Update DNS details for desired account

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Account ID (must be valid UUID)

Request Body schema: application/json

Request body containing a new DNS details

object (models.AWSDetails)
dns_zone
string

Responses

Request samples

Content type
application/json
{
  • "aws_details": {
    },
  • "dns_zone": "string"
}

IAM

List IAM

Lists IAM records for an account

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Account ID (must be valid UUID)

query Parameters
sort_by
string

A given IAM attribute to sort results by (one of: account_id, actor_id)

actor_id
string

Filter results by IAM actor id

actor_type
string

Filter results by IAM actor type

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update IAM

Updates a IAM rolebinding

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Account ID (must be valid UUID)

Request Body schema: application/json

Request body contains actor ID

actor_id
required
string
required
object (models.AccessPolicy)

Responses

Request samples

Content type
application/json
{
  • "actor_id": "string",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "access_policy": {
    },
  • "account_id": "string",
  • "actor_id": "string",
  • "actor_type": "string",
  • "created_at": "string",
  • "id": "string",
  • "updated_at": "string"
}

Create IAM

Creates a new IAM rolebinding

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Account ID (must be valid UUID)

Request Body schema: application/json

Request body contains actor ID

actor_id
required
string
required
object (models.AccessPolicy)

Responses

Request samples

Content type
application/json
{
  • "actor_id": "string",
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "access_policy": {
    },
  • "account_id": "string",
  • "actor_id": "string",
  • "actor_type": "string",
  • "created_at": "string",
  • "id": "string",
  • "updated_at": "string"
}

Get IAM

Fetches an IAM record

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Account ID (must be valid UUID)

actor-id
required
string

Actor ID (must be valid UUID)

Responses

Response samples

Content type
application/json
{
  • "access_policy": {
    },
  • "account_id": "string",
  • "actor_id": "string",
  • "actor_type": "string",
  • "created_at": "string",
  • "id": "string",
  • "updated_at": "string"
}

Delete IAM

Removes a single AccountIAM

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Account ID (must be valid UUID)

actor-id
required
string

Actor ID (must be valid UUID)

Responses

AccountRoleBindings

Create Invitation

Adds role binding to existing user or creates invitation if user does not exist.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Account ID (must be valid UUID)

Request Body schema: application/json

Request body containing the invitation details.

email
required
string
role_name
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "role_name": "string"
}

List AccountRoleBinding

Lists AccountRoleBinding

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Account ID (must be valid UUID)

query Parameters
sort_by
string

A given AccountRoleBinding attribute to sort results by (one of: role_name, actor_id)

role_name
string

Filter results by AccountRoleBinding assigned role name

actor_id
string

Filter results by AccountRoleBinding actor id

actor_type
string

Filter results by AccountRoleBinding actor type

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create/Update AccountRoleBinding

Creates a new AccountRoleBinding, or updates role_name if binding for (actor_id, actor_type) already exists.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Account ID (must be valid UUID)

Request Body schema: application/json

Request body containing the account role binding

actor_id
string
actor_type
string
role_name
string

Responses

Request samples

Content type
application/json
{
  • "actor_id": "ID of the role subject",
  • "actor_type": "Type of the role subject",
  • "role_name": "Name of the assigned role"
}

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "actor_id": "string",
  • "actor_type": "string",
  • "role_name": "string"
}

Delete AccountRoleBinding

Removes a single AccountRoleBinding

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Account ID (must be valid UUID)

Request Body schema: application/json

Request body containing the account role binding

actor_id
string
actor_type
string

Responses

Request samples

Content type
application/json
{
  • "actor_id": "string",
  • "actor_type": "string"
}

List User's AccountRoleBindings

Lists the AccountRoleBindings of a User.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

User ID (must be valid UUID)

query Parameters
sort_by
string

A given AccountRoleBinding attribute to sort results by (allowed: role_name)

role_name
string

Filter results by role_name

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Accounts MAASDetails

Get MAAS details

Returns MAAS details for desired account

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Account ID (must be valid UUID)

Responses

Response samples

Content type
application/json
{
  • "maas_id": "string"
}

Update MAAS details

Updates MAAS details for desired account

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Account ID (must be valid UUID)

Responses

ServiceIdentity

List Service Identity

Lists all ServiceIdentity for an account

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Account ID (must be valid UUID)

query Parameters
sort_by
string

A given Service Identity attribute to sort results by (one of: id, name, created_at, created_by)

limit
string

Maximum number of rows to return (could be less)

continuation
string

Use a token returned by a previous query to continue listing with the next batch of rows

id
string

Filter results by service identity id

name
string

Filter results by name

created_by
string

Filter results by created_by

client_id
string

Filter results by client_id

enabled
boolean

Filter results by enabled

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Create a Service Identity

Create a Service Identity for programmatic access to pds

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Account ID (must be valid UUID)

Request Body schema: application/json

Request body containing the service identity details.

description
string
enabled
required
boolean
name
required
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "enabled": true,
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "client_id": "string",
  • "client_token": "string",
  • "created_at": "string",
  • "created_by": "string",
  • "description": "string",
  • "enabled": true,
  • "id": "string",
  • "name": "string",
  • "secret_generation_count": 0,
  • "secret_updated_at": "string",
  • "updated_at": "string"
}

Get service identity by ID

Get service identity by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Service Identity ID (must be valid UUID)

Responses

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "client_id": "string",
  • "created_at": "string",
  • "created_by": "string",
  • "description": "string",
  • "enabled": true,
  • "id": "string",
  • "name": "string",
  • "secret_generation_count": 0,
  • "secret_updated_at": "string",
  • "updated_at": "string"
}

Update service identity

Update service identity name or description

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Service Identity ID (must be valid UUID)

Request Body schema: application/json

Request body containing the service identity details.

description
string
enabled
required
boolean
name
required
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "enabled": true,
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "client_id": "string",
  • "created_at": "string",
  • "created_by": "string",
  • "description": "string",
  • "enabled": true,
  • "id": "string",
  • "name": "string",
  • "secret_generation_count": 0,
  • "secret_updated_at": "string",
  • "updated_at": "string"
}

Delete service identity

Delete service identity by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Service Identity ID (must be valid UUID)

Responses

Regenerate service identity credentials

Revokes existing credentials and regenerate new ClientID and ClientToken

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Service Identity ID (must be valid UUID)

Responses

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "client_id": "string",
  • "client_token": "string",
  • "created_at": "string",
  • "created_by": "string",
  • "description": "string",
  • "enabled": true,
  • "id": "string",
  • "name": "string",
  • "secret_generation_count": 0,
  • "secret_updated_at": "string",
  • "updated_at": "string"
}

Generate JWT token for service identity

Generates JWT token for a service identity using client id and client token

Authenticating for later requests using the ID token: Authorization: Bearer {id_token}

Request Body schema: application/json

Request body containing the client id and client token.

client_id
string
client_token
string

Responses

Request samples

Content type
application/json
{
  • "client_id": "string",
  • "client_token": "string"
}

Response samples

Content type
application/json
{
  • "token": "string",
  • "valid_for": "string"
}

Tenants

List Account's Tenants

Lists Tenants.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Account ID (must be valid UUID)

query Parameters
sort_by
string

A given Tenant attribute to sort results by (one of: id, name, created_at)

limit
string

Maximum number of rows to return (could be less)

continuation
string

Use a token returned by a previous query to continue listing with the next batch of rows

id
string

Filter results by Tenant id

name
string

Filter results by Tenant name

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Get Tenant

Fetches a single Tenant

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Tenant ID (must be valid UUID)

Responses

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "created_at": "string",
  • "id": "string",
  • "name": "string",
  • "updated_at": "string"
}

Get DNS details for Tenant

Get DNS details/credentials for Tenant

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Tenant ID (must be valid UUID)

Responses

Response samples

Content type
application/json
{
  • "aws_details": {
    },
  • "dns_zone": "string"
}

ApplicationConfigurationTemplates

Get ApplicationConfigurationTemplate

Fetches a single ApplicationConfigurationTemplate

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

ApplicationConfigurationTemplate ID (must be valid UUID)

Responses

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "config_items": [
    ],
  • "created_at": "string",
  • "data_service_id": "string",
  • "id": "string",
  • "name": "string",
  • "tenant_id": "string",
  • "updated_at": "string"
}

Update ApplicationConfigurationTemplate

Updates existing ApplicationConfigurationTemplate

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

ApplicationConfigurationTemplate ID (must be valid UUID)

Request Body schema: application/json

Request body containing updated template

Array of objects (models.ConfigItem)
name
string

See models.ApplicationConfigurationTemplate for more information.

Responses

Request samples

Content type
application/json
{
  • "config_items": [
    ],
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "config_items": [
    ],
  • "created_at": "string",
  • "data_service_id": "string",
  • "id": "string",
  • "name": "string",
  • "tenant_id": "string",
  • "updated_at": "string"
}

Delete ApplicationConfigurationTemplates

Removes a single ApplicationConfigurationTemplate

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

ApplicationConfigurationTemplate ID (must be valid UUID)

Responses

List ApplicationConfigurationTemplates

Lists ApplicationConfigurationTemplates

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Tenant ID (must be valid UUID)

query Parameters
sort_by
string

A given ApplicationConfigurationTemplates attribute to sort results by (one of: id, name, created_at)

limit
string

Maximum number of rows to return (could be less)

continuation
string

Use a token returned by a previous query to continue listing with the next batch of rows

id
string

Filter results by ApplicationConfigurationTemplates id

name
string

Filter results by ApplicationConfigurationTemplates name

data_service_id
string

Filter results by DataService ID

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Create ApplicationConfigurationTemplate

Creates a new ApplicationConfigurationTemplate

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Tenant ID (must be valid UUID)

Request Body schema: application/json

Request body containing the application configuration template

Array of objects (models.ConfigItem)
data_service_id
string
name
string

See models.ApplicationConfigurationTemplate for more information.

Responses

Request samples

Content type
application/json
{
  • "config_items": [
    ],
  • "data_service_id": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "config_items": [
    ],
  • "created_at": "string",
  • "data_service_id": "string",
  • "id": "string",
  • "name": "string",
  • "tenant_id": "string",
  • "updated_at": "string"
}

Authorizer

Authorize operation

Check if the provided operation is allowed

Authorizations:
ApiKeyAuth
Request Body schema: application/json

Request body containing the authorizer request

entity_id
string
entity_type
string
operation
string

Responses

Request samples

Content type
application/json
{
  • "entity_id": "string",
  • "entity_type": "string",
  • "operation": "string"
}

Response samples

Content type
application/json
{
  • "allow": true
}

BackupCredentials

Get BackupCredentials

Fetches a single BackupCredentials

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

BackupCredentials ID (must be valid UUID)

Responses

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "created_at": "string",
  • "id": "string",
  • "name": "string",
  • "tenant_id": "string",
  • "type": "azure",
  • "updated_at": "string"
}

Update BackupCredentials

Updates an existing instance of BackupCredentials

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

BackupCredentials ID (must be UUID)

Request Body schema: application/json

Request body containing the backup credentials config

object (controllers.Credentials)
name
string

Name of the backup credentials. Must be unique for the given tenant.

Responses

Request samples

Content type
application/json
{
  • "credentials": {
    },
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "created_at": "string",
  • "id": "string",
  • "name": "string",
  • "tenant_id": "string",
  • "type": "azure",
  • "updated_at": "string"
}

Delete BackupCredentials

Removes a single BackupCredential

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

BackupCredentials ID (must be valid UUID)

Responses

Get cloud configuration for BackupCredentials

Get cloud configuration for BackupCredentials

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

BackupCredentials ID (must be valid UUID)

Responses

Response samples

Content type
application/json
{
  • "azure": {
    },
  • "google": {
    },
  • "s3": {
    },
  • "s3_compatible": {
    }
}

List BackupCredentials

Lists BackupCredentials visible to the caller

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Tenant ID (must be valid UUID)

query Parameters
sort_by
string

A given BackupCredentials attribute to sort results by (one of: id, name, created_at)

limit
string

Maximum number of rows to return (could be less)

continuation
string

Use a token returned by a previous query to continue listing with the next batch of rows

id
string

Filter results by BackupCredentials id

name
string

Filter results by BackupCredentials name

type
string

Filter results by BackupCredentials type

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Create BackupCredentials

Creates a new BackupCredentials

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Tenant ID (must be valid UUID)

Request Body schema: application/json

Request body containing the backup credentials config

object (controllers.Credentials)
name
string

Name of the backup credentials. Must be unique for the given tenant.

Responses

Request samples

Content type
application/json
{
  • "credentials": {
    },
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "created_at": "string",
  • "id": "string",
  • "name": "string",
  • "tenant_id": "string",
  • "type": "azure",
  • "updated_at": "string"
}

BackupJobs

Get BackupJob

Fetches a BackupJob

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

BackupJob ID (must be valid UUID)

Responses

Response samples

Content type
application/json
{
  • "backup_capability": "string",
  • "backup_id": "string",
  • "backup_spec": { },
  • "cloud_credential_name": "string",
  • "cloud_snap_id": "string",
  • "completion_status": "Active",
  • "completion_time": "string",
  • "created_at": "string",
  • "data_service_spec": { },
  • "deployment_id": "string",
  • "deployment_target_id": "string",
  • "error_code": "JobFailed",
  • "error_message": "string",
  • "file_size": 0,
  • "id": "string",
  • "image_id": "string",
  • "name": "string",
  • "namespace_id": "string",
  • "project_id": "string",
  • "start_time": "string",
  • "timestamp": "string",
  • "updated_at": "string"
}

Upsert BackupJob

Updates a BackupJob if ID exists, Creates new BackupJob if not

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

BackupJob ID (must be UUID)

Request Body schema: application/json

Request body containing backup job details

backup_capability
string
backup_id
string
object
cloud_credential_name
string
cloud_snap_id
string
completion_status
string

CompletionStatus of the snapshot.

completion_time
string
object
deleted
boolean
deployment_id
string
deployment_target_id
string
error_code
string

ErrorCode if CompletionStatus is "Failed"

error_message
string
file_size
integer
image_name
string
name
string
namespace_name
string
project_id
required
string
start_time
string
timestamp
string

Responses

Request samples

Content type
application/json
{
  • "backup_capability": "string",
  • "backup_id": "string",
  • "backup_spec": { },
  • "cloud_credential_name": "string",
  • "cloud_snap_id": "string",
  • "completion_status": "string",
  • "completion_time": "string",
  • "data_service_spec": { },
  • "deleted": true,
  • "deployment_id": "string",
  • "deployment_target_id": "string",
  • "error_code": "string",
  • "error_message": "string",
  • "file_size": 0,
  • "image_name": "string",
  • "name": "string",
  • "namespace_name": "string",
  • "project_id": "string",
  • "start_time": "string",
  • "timestamp": "string"
}

Response samples

Content type
application/json
{
  • "backup_capability": "string",
  • "backup_id": "string",
  • "backup_spec": { },
  • "cloud_credential_name": "string",
  • "cloud_snap_id": "string",
  • "completion_status": "Active",
  • "completion_time": "string",
  • "created_at": "string",
  • "data_service_spec": { },
  • "deployment_id": "string",
  • "deployment_target_id": "string",
  • "error_code": "JobFailed",
  • "error_message": "string",
  • "file_size": 0,
  • "id": "string",
  • "image_id": "string",
  • "name": "string",
  • "namespace_id": "string",
  • "project_id": "string",
  • "start_time": "string",
  • "timestamp": "string",
  • "updated_at": "string"
}

Delete BackupJob

Removes a single BackupJob

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

BackupJob ID (must be valid UUID)

Responses

List Backup's Jobs

Retrieves a list of BackupJobs associated to this Backup

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Backup ID (must be valid UUID)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

List Project's BackupJobs

Lists the BackupJobs that belonging to the Project.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Project ID (must be valid UUID)

query Parameters
sort_by
string

A given BackupJob attribute to sort results by (one of: id, name, created_at)

limit
string

Maximum number of rows to return (could be less)

continuation
string

Use a token returned by a previous query to continue listing with the next batch of rows

id
string

Filter results by BackupJob id

deployment_id
string

Filter results by BackupJob deployment_id

deployment_target_id
string

Filter results by BackupJob deployment_target_id

backup_id
string

Filter results by BackupJob backup_id

name
string

Filter results by BackupJob name

namespace_id
string

Filter results by BackupJob namespace_id

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Restores

Start Restore

Starts restore of given BackupJob

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

BackupJob ID (must be valid UUID)

Request Body schema: application/json

Request body containing information about required restore

deployment_target_id
string
name
string
namespace_id
string

Responses

Request samples

Content type
application/json
{
  • "deployment_target_id": "string",
  • "name": "string",
  • "namespace_id": "string"
}

Response samples

Content type
application/json
{
  • "apply_status": "string",
  • "backup_job_id": "string",
  • "cloud_credential_name": "string",
  • "cloud_snap_id": "string",
  • "cluster_resource_name": "string",
  • "completion_time": "string",
  • "created_at": "string",
  • "deployment_id": "string",
  • "deployment_target_id": "string",
  • "error_code": "string",
  • "id": "string",
  • "name": "string",
  • "namespace_id": "string",
  • "start_time": "string",
  • "status": "string",
  • "timestamp": "string",
  • "updated_at": "string"
}

Restorability Matrix

Get Restorability Matrix

Authorizations:
ApiKeyAuth

Responses

Get Restore

Fetches a Restore

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Restore ID (must be valid UUID)

Responses

Response samples

Content type
application/json
{
  • "apply_status": "string",
  • "backup_job_id": "string",
  • "cloud_credential_name": "string",
  • "cloud_snap_id": "string",
  • "cluster_resource_name": "string",
  • "completion_time": "string",
  • "created_at": "string",
  • "deployment_id": "string",
  • "deployment_target_id": "string",
  • "error_code": "string",
  • "id": "string",
  • "name": "string",
  • "namespace_id": "string",
  • "start_time": "string",
  • "status": "string",
  • "timestamp": "string",
  • "updated_at": "string"
}

Retry Restore

Retry a Restore

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Restore ID (must be valid UUID)

Request Body schema: application/json

Request body containing information about required restore

deployment_target_id
string
name
string
namespace_id
string

Responses

Request samples

Content type
application/json
{
  • "deployment_target_id": "string",
  • "name": "string",
  • "namespace_id": "string"
}

Update Restore

Updates a Restore

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Restore ID (must be valid UUID)

Request Body schema: application/json

Request body containing the update

completion_status
string

Status of the restore process on the Target Cluster

completion_time
string

CompletionTime of the restore process.

error_code
string

Error code of the restore from Target Cluster

start_time
string

StartTime of the restore process.

timestamp
string

Timestamp of the update data.

Responses

Request samples

Content type
application/json
{
  • "completion_status": "string",
  • "completion_time": "string",
  • "error_code": "string",
  • "start_time": "string",
  • "timestamp": "string"
}

BackupPolicies

Get BackupPolicy

Fetches a single BackupPolicy

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

BackupPolicy ID (must be valid UUID)

Responses

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "created_at": "string",
  • "id": "string",
  • "name": "string",
  • "schedules": [
    ],
  • "tenant_id": "string",
  • "updated_at": "string"
}

Update BackupPolicy

Updates existing BackupPolicy

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

BackupPolicy ID (must be valid UUID)

Request Body schema: application/json

Request body containing updated backup policy

name
string

Name of the backup policy. Must be unique for the given tenant.

Array of objects (models.BackupSchedule)

An array of the backup schedules. Must be non-empty.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "schedules": [
    ]
}

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "created_at": "string",
  • "id": "string",
  • "name": "string",
  • "schedules": [
    ],
  • "tenant_id": "string",
  • "updated_at": "string"
}

Delete BackupPolicies

Removes a single BackupPolicy

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

BackupPolicy ID (must be valid UUID)

Responses

List BackupPolicies

Lists BackupPolicies

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Tenant ID (must be valid UUID)

query Parameters
sort_by
string

A given BackupPolicy attribute to sort results by (one of: id, name, created_at)

limit
string

Maximum number of rows to return (could be less)

continuation
string

Use a token returned by a previous query to continue listing with the next batch of rows

id
string

Filter results by BackupPolicy id

name
string

Filter results by BackupPolicy name

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Create BackupPolicy

Creates a new BackupPolicy

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Tenant ID (must be valid UUID)

Request Body schema: application/json

Request body containing the backup policy

name
string

Name of the backup policy. Must be unique for the given tenant.

Array of objects (models.BackupSchedule)

An array of the backup schedules. Must be non-empty.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "schedules": [
    ]
}

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "created_at": "string",
  • "id": "string",
  • "name": "string",
  • "schedules": [
    ],
  • "tenant_id": "string",
  • "updated_at": "string"
}

BackupTargets

Get BackupTarget

Fetches a single BackupTarget

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

BackupTarget ID (must be valid UUID)

Responses

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "backup_credentials_id": "string",
  • "bucket": "string",
  • "created_at": "string",
  • "id": "string",
  • "name": "string",
  • "region": "string",
  • "tenant_id": "string",
  • "type": "azure",
  • "updated_at": "string"
}

Update BackupTarget

Updates existing BackupTarget

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

BackupTarget ID (must be valid UUID)

Request Body schema: application/json

Object with partial update fields

name
string

Name of the backup target. Must be unique for the given tenant.

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "backup_credentials_id": "string",
  • "bucket": "string",
  • "created_at": "string",
  • "id": "string",
  • "name": "string",
  • "region": "string",
  • "tenant_id": "string",
  • "type": "azure",
  • "updated_at": "string"
}

Delete BackupTargets

Removes a single BackupTarget

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

BackupTarget ID (must be valid UUID)

query Parameters
force
string

Delete backup target even if the deletion job fails on any deployment targets

Responses

Retry sync of a BackupTarget

Retries to sync failed BackupTargetState

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

BackupTargetState ID (must be valid UUID)

Responses

List BackupTarget's BackupTargetStates

Lists BackupTarget's BackupTargetStates

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Backup Target ID (must be valid UUID)

query Parameters
limit
string

Maximum number of rows to return (could be less)

continuation
string

Use a token returned by a previous query to continue listing with the next batch of rows

sort_by
string

A given BackupTargetState attribute to sort results by (one of: state, deployment_target_id, backup_target_id)

backup_target_id
string

Filter results by BackupTarget ID

deployment_target_id
string

Filter results by DeploymentTarget ID

state
string

Filter results by state

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

List Project's BackupTargets

Lists BackupTargets belonging to the Project

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Project ID (must be valid UUID)

query Parameters
sort_by
string

A given BackupTarget attribute to sort results by (one of: id, name, type, created_at)

limit
string

Maximum number of rows to return (could be less)

continuation
string

Use a token returned by a previous query to continue listing with the next batch of rows

id
string

Filter results by BackupTarget ID

name
string

Filter results by BackupTarget name

type
string

Filter results by BackupTarget type

bucket
string

Filter results by bucket

region
string

Filter results by region

deployment_target_id
string

Filter results by deployment ID where the backup target is available.

backup_credentials_id
string

Filter results by BackupCredentials ID

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

List Tenant's BackupTargets

Lists Tenant's BackupTargets

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Tenant ID (must be valid UUID)

query Parameters
limit
string

Maximum number of rows to return (could be less)

continuation
string

Use a token returned by a previous query to continue listing with the next batch of rows

sort_by
string

A given BackupTarget attribute to sort results by (one of: id, name, type, created_at)

id
string

Filter results by BackupTarget ID

name
string

Filter results by BackupTarget name

type
string

Filter results by BackupTarget type

bucket
string

Filter results by bucket

region
string

Filter results by region

backup_credentials_id
string

Filter results by BackupCredentials ID

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Create BackupTarget

Creates a new BackupTarget

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Tenant ID (must be valid UUID)

Request Body schema: application/json

Request body containing the backup target config

backup_credentials_id
string
bucket
string

Bucket name for S3 or S3 compatible. Container name for Azure.

name
string

Name of the backup target. Must be unique for the given tenant.

region
string

Region of the bucket. Required for S3. Otherwise must be empty.

type
string

Type of the backup target. Must match the used backup credentials.

Responses

Request samples

Content type
application/json
{
  • "backup_credentials_id": "string",
  • "bucket": "string",
  • "name": "string",
  • "region": "string",
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "backup_credentials_id": "string",
  • "bucket": "string",
  • "created_at": "string",
  • "id": "string",
  • "name": "string",
  • "region": "string",
  • "tenant_id": "string",
  • "type": "azure",
  • "updated_at": "string"
}

Backups

List BackupTarget's Backups

Lists Backups belonging to the BackupTarget.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

BackupTarget ID (must be valid UUID)

query Parameters
sort_by
string

A given Backup attribute to sort results by (one of: id, cluster_resource_name, created_at, backup_type, backup_level)

limit
string

Maximum number of rows to return (could be less)

continuation
string

Use a token returned by a previous query to continue listing with the next batch of rows

id
string

Filter results by Backup id

cluster_resource_name
string

Filter results by Backup cluster_resource_name

state
string

Filter results by Backup state

suspend
string

Filter results by Backup suspend flag

backup_type
string

Filter results by Backup type (one of: adhoc,scheduled)

backup_level
string

Filter results by Backup type (one of: snapshot,incremental)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Get Backup

Fetches a single Backup

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Backup ID (must be a valid UUID)

Responses

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "backup_level": "snapshot",
  • "backup_target_id": "string",
  • "backup_type": "adhoc",
  • "cluster_resource_name": "string",
  • "created_at": "string",
  • "data_service_id": "string",
  • "deployment_id": "string",
  • "deployment_name": "string",
  • "deployment_target_id": "string",
  • "id": "string",
  • "job_history_limit": 0,
  • "namespace_id": "string",
  • "project_id": "string",
  • "reclaim_policy": "retain",
  • "schedule": "string",
  • "state": "created",
  • "suspend": true,
  • "tenant_id": "string",
  • "updated_at": "string"
}

Update Backup

Updates an existing database Backup

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Backup ID (must be UUID)

header Parameters
Local-Only
boolean

Set to true to only update the Backup object in the database (does not create any actual resources)

Request Body schema: application/json

Request body containing updated backup

job_history_limit
integer

Responses

Request samples

Content type
application/json
{
  • "job_history_limit": 0
}

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "backup_level": "snapshot",
  • "backup_target_id": "string",
  • "backup_type": "adhoc",
  • "cluster_resource_name": "string",
  • "created_at": "string",
  • "data_service_id": "string",
  • "deployment_id": "string",
  • "deployment_name": "string",
  • "deployment_target_id": "string",
  • "id": "string",
  • "job_history_limit": 0,
  • "namespace_id": "string",
  • "project_id": "string",
  • "reclaim_policy": "retain",
  • "schedule": "string",
  • "state": "created",
  • "suspend": true,
  • "tenant_id": "string",
  • "updated_at": "string"
}

Delete Backup

Deletes an existing database deployment Backup

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Backup ID (must be a valid UUID)

header Parameters
Local-Only
boolean

Set to true to only delete the Backup object in the database (does not delete any actual resources)

Responses

Delete Backup jobs

Deletes an existing job for scheduled backups

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Backup ID (must be a valid UUID)

name
required
string

Backup job name

header Parameters
Local-Only
boolean

Set to true to only delete the Backup object in the database (does not delete any actual resources)

Responses

List Deployment's Backups

Lists Backups belonging to the Deployment.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Deployment ID (must be valid UUID)

query Parameters
sort_by
string

A given Backup attribute to sort results by (one of: id, cluster_resource_name, created_at, backup_type, backup_level)

limit
string

Maximum number of rows to return (could be less)

continuation
string

Use a token returned by a previous query to continue listing with the next batch of rows

id
string

Filter results by Backup id

cluster_resource_name
string

Filter results by Backup cluster_resource_name

state
string

Filter results by Backup state

suspend
string

Filter results by Backup suspend flag

backup_type
string

Filter results by Backup type (one of: adhoc,scheduled)

backup_level
string

Filter results by Backup type (one of: snapshot,incremental)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Create Backup

Creates a new database Backup

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Deployment ID (must be valid UUID)

header Parameters
Local-Only
boolean

Set to true to only create the Backup object in the database (does not create any actual resources)

Request Body schema: application/json

Request body containing the backup config

backup_level
string
backup_target_id
string
backup_type
string
job_history_limit
integer
schedule
string

Responses

Request samples

Content type
application/json
{
  • "backup_level": "snapshot or incremental",
  • "backup_target_id": "string",
  • "backup_type": "adhoc or scheduled",
  • "job_history_limit": 0,
  • "schedule": "in CRON format, required for scheduled backups"
}

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "backup_level": "snapshot",
  • "backup_target_id": "string",
  • "backup_type": "adhoc",
  • "cluster_resource_name": "string",
  • "created_at": "string",
  • "data_service_id": "string",
  • "deployment_id": "string",
  • "deployment_name": "string",
  • "deployment_target_id": "string",
  • "id": "string",
  • "job_history_limit": 0,
  • "namespace_id": "string",
  • "project_id": "string",
  • "reclaim_policy": "retain",
  • "schedule": "string",
  • "state": "created",
  • "suspend": true,
  • "tenant_id": "string",
  • "updated_at": "string"
}

Versions

List compatible versions

Lists what versions are compatible for other versions.

Authorizations:
ApiKeyAuth
query Parameters
data_service_id
string

Filter results by data_service_id

version_id
string

Filter results by version_id

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

List Data Service's Versions

Lists Versions belonging to the Data Service.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Data Service ID (must be valid UUID)

query Parameters
sort_by
string

A given Version attribute to sort results by (one of: id, name, created_at)

limit
string

Maximum number of rows to return (could be less)

continuation
string

Use a token returned by a previous query to continue listing with the next batch of rows

id
string

Filter results by Version id

name
string

Filter results by Version's name

enabled
boolean

Filter results by Version's enabled parameter

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Get Version

Fetches a single Version

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Version ID (must be valid UUID)

Responses

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "data_service_id": "string",
  • "enabled": true,
  • "id": "string",
  • "name": "string",
  • "updated_at": "string"
}

Copilot

Search Database query

Generates a response for database query for different databases

Authorizations:
ApiKeyAuth
Request Body schema: application/json

Request body containing the search config

data_service_id
string
query
string

TODO: fix example query with best query

Responses

Request samples

Content type
application/json
{
  • "data_service_id": "string",
  • "query": "how to list all records of table employee."
}

Response samples

Content type
application/json
{
  • "data_service_id": "string",
  • "id": "string",
  • "query": "string",
  • "response": "string",
  • "response_time": "string"
}

DataServices

List Data Services

Lists Data Services

Authorizations:
ApiKeyAuth
query Parameters
sort_by
string

A given Data Service attribute to sort results by (one of: id, name, short_name, created_at)

limit
string

Maximum number of rows to return (could be less)

continuation
string

Use a token returned by a previous query to continue listing with the next batch of rows

id
string

Filter results by Data Service ID

name
string

Filter results by Data Service name

short_name
string

Filter results by Data Service short name

has_incremental_backup
boolean

Filter results based on incremental backup eligibility

has_full_backup
boolean

Filter results based on vault full backup eligibility

coming_soon
boolean

Filter results based on 'Coming soon' flag

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Get Data Service

Fetches a single Data Service

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Data Service ID (must be a valid UUID)

Responses

Response samples

Content type
application/json
{
  • "coming_soon": true,
  • "created_at": "string",
  • "has_full_backup": true,
  • "has_incremental_backup": true,
  • "id": "string",
  • "name": "string",
  • "node_restrictions": {
    },
  • "nodes_limitations": "string",
  • "short_name": "string",
  • "updated_at": "string"
}

Tasks

Get Task

Fetches a database Task

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Task ID (must be valid UUID)

Responses

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "associated_resource": "string",
  • "created_at": "string",
  • "current_step": 0,
  • "description": "string",
  • "id": 0,
  • "log": [
    ],
  • "project_id": "string",
  • "status": "string",
  • "tenant_id": "string",
  • "total_steps": 0,
  • "updated_at": "string"
}

SampleTemplates

List ApplicationConfigurationSamples

Lists ApplicationConfigurationSamples

Authorizations:
ApiKeyAuth
query Parameters
data_service_id
string

Filter results by DataService ID

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

List BackupPolicySamples

Lists BackupPolicySamples

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

List ResourceSettingsSamples

Lists ResourceSettingsSamples

Authorizations:
ApiKeyAuth
query Parameters
data_service_id
string

Filter results by DataService ID

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

List StorageOptionsSamples

Lists StorageOptionsSamples

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

DeploymentTargets

Get DeploymentTarget

Fetches a single DeploymentTarget

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

DeploymentTarget ID (must be valid UUID)

Responses

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "capabilities": {
    },
  • "cluster_id": "string",
  • "connection_status": "string",
  • "created_at": "string",
  • "id": "string",
  • "last_health_check": "string",
  • "last_operator_heartbeat": "string",
  • "metadata": {
    },
  • "name": "string",
  • "status": "string",
  • "teleport_agent_version": "string",
  • "tenant_id": "string",
  • "tls_issuer": "string",
  • "tls_required": true,
  • "updated_at": "string"
}

Update DeploymentTarget Deprecated

Deprecated, use PATCH /api/deployment-targets/{id} instead

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

DeploymentTarget ID (must be valid UUID)

Request Body schema: application/json

Object with partial update fields (name)

name
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "capabilities": {
    },
  • "cluster_id": "string",
  • "connection_status": "string",
  • "created_at": "string",
  • "id": "string",
  • "last_health_check": "string",
  • "last_operator_heartbeat": "string",
  • "metadata": {
    },
  • "name": "string",
  • "status": "string",
  • "teleport_agent_version": "string",
  • "tenant_id": "string",
  • "tls_issuer": "string",
  • "tls_required": true,
  • "updated_at": "string"
}

Delete DeploymentTarget

Deletes a single DeploymentTarget.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

DeploymentTarget ID (must be valid UUID)

Responses

Patch DeploymentTarget

Patches existing DeploymentTarget

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

DeploymentTarget ID (must be valid UUID)

Request Body schema: application/json

Object with partial update fields (name, tlsRequired, tlsIssuer)

name
string
tls_issuer
string
tls_required
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "tls_issuer": "string",
  • "tls_required": true
}

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "capabilities": {
    },
  • "cluster_id": "string",
  • "connection_status": "string",
  • "created_at": "string",
  • "id": "string",
  • "last_health_check": "string",
  • "last_operator_heartbeat": "string",
  • "metadata": {
    },
  • "name": "string",
  • "status": "string",
  • "teleport_agent_version": "string",
  • "tenant_id": "string",
  • "tls_issuer": "string",
  • "tls_required": true,
  • "updated_at": "string"
}

Patch DeploymentTarget agent-metadata

Patches the DeploymentTarget agent-metadata

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

DeploymentTarget ID (must be valid UUID)

Request Body schema: application/json

Object with target cluster ID

kube_api_version
string
kube_platform
string
pds_chart_version
string
px_csi_enabled
string
px_service_namespace
string
px_version
string
teleport_agent_version
string

Responses

Request samples

Content type
application/json
{
  • "kube_api_version": "string",
  • "kube_platform": "string",
  • "pds_chart_version": "string",
  • "px_csi_enabled": "string",
  • "px_service_namespace": "string",
  • "px_version": "string",
  • "teleport_agent_version": "string"
}

Get configuration values for a DeploymentTarget

Fetches the config values for a DeploymentTarget

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

DeploymentTarget ID (must be valid UUID)

Responses

Response samples

Content type
application/json
{
  • "observability_url": "string",
  • "teleport_ca_pin": "string",
  • "teleport_join_token": "string",
  • "teleport_proxy_addr": "string"
}

Get join credentials of a DeploymentTarget Deprecated

Deprecated, use GET /api/deployment-targets/{id}/config instead

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

DeploymentTarget ID (must be valid UUID)

Responses

Response samples

Content type
application/json
{
  • "teleport_ca_pin": "string",
  • "teleport_join_token": "string",
  • "teleport_proxy_addr": "string"
}

Make DeploymentTarget heart beat request

Makes control plane aware that DeploymentTarget is still alive

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

DeploymentTarget ID (must be valid UUID)

Request Body schema: application/json

Object with target cluster ID

cluster_id
string

Responses

Request samples

Content type
application/json
{
  • "cluster_id": "string"
}

Response samples

Content type
application/json
{
  • "cluster_id": "string",
  • "name": "string"
}

Update DeploymentTarget metadata Deprecated

Handles DeploymentTarget metadata created by PDS/Platform agent Deprecated, Use PATCH api/deployment-targets/{id}/agent-metadata instead

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

DeploymentTarget ID (must be valid UUID)

Request Body schema: application/json

Object with target cluster ID

cluster_id
string
kube_api_version
string
kube_platform
string
Enum: "unknown" "aws" "azure" "gcp" "ocp" "generic"
pds_chart_version
string
px_csi_enabled
string
Enum: "unknown" "yes" "no"
px_service_namespace
string
px_version
string

Responses

Request samples

Content type
application/json
{
  • "cluster_id": "string",
  • "kube_api_version": "string",
  • "kube_platform": "unknown",
  • "pds_chart_version": "string",
  • "px_csi_enabled": "unknown",
  • "px_service_namespace": "string",
  • "px_version": "string"
}

Make DeploymentTarget operator heart beat request

Makes control plane aware that DeploymentTarget's operator is still alive

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

DeploymentTarget ID (must be valid UUID)

Request Body schema: application/json

Object with target cluster ID

cluster_id
string

Responses

Request samples

Content type
application/json
{
  • "cluster_id": "string"
}

Response samples

Content type
application/json
{
  • "cluster_id": "string",
  • "name": "string"
}

Update target operator metadata

Handles DeploymentTarget metadata created by target operator

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

DeploymentTarget ID (must be valid UUID)

Request Body schema: application/json

Body with the new metadata.

cluster_id
string
pds_features
string
pds_operator_version
string
px_status
string

Responses

Request samples

Content type
application/json
{
  • "cluster_id": "string",
  • "pds_features": "string",
  • "pds_operator_version": "string",
  • "px_status": "string"
}

Update target capabilities

Updates the set of capabilities supported by the deployment target

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

DeploymentTarget ID (must be valid UUID)

Request Body schema: application/json

Body containing supported capabilities versions (must be valid semver).

backup
string
capabilities
string
cassandra
string
consul
string
couchbase
string
crd_reporting
string
data_service_tls
string
database
string
elasticsearch
string
event_reporting
string
kafka
string
mongodb
string
mysql
string
postgresql
string
rabbitmq
string
redis
string
restore
string
sqlserver
string
storage_size_increase
string
zookeeper
string

Responses

Request samples

Content type
application/json
{
  • "backup": "string",
  • "capabilities": "string",
  • "cassandra": "string",
  • "consul": "string",
  • "couchbase": "string",
  • "crd_reporting": "string",
  • "data_service_tls": "string",
  • "database": "string",
  • "elasticsearch": "string",
  • "event_reporting": "string",
  • "kafka": "string",
  • "mongodb": "string",
  • "mysql": "string",
  • "postgresql": "string",
  • "rabbitmq": "string",
  • "redis": "string",
  • "restore": "string",
  • "sqlserver": "string",
  • "storage_size_increase": "string",
  • "zookeeper": "string"
}

List Project's DeploymentTargets

Lists DeploymentTargets belonging to the Project

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Project ID (must be valid UUID)

query Parameters
sort_by
string

A given DeploymentTarget attribute to sort results by (one of: id, name)

limit
string

Maximum number of rows to return (could be less)

continuation
string

Use a token returned by a previous query to continue listing with the next batch of rows

id
string

Filter results by DeploymentTarget ID

cluster_id
string

Filter results by Cluster ID

name
string

Filter results by DeploymentTarget name

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

List Tenant's DeploymentTargets

Lists Tenant's DeploymentTargets

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Tenant ID (must be valid UUID)

query Parameters
sort_by
string

A given DeploymentTarget attribute to sort results by (one of: id, name, created_at)

limit
string

Maximum number of rows to return (could be less)

continuation
string

Use a token returned by a previous query to continue listing with the next batch of rows

id
string

Filter results by DeploymentTarget ID

cluster_id
string

Filter results by Cluster ID

name
string

Filter results by DeploymentTarget name

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Create DeploymentTarget

Creates a new DeploymentTarget

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Tenant ID (must be valid UUID)

Request Body schema: application/json

Request body containing the deployment target config

cluster_id
string
name
string
teleport_agent_version
string
tls_issuer
string
tls_required
boolean

Responses

Request samples

Content type
application/json
{
  • "cluster_id": "string",
  • "name": "string",
  • "teleport_agent_version": "string",
  • "tls_issuer": "string",
  • "tls_required": true
}

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "capabilities": {
    },
  • "cluster_id": "string",
  • "connection_status": "string",
  • "created_at": "string",
  • "id": "string",
  • "last_health_check": "string",
  • "last_operator_heartbeat": "string",
  • "metadata": {
    },
  • "name": "string",
  • "status": "string",
  • "teleport_agent_version": "string",
  • "tenant_id": "string",
  • "tls_issuer": "string",
  • "tls_required": true,
  • "updated_at": "string"
}

Events

Adds k8s generated events for a deployment

Adds one or more k8s generated events from deployments

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

DeploymentTarget ID (must be valid UUID)

Request Body schema: application/json

Request body containing list of events

required
Array of objects (requests.DeploymentEvent)
Array
deployment_id
required
string

DeploymentID of the event.

required
Array of objects (requests.K8sEvent)

List of k8s events for the deployment

namespace
required
string

Namespace in which the deployment events were generated.

Responses

Request samples

Content type
application/json
{
  • "events": [
    ]
}

Get the timestamp of the latest event

Gets the timestamp of the latest event for the deployment target

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

DeploymentTarget ID (must be valid UUID)

Responses

Response samples

Content type
application/json
{
  • "timestamp": 0
}

Get Deployment Events

Retrieves events of the given Deployment

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Deployment ID (must be valid UUID)

Responses

Namespaces

List DeploymentTarget's Namespaces

List DeploymentTarget's Namespaces

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

DeploymentTarget ID (must be valid UUID)

query Parameters
sort_by
string

A given Namespace attribute to sort results by (one of: id, name, created_at)

limit
string

Maximum number of rows to return (could be less)

continuation
string

Use a token returned by a previous query to continue listing with the next batch of rows

id
string

Filter results by Namespace ID

name
string

Filter results by Namespace name

status
string

Filter results by Namespace status

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Create Namespace

Creates a new Namespace

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

DeploymentTarget ID (must be valid UUID)

Request Body schema: application/json

Request body containing the new namespace

name
string

Name of the namespace

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "created_at": "string",
  • "deployment_target_id": "string",
  • "id": "string",
  • "name": "string",
  • "status": "string",
  • "tenant_id": "string",
  • "updated_at": "string"
}

Get Namespace

Fetches a single Namespace

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Namespace ID (must be valid UUID)

Responses

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "created_at": "string",
  • "deployment_target_id": "string",
  • "id": "string",
  • "name": "string",
  • "status": "string",
  • "tenant_id": "string",
  • "updated_at": "string"
}

Update namespace

Update namespace

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Namespace ID (must be valid UUID)

Request Body schema: application/json

Object with partial update of fields (status)

status
string

Responses

Request samples

Content type
application/json
{
  • "status": "string"
}

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "created_at": "string",
  • "deployment_target_id": "string",
  • "id": "string",
  • "name": "string",
  • "status": "string",
  • "tenant_id": "string",
  • "updated_at": "string"
}

Delete Namespace

Deletes a single Namespace.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Namespace ID (must be valid UUID)

Responses

Deployments

Create Deployment

Creates a new data service Deployment

Authorizations:
ApiKeyAuth
header Parameters
Local-Only
boolean

Set to true to only create the Deployment object in the database (does not create any actual resources)

Request Body schema: application/json

Request body containing the deployment config

object
application_configuration_template_id
string
deployment_target_id
string
dns_zone
string
image_id
string
load_balancer_source_ranges
Array of strings
name
string
namespace_id
string
node_count
integer
resource_settings_template_id
string
object (requests.DeploymentScheduledBackup)
service_type
string
storage_options_template_id
string
tls_enabled
boolean

Responses

Request samples

Content type
application/json
{
  • "application_configuration_overrides": {
    },
  • "application_configuration_template_id": "string",
  • "deployment_target_id": "string",
  • "dns_zone": "string",
  • "image_id": "string",
  • "load_balancer_source_ranges": [
    ],
  • "name": "my-service",
  • "namespace_id": "string",
  • "node_count": 3,
  • "resource_settings_template_id": "string",
  • "scheduled_backup": {
    },
  • "service_type": "string",
  • "storage_options_template_id": "string",
  • "tls_enabled": true
}

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "cluster_resource_name": "string",
  • "configuration": { },
  • "connection_details": { },
  • "created_at": "string",
  • "data_service_id": "string",
  • "deployment_manifest": {
    },
  • "deployment_target": {
    },
  • "deployment_target_id": "string",
  • "dns_zone": "string",
  • "error": {
    },
  • "id": "string",
  • "image_id": "string",
  • "initialize": "Once",
  • "load_balancer_source_ranges": [
    ],
  • "name": "string",
  • "namespace": {
    },
  • "namespace_id": "string",
  • "node_count": 0,
  • "project_id": "string",
  • "resources": {
    },
  • "restore": {
    },
  • "restore_id": "string",
  • "service_type": "ClusterIP",
  • "state": "created",
  • "storage_options": {
    },
  • "tenant_id": "string",
  • "tls_enabled": true,
  • "tls_issuer": "string",
  • "updated_at": "string",
  • "version_id": "string"
}

Get Deployment

Fetches a data service Deployment

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Deployment ID (either id or deployment_id field)

query Parameters
expand
string

Expand the result with related entities (allowed values: deployment_target, namespace, deployment_manifest)

Responses

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "cluster_resource_name": "string",
  • "configuration": { },
  • "connection_details": { },
  • "created_at": "string",
  • "data_service_id": "string",
  • "deployment_manifest": {
    },
  • "deployment_target": {
    },
  • "deployment_target_id": "string",
  • "dns_zone": "string",
  • "error": {
    },
  • "id": "string",
  • "image_id": "string",
  • "initialize": "Once",
  • "load_balancer_source_ranges": [
    ],
  • "name": "string",
  • "namespace": {
    },
  • "namespace_id": "string",
  • "node_count": 0,
  • "project_id": "string",
  • "resources": {
    },
  • "restore": {
    },
  • "restore_id": "string",
  • "service_type": "ClusterIP",
  • "state": "created",
  • "storage_options": {
    },
  • "tenant_id": "string",
  • "tls_enabled": true,
  • "tls_issuer": "string",
  • "updated_at": "string",
  • "version_id": "string"
}

Update Deployment

Updates an existing database Deployment

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Deployment ID (must be valid UUID)

header Parameters
Local-Only
boolean

Set to true to only update the Deployment object in the database (does not create any actual resources)

Request Body schema: application/json

Request body containing the updated deployment config

object
application_configuration_template_id
string
image_id
string
node_count
integer
resource_settings_template_id
string
object (requests.UpdateDeploymentScheduledBackup)
tls_enabled
boolean

Responses

Request samples

Content type
application/json
{
  • "application_configuration_overrides": {
    },
  • "application_configuration_template_id": "string",
  • "image_id": "string",
  • "node_count": 3,
  • "resource_settings_template_id": "string",
  • "scheduled_backup": {
    },
  • "tls_enabled": true
}

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "cluster_resource_name": "string",
  • "configuration": { },
  • "connection_details": { },
  • "created_at": "string",
  • "data_service_id": "string",
  • "deployment_manifest": {
    },
  • "deployment_target": {
    },
  • "deployment_target_id": "string",
  • "dns_zone": "string",
  • "error": {
    },
  • "id": "string",
  • "image_id": "string",
  • "initialize": "Once",
  • "load_balancer_source_ranges": [
    ],
  • "name": "string",
  • "namespace": {
    },
  • "namespace_id": "string",
  • "node_count": 0,
  • "project_id": "string",
  • "resources": {
    },
  • "restore": {
    },
  • "restore_id": "string",
  • "service_type": "ClusterIP",
  • "state": "created",
  • "storage_options": {
    },
  • "tenant_id": "string",
  • "tls_enabled": true,
  • "tls_issuer": "string",
  • "updated_at": "string",
  • "version_id": "string"
}

Delete Deployment

Deletes an existing database Deployment

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Deployment ID (must be a valid UUID)

query Parameters
force
string

Delete deployment even if the deletion job fails on any deployment targets

Responses

Deployment Connection Information

Returns connection information for the given Deployment

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Deployment ID (must be valid UUID)

Responses

Deployment Credentials

Returns credentials to authenticate to the given Deployment

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Deployment ID (must be valid UUID)

Responses

Get Deployment Status

Retrieves status information on the given Deployment

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Deployment ID (must be valid UUID)

Responses

List Project's Deployments

Lists Deployments belonging to the Project.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Project ID (must be valid UUID)

query Parameters
expand
string

Expand the result with related entities (allowed values: deployment_target, namespace)

sort_by
string

A given Deployment attribute to sort results by (one of: id, name, cluster_resource_name, created_at)

limit
string

Maximum number of rows to return (could be less)

continuation
string

Use a token returned by a previous query to continue listing with the next batch of rows

id
string

Filter results by Deployment id

cluster_resource_name
string

Filter results by Deployment cluster_resource_name

data_service_id
string

Filter results by Deployment data_service_id

deployment_target_id
string

Filter results by Deployment deployment_target_id

image_id
string

Filter results by Deployment image_id

name
string

Filter results by Deployment name

namespace_id
string

Filter results by Deployment namespace_id

state
string

Filter results by Deployment state

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Create Deployment

Creates a new data service Deployment

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Project ID (must be valid UUID)

header Parameters
Local-Only
boolean

Set to true to only create the Deployment object in the database (does not create any actual resources)

Request Body schema: application/json

Request body containing the deployment config

object
application_configuration_template_id
string
deployment_target_id
string
dns_zone
string
image_id
string
load_balancer_source_ranges
Array of strings
name
string
namespace_id
string
node_count
integer
resource_settings_template_id
string
object (requests.DeploymentScheduledBackup)
service_type
string
storage_options_template_id
string
tls_enabled
boolean

Responses

Request samples

Content type
application/json
{
  • "application_configuration_overrides": {
    },
  • "application_configuration_template_id": "string",
  • "deployment_target_id": "string",
  • "dns_zone": "string",
  • "image_id": "string",
  • "load_balancer_source_ranges": [
    ],
  • "name": "my-service",
  • "namespace_id": "string",
  • "node_count": 3,
  • "resource_settings_template_id": "string",
  • "scheduled_backup": {
    },
  • "service_type": "string",
  • "storage_options_template_id": "string",
  • "tls_enabled": true
}

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "cluster_resource_name": "string",
  • "configuration": { },
  • "connection_details": { },
  • "created_at": "string",
  • "data_service_id": "string",
  • "deployment_manifest": {
    },
  • "deployment_target": {
    },
  • "deployment_target_id": "string",
  • "dns_zone": "string",
  • "error": {
    },
  • "id": "string",
  • "image_id": "string",
  • "initialize": "Once",
  • "load_balancer_source_ranges": [
    ],
  • "name": "string",
  • "namespace": {
    },
  • "namespace_id": "string",
  • "node_count": 0,
  • "project_id": "string",
  • "resources": {
    },
  • "restore": {
    },
  • "restore_id": "string",
  • "service_type": "ClusterIP",
  • "state": "created",
  • "storage_options": {
    },
  • "tenant_id": "string",
  • "tls_enabled": true,
  • "tls_issuer": "string",
  • "updated_at": "string",
  • "version_id": "string"
}

DeploymentManifests

Post DeploymentManifest

Upsert On Deployment Manifest Always returns the record with higher timestamp with given DeploymentID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Deployment ID (must be valid UUID)

Request Body schema: application/json

Body with the Deployment Manifest

deleted
boolean
object
timestamp
string

Responses

Request samples

Content type
application/json
{
  • "deleted": true,
  • "manifest": { },
  • "timestamp": "string"
}

GlobalRoleBindings

List GlobalRoleBindings

Lists GlobalRoleBindings

Authorizations:
ApiKeyAuth
query Parameters
sort_by
string

A given GlobalRoleBinding attribute to sort results by (one of: role_name, actor_id)

role_name
string

Filter results by GlobalRoleBinding assigned role name

actor_id
string

Filter results by GlobalRoleBinding actor id

actor_type
string

Filter results by GlobalRoleBinding actor type

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Set GlobalRoleBinding

Creates a new GlobalRoleBinding

Authorizations:
ApiKeyAuth
Request Body schema: application/json

Request body containing the global role binding

actor_id
string
actor_type
string
role_name
string

Responses

Request samples

Content type
application/json
{
  • "actor_id": "ID of the role subject",
  • "actor_type": "Type of the role subject",
  • "role_name": "Name of the assigned role"
}

Response samples

Content type
application/json
{
  • "actor_id": "string",
  • "actor_type": "string",
  • "role_name": "string"
}

Delete GlobalRoleBinding

Removes a single GlobalRoleBindings

Authorizations:
ApiKeyAuth
Request Body schema: application/json

Request body containing the global role binding

actor_id
string
actor_type
string

Responses

Request samples

Content type
application/json
{
  • "actor_id": "string",
  • "actor_type": "string"
}

Images

List Images

Lists Images

Authorizations:
ApiKeyAuth
query Parameters
data_service_id
string

Filter results by data_service_id

version_id
string

Filter results by version_id

latest
boolean

Only include the latest image for each version_id.

sort_by
string

A given Image attribute to sort results by (one of: id, name, created_at). Ignored when latest=true.

limit
string

Maximum number of rows to return (could be less). Ignored when latest=true.

continuation
string

Use a token returned by a previous query to continue listing with the next batch of rows. Ignored when latest=true.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Get Image

Fetches a single Image

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Image ID (must be valid UUID)

Responses

Response samples

Content type
application/json
{
  • "build": "string",
  • "capabilities": { },
  • "created_at": "string",
  • "data_service_id": "string",
  • "id": "string",
  • "images": {
    },
  • "name": "string",
  • "namespace": "string",
  • "registry": "string",
  • "tag": "string",
  • "tls_available": true,
  • "updated_at": "string",
  • "version_id": "string"
}

List Version's Images

Lists Images belonging to a Version.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Version ID (must be valid UUID)

query Parameters
sort_by
string

A given Image attribute to sort results by (one of: id, name, created_at)

limit
string

Maximum number of rows to return (could be less)

continuation
string

Use a token returned by a previous query to continue listing with the next batch of rows

id
string

Filter results by Image id

name
string

Filter results by Image's name

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Metadata

Get metadata information

Get metadata about this server

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "features": {
    },
  • "helm_chart_version": "Helm chart version",
  • "pds_build_number": 0
}

Projects

Get Project

Fetches a single Project

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Project ID (must be valid UUID)

Responses

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "created_at": "string",
  • "id": "string",
  • "name": "string",
  • "tenant_id": "string",
  • "updated_at": "string"
}

List Tenant's Projects

Lists Projects belonging to the Tenant.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Tenant ID (must be valid UUID)

query Parameters
sort_by
string

A given Project attribute to sort results by (one of: id, name, created_at)

limit
string

Maximum number of rows to return (could be less)

continuation
string

Use a token returned by a previous query to continue listing with the next batch of rows

id
string

Filter results by Project id

name
string

Filter results by Project name

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

ProjectRoleBindings

List ProjectRoleBindings

Lists ProjectRoleBindings

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Project ID (must be valid UUID)

query Parameters
sort_by
string

A given ProjectRoleBinding attribute to sort results by (one of: role_name, actor_id)

role_name
string

Filter results by ProjectRoleBinding assigned role name

actor_id
string

Filter results by ProjectRoleBinding actor id

actor_type
string

Filter results by ProjectRoleBinding actor type

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create ProjectRoleBinding

Creates a new ProjectRoleBinding

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Project ID (must be valid UUID)

Request Body schema: application/json

Request body containing the project role binding

actor_id
string
actor_type
string
role_name
string

Responses

Request samples

Content type
application/json
{
  • "actor_id": "ID of the role subject",
  • "actor_type": "Type of the role subject",
  • "role_name": "Name of the assigned role"
}

Response samples

Content type
application/json
{
  • "actor_id": "string",
  • "actor_type": "string",
  • "project_id": "string",
  • "role_name": "string"
}

Delete ProjectRoleBinding

Removes a single ProjectRoleBinding

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Project ID (must be valid UUID)

Request Body schema: application/json

Request body containing the project role binding

actor_id
string
actor_type
string

Responses

Request samples

Content type
application/json
{
  • "actor_id": "string",
  • "actor_type": "string"
}

ResourceSettingsTemplates

Get ResourceSettingsTemplate

Fetches a single ResourceSettingsTemplate

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

ResourceSettingsTemplate ID (must be valid UUID)

Responses

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "cpu_limit": "string",
  • "cpu_request": "string",
  • "created_at": "string",
  • "data_service_id": "string",
  • "id": "string",
  • "memory_limit": "string",
  • "memory_request": "string",
  • "name": "string",
  • "storage_request": "string",
  • "tenant_id": "string",
  • "updated_at": "string"
}

Update ResourceSettingsTemplate

Updates existing ResourceSettingsTemplate

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

ResourceSettingsTemplate ID (must be valid UUID)

Request Body schema: application/json

Request body containing updated template

cpu_limit
string
cpu_request
string
memory_limit
string
memory_request
string
name
string

See models.ResourceSettingsTemplate for more information.

storage_request
string

Responses

Request samples

Content type
application/json
{
  • "cpu_limit": "string",
  • "cpu_request": "string",
  • "memory_limit": "string",
  • "memory_request": "string",
  • "name": "string",
  • "storage_request": "string"
}

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "cpu_limit": "string",
  • "cpu_request": "string",
  • "created_at": "string",
  • "data_service_id": "string",
  • "id": "string",
  • "memory_limit": "string",
  • "memory_request": "string",
  • "name": "string",
  • "storage_request": "string",
  • "tenant_id": "string",
  • "updated_at": "string"
}

Delete ResourceSettingsTemplates

Removes a single ResourceSettingsTemplate

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

ResourceSettingsTemplate ID (must be valid UUID)

Responses

List ResourceSettingsTemplates

Lists ResourceSettingsTemplates

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Tenant ID (must be valid UUID)

query Parameters
sort_by
string

A given ResourceSettingsTemplates attribute to sort results by (one of: id, name, created_at)

limit
string

Maximum number of rows to return (could be less)

continuation
string

Use a token returned by a previous query to continue listing with the next batch of rows

id
string

Filter results by ResourceSettingsTemplates id

name
string

Filter results by ResourceSettingsTemplates name

data_service_id
string

Filter results by DataService ID

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Create ResourceSettingsTemplate

Creates a new ResourceSettingsTemplate

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Tenant ID (must be valid UUID)

Request Body schema: application/json

Request body containing the resource settings template

cpu_limit
string
cpu_request
string
data_service_id
string
memory_limit
string
memory_request
string
name
string

See models.ResourceSettingsTemplate for more information.

storage_request
string

Responses

Request samples

Content type
application/json
{
  • "cpu_limit": "string",
  • "cpu_request": "string",
  • "data_service_id": "string",
  • "memory_limit": "string",
  • "memory_request": "string",
  • "name": "string",
  • "storage_request": "string"
}

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "cpu_limit": "string",
  • "cpu_request": "string",
  • "created_at": "string",
  • "data_service_id": "string",
  • "id": "string",
  • "memory_limit": "string",
  • "memory_request": "string",
  • "name": "string",
  • "storage_request": "string",
  • "tenant_id": "string",
  • "updated_at": "string"
}

Roles

List Roles

Fetches list of supported Roles

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

ServiceAccounts

Get ServiceAccounts Deprecated

Fetches a single ServiceAccount (will be replaced by service level API keys)

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

ServiceAccount ID (must be valid UUID)

Responses

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "created_at": "string",
  • "id": "string",
  • "name": "string",
  • "tenant_id": "string",
  • "updated_at": "string"
}

Delete ServiceAccounts Deprecated

Removes a single ServiceAccount (will be replaced by service level API keys)

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

ServiceAccount ID (must be valid UUID)

Responses

Get token of a ServiceAccount Deprecated

Fetches the token of a ServiceAccount (will be replaced by service level API keys)

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

ServiceAccount ID (must be valid UUID)

Responses

Response samples

Content type
application/json
{
  • "token": "string"
}

List Tenant's ServiceAccounts Deprecated

List Tenant's ServiceAccounts (will be replaced by service level API keys)

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Tenant ID (must be valid UUID)

query Parameters
sort_by
string

A given ServiceAccount attribute to sort results by (one of: name, id, created_at)

limit
string

Maximum number of rows to return (could be less)

continuation
string

Use a token returned by a previous query to continue listing with the next batch of rows

name
string

Filter results by ServiceAccount name

id
string

Filter results by ServiceAccount id

token
string

Filter results by ServiceAccount token

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Create ServiceAccounts Deprecated

Creates a new ServiceAccount (will be replaced by service level API keys)

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Tenant ID (must be valid UUID)

Request Body schema: application/json

Request body containing name of the service account

name
string

Responses

Request samples

Content type
application/json
{
  • "name": "Name of the service account"
}

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "created_at": "string",
  • "id": "string",
  • "name": "string",
  • "tenant_id": "string",
  • "updated_at": "string"
}

StorageOptionsTemplates

Get StorageOptionsTemplate

Fetches a single StorageOptionsTemplate

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

StorageOptionsTemplate ID (must be valid UUID)

Responses

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "created_at": "string",
  • "fg": true,
  • "fs": "xfs",
  • "id": "string",
  • "name": "string",
  • "provisioner": "pxd.portworx.com",
  • "repl": 1,
  • "secure": true,
  • "tenant_id": "string",
  • "updated_at": "string"
}

Update StorageOptionsTemplate

Updates existing StorageOptionsTemplate

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

StorageOptionsTemplate ID (must be valid UUID)

Request Body schema: application/json

Request body containing updated template

fg
boolean
fs
string
Enum: "xfs" "ext4"

Filesystem to be laid out.

name
string

See models.StorageOptionsTemplate for more information.

provisioner
string
Enum: "pxd.portworx.com" "kubernetes.io/portworx-volume" "auto"

Portworx volume provisioner. Valid values are: "pxd.portworx.com" for PX CSI, "kubernetes.io/portworx-volume" for PX in-tree or "auto" for auto-detect

repl
integer
Enum: 1 2 3

Replication factor for the volume.

secure
boolean

Responses

Request samples

Content type
application/json
{
  • "fg": true,
  • "fs": "xfs",
  • "name": "string",
  • "provisioner": "pxd.portworx.com",
  • "repl": 1,
  • "secure": true
}

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "created_at": "string",
  • "fg": true,
  • "fs": "xfs",
  • "id": "string",
  • "name": "string",
  • "provisioner": "pxd.portworx.com",
  • "repl": 1,
  • "secure": true,
  • "tenant_id": "string",
  • "updated_at": "string"
}

Delete StorageOptionsTemplates

Removes a single StorageOptionsTemplate

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

StorageOptionsTemplate ID (must be valid UUID)

Responses

List StorageOptionsTemplates

Lists StorageOptionsTemplates

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Tenant ID (must be valid UUID)

query Parameters
sort_by
string

A given StorageOptionsTemplates attribute to sort results by (one of: id, name, created_at)

limit
string

Maximum number of rows to return (could be less)

continuation
string

Use a token returned by a previous query to continue listing with the next batch of rows

id
string

Filter results by StorageOptionsTemplates id

name
string

Filter results by StorageOptionsTemplates name

provisioner
Array of strings
Items Enum: "pxd.portworx.com" "kubernetes.io/portworx-volume" "auto"

Filter results by StorageOptionsTemplates provisioner

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Create StorageOptionsTemplate

Creates a new StorageOptionsTemplate

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Tenant ID (must be valid UUID)

Request Body schema: application/json

Request body containing the storage options template

fg
boolean
fs
string
Enum: "xfs" "ext4"

Filesystem to be laid out.

name
string

See models.StorageOptionsTemplate for more information.

provisioner
string
Enum: "pxd.portworx.com" "kubernetes.io/portworx-volume" "auto"

Portworx volume provisioner. Valid values are: "pxd.portworx.com" for PX CSI, "kubernetes.io/portworx-volume" for PX in-tree or "auto" for auto-detect

repl
integer
Enum: 1 2 3

Replication factor for the volume.

secure
boolean

Responses

Request samples

Content type
application/json
{
  • "fg": true,
  • "fs": "xfs",
  • "name": "string",
  • "provisioner": "pxd.portworx.com",
  • "repl": 1,
  • "secure": true
}

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "created_at": "string",
  • "fg": true,
  • "fs": "xfs",
  • "id": "string",
  • "name": "string",
  • "provisioner": "pxd.portworx.com",
  • "repl": 1,
  • "secure": true,
  • "tenant_id": "string",
  • "updated_at": "string"
}

Teams

Get Team

Fetches a single Team

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Team ID (must be valid UUID)

Responses

Response samples

Content type
application/json
{
  • "account_id": "string",
  • "created_at": "string",
  • "id": "string",
  • "name": "string",
  • "tenant_id": "string",
  • "updated_at": "string"
}

TenantRoleBindings

List TenantRoleBindings

Lists TenantRoleBindings

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Tenant ID (must be valid UUID)

query Parameters
sort_by
string

A given TenantRoleBinding attribute to sort results by (one of: role_name, actor_id)

role_name
string

Filter results by TenantRoleBinding assigned role name

actor_id
string

Filter results by TenantRoleBinding actor id

actor_type
string

Filter results by TenantRoleBinding actor type

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Create TenantRoleBinding

Creates a new TenantRoleBinding

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Tenant ID (must be valid UUID)

Request Body schema: application/json

Request body containing the tenant role binding

actor_id
string
actor_type
string
role_name
string

Responses

Request samples

Content type
application/json
{
  • "actor_id": "ID of the role subject",
  • "actor_type": "Type of the role subject",
  • "role_name": "Name of the assigned role"
}

Response samples

Content type
application/json
{
  • "actor_id": "string",
  • "actor_type": "string",
  • "role_name": "string",
  • "tenant_id": "string"
}

Delete TenantRoleBinding

Removes a single TenantRoleBinding

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Tenant ID (must be valid UUID)

Request Body schema: application/json

Request body containing the tenant role binding

actor_id
string
actor_type
string

Responses

Request samples

Content type
application/json
{
  • "actor_id": "string",
  • "actor_type": "string"
}

UserAPIKey

List UserAPIKeys

Lists UserAPIKeys

Authorizations:
ApiKeyAuth
query Parameters
id
string

Filter results by id

name
string

Filter results by name

enabled
boolean

Filter results by enabled

sort_by
string

A given UserAPIKey attribute to sort results by (one of: id, name, created_at, enabled, expires_at)

limit
string

Maximum number of rows to return (could be less)

continuation
string

Use a token returned by a previous query to continue listing with the next batch of rows

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Create UserAPIKey

Creates a UserAPIKey

Authorizations:
ApiKeyAuth
Request Body schema: application/json

Request body containing the necessary information to create a key.

expires_at
string

Time when the key expires.

name
string [ 1 .. 256 ] characters

Name of the UserAPIKey. Must be unique for the given User.

Responses

Request samples

Content type
application/json
{
  • "expires_at": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "enabled": true,
  • "expires_at": "string",
  • "id": "string",
  • "jwt_token": "string",
  • "name": "string",
  • "updated_at": "string",
  • "user_id": "string"
}

Get UserAPIKey

Gets a UserAPIKey

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

UserAPIKey ID (must be valid UUID)

Responses

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "enabled": true,
  • "expires_at": "string",
  • "id": "string",
  • "jwt_token": "string",
  • "name": "string",
  • "updated_at": "string",
  • "user_id": "string"
}

Delete UserAPIKey

Deletes the UserAPIKey if it's disabled. Returns 422 if the UserAPIKey is enabled.

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

UserAPIKey ID (must be valid UUID)

Responses

Patch UserAPIKey

Patches the Name and Enabled properties of a UserAPIKey

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

UserAPIKey ID (must be valid UUID)

Request Body schema: application/json

Request body containing the new values.

enabled
boolean

Whether the UserAPIKey is enabled or disabled.

name
string [ 1 .. 256 ] characters

The name of the UserAPIKey.

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "name": "string"
}

Users

Get User

Fetches a single User

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

User ID (must be valid UUID)

Responses

Response samples

Content type
application/json
{
  • "created_at": "string",
  • "email": "string",
  • "external_id": "string",
  • "id": "string",
  • "issuer": "string",
  • "updated_at": "string"
}

APIVersion

Get version information Deprecated

Get version information about this server

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "api_version": "API server version",
  • "features": {
    },
  • "helm_chart_version": "Helm chart version",
  • "pds_build_number": 0
}

WhoAmI

Get Current Actor

Fetches a details of the current calling actor (user or service account)

Authorizations:
ApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "service_account": {
    },
  • "service_identity": {
    },
  • "user": {
    }
}

Authentication

Authorization code exchange

Exchanges the Authorization Code from the OAuth2 server for an ID Token which is necessary for user authentication using the Authorization HTTP header.

Authenticating for later requests using the ID token: Authorization: Bearer {id_token}

Request Body schema: application/json

Request body containing the received authorization code.

AuthCode
string

Responses

Request samples

Content type
application/json
{
  • "AuthCode": "string"
}

Response samples

Content type
application/json
{
  • "claims": {
    },
  • "expiresIn": "string",
  • "idToken": "string",
  • "refreshToken": "string"
}

OIDC info

Returns OIDC configuration for the frontend.

Responses

Response samples

Content type
application/json
{}

Use refresh token to generate new tokens.

Request Body schema: application/json

Request body containing the refresh token.

refreshToken
string

Responses

Request samples

Content type
application/json
{
  • "refreshToken": "string"
}

Response samples

Content type
application/json
{
  • "claims": {
    },
  • "expiresIn": "string",
  • "idToken": "string",
  • "refreshToken": "string"
}