Patch AccountRoleInvitation role_name
Patches AccountRoleInvitation role_name
Authorizations:
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
- Payload
{- "role_name": "string"
}
List Accounts
Lists Accounts.
Authorizations:
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
- 200
{- "data": [
- {
- "baas_features_enabled": true,
- "created_at": "string",
- "eula": {
- "accepted": true,
- "accepted_version": "string"
}, - "global_config": {
- "tls_preview_enabled": "string",
- "version_availability": "string",
- "version_updatability": "string"
}, - "id": "string",
- "name": "string",
- "pds_features_enabled": true,
- "pxone_features_enabled": true,
- "updated_at": "string"
}
], - "pagination": {
- "continuation": "string"
}
}
Create Account
Creates a new Account
Authorizations:
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
- Payload
{- "baas_features_enabled": true,
- "dns_details": {
- "aws_details": {
- "access_key": "string",
- "hosted_zone_id": "string",
- "secret_key": "string"
}, - "dns_zone": "string"
}, - "maas_details": {
- "maas_id": "string"
}, - "name": "string",
- "pds_features_enabled": true,
- "pxone_features_enabled": true,
- "subdomain": "string"
}
Response samples
- 200
{- "baas_features_enabled": true,
- "created_at": "string",
- "eula": {
- "accepted": true,
- "accepted_version": "string"
}, - "global_config": {
- "tls_preview_enabled": "string",
- "version_availability": "string",
- "version_updatability": "string"
}, - "id": "string",
- "name": "string",
- "pds_features_enabled": true,
- "pxone_features_enabled": true,
- "updated_at": "string"
}
Get Account
Fetches a single Account
Authorizations:
path Parameters
id required | string Account ID (must be valid UUID) |
Responses
Response samples
- 200
{- "baas_features_enabled": true,
- "created_at": "string",
- "eula": {
- "accepted": true,
- "accepted_version": "string"
}, - "global_config": {
- "tls_preview_enabled": "string",
- "version_availability": "string",
- "version_updatability": "string"
}, - "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:
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
- Payload
{- "name": "string"
}
List Account Role Invitations
Lists Account Role Invitations
Authorizations:
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 |
string Filter results by User email | |
role_name | string Filter results by assigned role name |
Responses
Response samples
- 200
{- "data": [
- {
- "account_id": "string",
- "created_at": "string",
- "email": "string",
- "id": "string",
- "issuer": "string",
- "role_name": "string",
- "updated_at": "string"
}
], - "pagination": {
- "continuation": "string"
}
}
Accept EULA
Accept a specific EULA version
Authorizations:
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
- Payload
{- "version": "string"
}
Update AccountGlobalConfig
Modify AccountGlobalConfig for this Account
Authorizations:
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
- Payload
{- "tls_preview_enabled": "all",
- "version_availability": "all",
- "version_updatability": "all"
}
List Account Users
Lists Account Users
Authorizations:
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 |
string Filter results by User email |
Responses
Response samples
- 200
{- "data": [
- {
- "created_at": "string",
- "email": "string",
- "external_id": "string",
- "id": "string",
- "issuer": "string",
- "updated_at": "string"
}
], - "pagination": {
- "continuation": "string"
}
}
Update DNS Details
Update DNS details for desired account
Authorizations:
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
- Payload
{- "aws_details": {
- "access_key": "string",
- "hosted_zone_id": "string",
- "secret_key": "string"
}, - "dns_zone": "string"
}
List IAM
Lists IAM records for an account
Authorizations:
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
- 200
[- {
- "access_policy": {
- "account": [
- "string"
], - "account_id": "string",
- "global": [
- "string"
], - "namespace": [
- {
- "resource_ids": [
- "string"
], - "role_name": "string"
}
], - "project": [
- {
- "resource_ids": [
- "string"
], - "role_name": "string"
}
], - "tenant": [
- {
- "resource_ids": [
- "string"
], - "role_name": "string"
}
]
}, - "account_id": "string",
- "actor_id": "string",
- "actor_type": "string",
- "created_at": "string",
- "id": "string",
- "updated_at": "string"
}
]
Update IAM
Updates a IAM rolebinding
Authorizations:
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
- Payload
{- "actor_id": "string",
- "data": {
- "account": [
- "string"
], - "global": [
- "string"
], - "namespace": [
- {
- "resource_ids": [
- "string"
], - "role_name": "string"
}
], - "project": [
- {
- "resource_ids": [
- "string"
], - "role_name": "string"
}
], - "tenant": [
- {
- "resource_ids": [
- "string"
], - "role_name": "string"
}
]
}
}
Response samples
- 200
{- "access_policy": {
- "account": [
- "string"
], - "account_id": "string",
- "global": [
- "string"
], - "namespace": [
- {
- "resource_ids": [
- "string"
], - "role_name": "string"
}
], - "project": [
- {
- "resource_ids": [
- "string"
], - "role_name": "string"
}
], - "tenant": [
- {
- "resource_ids": [
- "string"
], - "role_name": "string"
}
]
}, - "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:
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
- Payload
{- "actor_id": "string",
- "data": {
- "account": [
- "string"
], - "global": [
- "string"
], - "namespace": [
- {
- "resource_ids": [
- "string"
], - "role_name": "string"
}
], - "project": [
- {
- "resource_ids": [
- "string"
], - "role_name": "string"
}
], - "tenant": [
- {
- "resource_ids": [
- "string"
], - "role_name": "string"
}
]
}
}
Response samples
- 200
{- "access_policy": {
- "account": [
- "string"
], - "account_id": "string",
- "global": [
- "string"
], - "namespace": [
- {
- "resource_ids": [
- "string"
], - "role_name": "string"
}
], - "project": [
- {
- "resource_ids": [
- "string"
], - "role_name": "string"
}
], - "tenant": [
- {
- "resource_ids": [
- "string"
], - "role_name": "string"
}
]
}, - "account_id": "string",
- "actor_id": "string",
- "actor_type": "string",
- "created_at": "string",
- "id": "string",
- "updated_at": "string"
}
Get IAM
Fetches an IAM record
Authorizations:
path Parameters
id required | string Account ID (must be valid UUID) |
actor-id required | string Actor ID (must be valid UUID) |
Responses
Response samples
- 200
{- "access_policy": {
- "account": [
- "string"
], - "account_id": "string",
- "global": [
- "string"
], - "namespace": [
- {
- "resource_ids": [
- "string"
], - "role_name": "string"
}
], - "project": [
- {
- "resource_ids": [
- "string"
], - "role_name": "string"
}
], - "tenant": [
- {
- "resource_ids": [
- "string"
], - "role_name": "string"
}
]
}, - "account_id": "string",
- "actor_id": "string",
- "actor_type": "string",
- "created_at": "string",
- "id": "string",
- "updated_at": "string"
}
Create Invitation
Adds role binding to existing user or creates invitation if user does not exist.
Authorizations:
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
- Payload
{- "email": "string",
- "role_name": "string"
}
List AccountRoleBinding
Lists AccountRoleBinding
Authorizations:
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
- 200
{- "data": [
- {
- "account_id": "string",
- "actor_id": "string",
- "actor_type": "string",
- "role_name": "string"
}
]
}
Create/Update AccountRoleBinding
Creates a new AccountRoleBinding, or updates role_name if binding for (actor_id, actor_type) already exists.
Authorizations:
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
- Payload
{- "actor_id": "ID of the role subject",
- "actor_type": "Type of the role subject",
- "role_name": "Name of the assigned role"
}
Response samples
- 200
{- "account_id": "string",
- "actor_id": "string",
- "actor_type": "string",
- "role_name": "string"
}
Delete AccountRoleBinding
Removes a single AccountRoleBinding
Authorizations:
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
- Payload
{- "actor_id": "string",
- "actor_type": "string"
}
List User's AccountRoleBindings
Lists the AccountRoleBindings of a User.
Authorizations:
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
- 200
{- "data": [
- {
- "account_id": "string",
- "actor_id": "string",
- "actor_type": "string",
- "role_name": "string"
}
]
}
List Service Identity
Lists all ServiceIdentity for an account
Authorizations:
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
- 200
{- "data": [
- {
- "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"
}
], - "pagination": {
- "continuation": "string"
}
}
Create a Service Identity
Create a Service Identity for programmatic access to pds
Authorizations:
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
- Payload
{- "description": "string",
- "enabled": true,
- "name": "string"
}
Response samples
- 200
{- "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:
path Parameters
id required | string Service Identity ID (must be valid UUID) |
Responses
Response samples
- 200
{- "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:
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
- Payload
{- "description": "string",
- "enabled": true,
- "name": "string"
}
Response samples
- 200
{- "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"
}
Regenerate service identity credentials
Revokes existing credentials and regenerate new ClientID and ClientToken
Authorizations:
path Parameters
id required | string Service Identity ID (must be valid UUID) |
Responses
Response samples
- 200
{- "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
- Payload
{- "client_id": "string",
- "client_token": "string"
}
Response samples
- 200
{- "token": "string",
- "valid_for": "string"
}
List Account's Tenants
Lists Tenants.
Authorizations:
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
- 200
{- "data": [
- {
- "account_id": "string",
- "created_at": "string",
- "id": "string",
- "name": "string",
- "updated_at": "string"
}
], - "pagination": {
- "continuation": "string"
}
}
Get DNS details for Tenant
Get DNS details/credentials for Tenant
Authorizations:
path Parameters
id required | string Tenant ID (must be valid UUID) |
Responses
Response samples
- 200
{- "aws_details": {
- "access_key": "string",
- "hosted_zone_id": "string",
- "secret_key": "string"
}, - "dns_zone": "string"
}
Get ApplicationConfigurationTemplate
Fetches a single ApplicationConfigurationTemplate
Authorizations:
path Parameters
id required | string ApplicationConfigurationTemplate ID (must be valid UUID) |
Responses
Response samples
- 200
{- "account_id": "string",
- "config_items": [
- {
- "deploy_time": true,
- "key": "string",
- "value": "string"
}
], - "created_at": "string",
- "data_service_id": "string",
- "id": "string",
- "name": "string",
- "tenant_id": "string",
- "updated_at": "string"
}
Update ApplicationConfigurationTemplate
Updates existing ApplicationConfigurationTemplate
Authorizations:
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
- Payload
{- "config_items": [
- {
- "deploy_time": true,
- "key": "string",
- "value": "string"
}
], - "name": "string"
}
Response samples
- 200
{- "account_id": "string",
- "config_items": [
- {
- "deploy_time": true,
- "key": "string",
- "value": "string"
}
], - "created_at": "string",
- "data_service_id": "string",
- "id": "string",
- "name": "string",
- "tenant_id": "string",
- "updated_at": "string"
}
List ApplicationConfigurationTemplates
Lists ApplicationConfigurationTemplates
Authorizations:
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
- 200
{- "data": [
- {
- "account_id": "string",
- "config_items": [
- {
- "deploy_time": true,
- "key": "string",
- "value": "string"
}
], - "created_at": "string",
- "data_service_id": "string",
- "id": "string",
- "name": "string",
- "tenant_id": "string",
- "updated_at": "string"
}
], - "pagination": {
- "continuation": "string"
}
}
Create ApplicationConfigurationTemplate
Creates a new ApplicationConfigurationTemplate
Authorizations:
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
- Payload
{- "config_items": [
- {
- "deploy_time": true,
- "key": "string",
- "value": "string"
}
], - "data_service_id": "string",
- "name": "string"
}
Response samples
- 201
{- "account_id": "string",
- "config_items": [
- {
- "deploy_time": true,
- "key": "string",
- "value": "string"
}
], - "created_at": "string",
- "data_service_id": "string",
- "id": "string",
- "name": "string",
- "tenant_id": "string",
- "updated_at": "string"
}
Get BackupCredentials
Fetches a single BackupCredentials
Authorizations:
path Parameters
id required | string BackupCredentials ID (must be valid UUID) |
Responses
Response samples
- 200
{- "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:
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
- Payload
{- "credentials": {
- "azure": {
- "account_key": "string",
- "account_name": "string"
}, - "google": {
- "json_key": "string",
- "project_id": "string"
}, - "s3": {
- "access_key": "string",
- "endpoint": "string",
- "secret_key": "string"
}, - "s3_compatible": {
- "access_key": "string",
- "endpoint": "string",
- "secret_key": "string"
}
}, - "name": "string"
}
Response samples
- 200
{- "account_id": "string",
- "created_at": "string",
- "id": "string",
- "name": "string",
- "tenant_id": "string",
- "type": "azure",
- "updated_at": "string"
}
Get cloud configuration for BackupCredentials
Get cloud configuration for BackupCredentials
Authorizations:
path Parameters
id required | string BackupCredentials ID (must be valid UUID) |
Responses
Response samples
- 200
{- "azure": {
- "account_name": "string"
}, - "google": {
- "project_id": "string"
}, - "s3": {
- "access_key": "string",
- "endpoint": "string"
}, - "s3_compatible": {
- "access_key": "string",
- "endpoint": "string"
}
}
List BackupCredentials
Lists BackupCredentials visible to the caller
Authorizations:
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
- 200
{- "data": [
- {
- "account_id": "string",
- "created_at": "string",
- "id": "string",
- "name": "string",
- "tenant_id": "string",
- "type": "azure",
- "updated_at": "string"
}
], - "pagination": {
- "continuation": "string"
}
}
Create BackupCredentials
Creates a new BackupCredentials
Authorizations:
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
- Payload
{- "credentials": {
- "azure": {
- "account_key": "string",
- "account_name": "string"
}, - "google": {
- "json_key": "string",
- "project_id": "string"
}, - "s3": {
- "access_key": "string",
- "endpoint": "string",
- "secret_key": "string"
}, - "s3_compatible": {
- "access_key": "string",
- "endpoint": "string",
- "secret_key": "string"
}
}, - "name": "string"
}
Response samples
- 200
{- "account_id": "string",
- "created_at": "string",
- "id": "string",
- "name": "string",
- "tenant_id": "string",
- "type": "azure",
- "updated_at": "string"
}
Get BackupJob
Fetches a BackupJob
Authorizations:
path Parameters
id required | string BackupJob ID (must be valid UUID) |
Responses
Response samples
- 200
{- "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:
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
- Payload
{- "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
- 200
{- "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"
}
List Backup's Jobs
Retrieves a list of BackupJobs associated to this Backup
Authorizations:
path Parameters
id required | string Backup ID (must be valid UUID) |
Responses
Response samples
- 200
{- "data": [
- {
- "completion_time": "string",
- "name": "string",
- "start_time": "string",
- "status": "string"
}
]
}
List Project's BackupJobs
Lists the BackupJobs that belonging to the Project.
Authorizations:
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
- 200
{- "data": [
- {
- "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"
}
], - "pagination": {
- "continuation": "string"
}
}
Start Restore
Starts restore of given BackupJob
Authorizations:
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
- Payload
{- "deployment_target_id": "string",
- "name": "string",
- "namespace_id": "string"
}
Response samples
- 200
{- "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"
}
Get Restore
Fetches a Restore
Authorizations:
path Parameters
id required | string Restore ID (must be valid UUID) |
Responses
Response samples
- 200
{- "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:
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
- Payload
{- "deployment_target_id": "string",
- "name": "string",
- "namespace_id": "string"
}
Update Restore
Updates a Restore
Authorizations:
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
- Payload
{- "completion_status": "string",
- "completion_time": "string",
- "error_code": "string",
- "start_time": "string",
- "timestamp": "string"
}
Get BackupPolicy
Fetches a single BackupPolicy
Authorizations:
path Parameters
id required | string BackupPolicy ID (must be valid UUID) |
Responses
Response samples
- 200
{- "account_id": "string",
- "created_at": "string",
- "id": "string",
- "name": "string",
- "schedules": [
- {
- "id": "string",
- "retention_count": 0,
- "schedule": "string",
- "type": "incremental"
}
], - "tenant_id": "string",
- "updated_at": "string"
}
Update BackupPolicy
Updates existing BackupPolicy
Authorizations:
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
- Payload
{- "name": "string",
- "schedules": [
- {
- "id": "string",
- "retention_count": 0,
- "schedule": "string",
- "type": "incremental"
}
]
}
Response samples
- 200
{- "account_id": "string",
- "created_at": "string",
- "id": "string",
- "name": "string",
- "schedules": [
- {
- "id": "string",
- "retention_count": 0,
- "schedule": "string",
- "type": "incremental"
}
], - "tenant_id": "string",
- "updated_at": "string"
}
List BackupPolicies
Lists BackupPolicies
Authorizations:
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
- 200
{- "data": [
- {
- "account_id": "string",
- "created_at": "string",
- "id": "string",
- "name": "string",
- "schedules": [
- {
- "id": "string",
- "retention_count": 0,
- "schedule": "string",
- "type": "incremental"
}
], - "tenant_id": "string",
- "updated_at": "string"
}
], - "pagination": {
- "continuation": "string"
}
}
Create BackupPolicy
Creates a new BackupPolicy
Authorizations:
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
- Payload
{- "name": "string",
- "schedules": [
- {
- "id": "string",
- "retention_count": 0,
- "schedule": "string",
- "type": "incremental"
}
]
}
Response samples
- 201
{- "account_id": "string",
- "created_at": "string",
- "id": "string",
- "name": "string",
- "schedules": [
- {
- "id": "string",
- "retention_count": 0,
- "schedule": "string",
- "type": "incremental"
}
], - "tenant_id": "string",
- "updated_at": "string"
}
Get BackupTarget
Fetches a single BackupTarget
Authorizations:
path Parameters
id required | string BackupTarget ID (must be valid UUID) |
Responses
Response samples
- 200
{- "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:
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
- Payload
{- "name": "string"
}
Response samples
- 201
{- "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"
}
List BackupTarget's BackupTargetStates
Lists BackupTarget's BackupTargetStates
Authorizations:
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
- 200
{- "data": [
- {
- "backup_target_id": "string",
- "deployment_target_id": "string",
- "error_code": "deployment_target_unavailable",
- "error_details": "string",
- "error_message": "string",
- "px_credentials_id": "string",
- "px_credentials_name": "string",
- "state": "pending"
}
]
}
List Project's BackupTargets
Lists BackupTargets belonging to the Project
Authorizations:
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
- 200
{- "data": [
- {
- "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"
}
], - "pagination": {
- "continuation": "string"
}
}
List Tenant's BackupTargets
Lists Tenant's BackupTargets
Authorizations:
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
- 200
{- "data": [
- {
- "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"
}
], - "pagination": {
- "continuation": "string"
}
}
Create BackupTarget
Creates a new BackupTarget
Authorizations:
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
- Payload
{- "backup_credentials_id": "string",
- "bucket": "string",
- "name": "string",
- "region": "string",
- "type": "string"
}
Response samples
- 201
{- "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"
}
List BackupTarget's Backups
Lists Backups belonging to the BackupTarget.
Authorizations:
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
- 200
{- "data": [
- {
- "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"
}
], - "pagination": {
- "continuation": "string"
}
}
Get Backup
Fetches a single Backup
Authorizations:
path Parameters
id required | string Backup ID (must be a valid UUID) |
Responses
Response samples
- 200
{- "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:
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
- Payload
{- "job_history_limit": 0
}
Response samples
- 200
{- "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 jobs
Deletes an existing job for scheduled backups
Authorizations:
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:
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
- 200
{- "data": [
- {
- "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"
}
], - "pagination": {
- "continuation": "string"
}
}
Create Backup
Creates a new database Backup
Authorizations:
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
- Payload
{- "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
- 201
{- "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"
}
List compatible versions
Lists what versions are compatible for other versions.
Authorizations:
query Parameters
data_service_id | string Filter results by data_service_id |
version_id | string Filter results by version_id |
Responses
Response samples
- 200
{- "data": [
- {
- "compatible": [
- {
- "id": "string",
- "name": "string"
}
], - "data_service_id": "string",
- "data_service_name": "string",
- "latest_compatible": [
- {
- "id": "string",
- "name": "string"
}
], - "latest_compatible_patch": {
- "id": "string",
- "name": "string"
}, - "version_id": "string",
- "version_name": "string"
}
]
}
List Data Service's Versions
Lists Versions belonging to the Data Service.
Authorizations:
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
- 200
{- "data": [
- {
- "created_at": "string",
- "data_service_id": "string",
- "enabled": true,
- "id": "string",
- "name": "string",
- "updated_at": "string"
}
], - "pagination": {
- "continuation": "string"
}
}
Get Version
Fetches a single Version
Authorizations:
path Parameters
id required | string Version ID (must be valid UUID) |
Responses
Response samples
- 200
{- "created_at": "string",
- "data_service_id": "string",
- "enabled": true,
- "id": "string",
- "name": "string",
- "updated_at": "string"
}
Search Database query
Generates a response for database query for different databases
Authorizations:
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
- Payload
{- "data_service_id": "string",
- "query": "how to list all records of table employee."
}
Response samples
- 200
{- "data_service_id": "string",
- "id": "string",
- "query": "string",
- "response": "string",
- "response_time": "string"
}
List Data Services
Lists Data Services
Authorizations:
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
- 200
{- "data": [
- {
- "coming_soon": true,
- "created_at": "string",
- "has_full_backup": true,
- "has_incremental_backup": true,
- "id": "string",
- "name": "string",
- "node_restrictions": {
- "downsize_enabled": true,
- "resize_disabled": [
- 0
], - "simple_config": [
- 0
]
}, - "nodes_limitations": "string",
- "short_name": "string",
- "updated_at": "string"
}
], - "pagination": {
- "continuation": "string"
}
}
Get Data Service
Fetches a single Data Service
Authorizations:
path Parameters
id required | string Data Service ID (must be a valid UUID) |
Responses
Response samples
- 200
{- "coming_soon": true,
- "created_at": "string",
- "has_full_backup": true,
- "has_incremental_backup": true,
- "id": "string",
- "name": "string",
- "node_restrictions": {
- "downsize_enabled": true,
- "resize_disabled": [
- 0
], - "simple_config": [
- 0
]
}, - "nodes_limitations": "string",
- "short_name": "string",
- "updated_at": "string"
}
Get Task
Fetches a database Task
Authorizations:
path Parameters
id required | string Task ID (must be valid UUID) |
Responses
Response samples
- 200
{- "account_id": "string",
- "associated_resource": "string",
- "created_at": "string",
- "current_step": 0,
- "description": "string",
- "id": 0,
- "log": [
- "string"
], - "project_id": "string",
- "status": "string",
- "tenant_id": "string",
- "total_steps": 0,
- "updated_at": "string"
}
List ApplicationConfigurationSamples
Lists ApplicationConfigurationSamples
Authorizations:
query Parameters
data_service_id | string Filter results by DataService ID |
Responses
Response samples
- 200
{- "data": [
- {
- "config_items": [
- {
- "deploy_time": true,
- "key": "string",
- "value": "string"
}
], - "created": "string",
- "data_service_id": "string",
- "name": "string",
- "updated": "string",
- "version": 0
}
]
}
Response samples
- 200
{- "data": [
- {
- "created": "string",
- "name": "string",
- "schedules": [
- {
- "id": "string",
- "retention_count": 0,
- "schedule": "string",
- "type": "incremental"
}
], - "updated": "string",
- "version": 0
}
]
}
List ResourceSettingsSamples
Lists ResourceSettingsSamples
Authorizations:
query Parameters
data_service_id | string Filter results by DataService ID |
Responses
Response samples
- 200
{- "data": [
- {
- "cpu_limit": "string",
- "cpu_request": "string",
- "created": "string",
- "data_service_id": "string",
- "memory_limit": "string",
- "memory_request": "string",
- "name": "string",
- "storage_request": "string",
- "updated": "string",
- "version": 0
}
]
}
Response samples
- 200
{- "data": [
- {
- "created": "string",
- "fg": true,
- "fs": "xfs",
- "name": "string",
- "provisioner": "pxd.portworx.com",
- "repl": 1,
- "secure": true,
- "updated": "string",
- "version": 0
}
]
}
Get DeploymentTarget
Fetches a single DeploymentTarget
Authorizations:
path Parameters
id required | string DeploymentTarget ID (must be valid UUID) |
Responses
Response samples
- 200
{- "account_id": "string",
- "capabilities": {
- "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"
}, - "cluster_id": "string",
- "connection_status": "string",
- "created_at": "string",
- "id": "string",
- "last_health_check": "string",
- "last_operator_heartbeat": "string",
- "metadata": {
- "kube_api_version": "string",
- "kube_platform": "string",
- "pds_chart_version": "string",
- "pds_features": "string",
- "pds_operator_version": "string",
- "px_csi_enabled": "string",
- "px_service_namespace": "string",
- "px_status": "string",
- "px_version": "string"
}, - "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:
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
- Payload
{- "name": "string"
}
Response samples
- 201
{- "account_id": "string",
- "capabilities": {
- "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"
}, - "cluster_id": "string",
- "connection_status": "string",
- "created_at": "string",
- "id": "string",
- "last_health_check": "string",
- "last_operator_heartbeat": "string",
- "metadata": {
- "kube_api_version": "string",
- "kube_platform": "string",
- "pds_chart_version": "string",
- "pds_features": "string",
- "pds_operator_version": "string",
- "px_csi_enabled": "string",
- "px_service_namespace": "string",
- "px_status": "string",
- "px_version": "string"
}, - "name": "string",
- "status": "string",
- "teleport_agent_version": "string",
- "tenant_id": "string",
- "tls_issuer": "string",
- "tls_required": true,
- "updated_at": "string"
}
Patch DeploymentTarget
Patches existing DeploymentTarget
Authorizations:
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
- Payload
{- "name": "string",
- "tls_issuer": "string",
- "tls_required": true
}
Response samples
- 200
{- "account_id": "string",
- "capabilities": {
- "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"
}, - "cluster_id": "string",
- "connection_status": "string",
- "created_at": "string",
- "id": "string",
- "last_health_check": "string",
- "last_operator_heartbeat": "string",
- "metadata": {
- "kube_api_version": "string",
- "kube_platform": "string",
- "pds_chart_version": "string",
- "pds_features": "string",
- "pds_operator_version": "string",
- "px_csi_enabled": "string",
- "px_service_namespace": "string",
- "px_status": "string",
- "px_version": "string"
}, - "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:
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
- Payload
{- "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:
path Parameters
id required | string DeploymentTarget ID (must be valid UUID) |
Responses
Response samples
- 200
{- "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:
path Parameters
id required | string DeploymentTarget ID (must be valid UUID) |
Responses
Response samples
- 200
{- "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:
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
- Payload
{- "cluster_id": "string"
}
Response samples
- 200
{- "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:
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
- Payload
{- "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:
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
- Payload
{- "cluster_id": "string"
}
Response samples
- 200
{- "cluster_id": "string",
- "name": "string"
}
Update target operator metadata
Handles DeploymentTarget metadata created by target operator
Authorizations:
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
- Payload
{- "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:
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
- Payload
{- "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:
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
- 200
{- "data": [
- {
- "account_id": "string",
- "capabilities": {
- "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"
}, - "cluster_id": "string",
- "connection_status": "string",
- "created_at": "string",
- "id": "string",
- "last_health_check": "string",
- "last_operator_heartbeat": "string",
- "metadata": {
- "kube_api_version": "string",
- "kube_platform": "string",
- "pds_chart_version": "string",
- "pds_features": "string",
- "pds_operator_version": "string",
- "px_csi_enabled": "string",
- "px_service_namespace": "string",
- "px_status": "string",
- "px_version": "string"
}, - "name": "string",
- "status": "string",
- "teleport_agent_version": "string",
- "tenant_id": "string",
- "tls_issuer": "string",
- "tls_required": true,
- "updated_at": "string"
}
], - "pagination": {
- "continuation": "string"
}
}
List Tenant's DeploymentTargets
Lists Tenant's DeploymentTargets
Authorizations:
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
- 200
{- "data": [
- {
- "account_id": "string",
- "capabilities": {
- "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"
}, - "cluster_id": "string",
- "connection_status": "string",
- "created_at": "string",
- "id": "string",
- "last_health_check": "string",
- "last_operator_heartbeat": "string",
- "metadata": {
- "kube_api_version": "string",
- "kube_platform": "string",
- "pds_chart_version": "string",
- "pds_features": "string",
- "pds_operator_version": "string",
- "px_csi_enabled": "string",
- "px_service_namespace": "string",
- "px_status": "string",
- "px_version": "string"
}, - "name": "string",
- "status": "string",
- "teleport_agent_version": "string",
- "tenant_id": "string",
- "tls_issuer": "string",
- "tls_required": true,
- "updated_at": "string"
}
], - "pagination": {
- "continuation": "string"
}
}
Create DeploymentTarget
Creates a new DeploymentTarget
Authorizations:
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
- Payload
{- "cluster_id": "string",
- "name": "string",
- "teleport_agent_version": "string",
- "tls_issuer": "string",
- "tls_required": true
}
Response samples
- 201
{- "account_id": "string",
- "capabilities": {
- "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"
}, - "cluster_id": "string",
- "connection_status": "string",
- "created_at": "string",
- "id": "string",
- "last_health_check": "string",
- "last_operator_heartbeat": "string",
- "metadata": {
- "kube_api_version": "string",
- "kube_platform": "string",
- "pds_chart_version": "string",
- "pds_features": "string",
- "pds_operator_version": "string",
- "px_csi_enabled": "string",
- "px_service_namespace": "string",
- "px_status": "string",
- "px_version": "string"
}, - "name": "string",
- "status": "string",
- "teleport_agent_version": "string",
- "tenant_id": "string",
- "tls_issuer": "string",
- "tls_required": true,
- "updated_at": "string"
}