Skip to main content
API docs by Redocly

public/portworx/pds/backupconfig/apiv1/backupconfig.proto (version not set)

Download OpenAPI specification:Download

BackupConfigService

ListBackupConfigs API lists all the backup configuration for a data service deployment.

query Parameters
tenantId
string

Tenant ID for which the backup configurations will be listed.

projectId
string

Project ID for which the backup configurations will be listed.

targetClusterId
string

Cluster ID for which the backup configurations will be listed.

namespaceId
string

Namespace ID for which the backup configurations will be listed.

dataServiceDeploymentId
string

Data service Deployment ID for which the backup configurations will be listed.

pagination.pageNumber
string <int64>

Page number is the page number to return based on the size.

pagination.pageSize
string <int64>

Page size is the maximum number of records to include per page.

sort.sortBy
string
Default: "FIELD_UNSPECIFIED"
Enum: "FIELD_UNSPECIFIED" "NAME" "CREATED_AT" "UPDATED_AT" "PHASE"

Name of the attribute to sort results by.

  • FIELD_UNSPECIFIED: Unspecified, do not use.
  • NAME: Sorting based on the name of the resource.
  • CREATED_AT: Sorting on create time of the resource.
  • UPDATED_AT: Sorting on update time of the resource.
  • PHASE: Sorting on phase of the resource.
sort.sortOrder
string
Default: "VALUE_UNSPECIFIED"
Enum: "VALUE_UNSPECIFIED" "ASC" "DESC"

Order of sorting to be applied on requested list. If sort_by having some value and sort_order is not provided, by default ascending order will be used to sort the list.

  • VALUE_UNSPECIFIED: Unspecified, do not use.
  • ASC: Sort order ascending.
  • DESC: Sort order descending.
suspended
string
Default: "BACKUP_CONFIG_SUSPENDED_UNSPECIFIED"
Enum: "BACKUP_CONFIG_SUSPENDED_UNSPECIFIED" "TRUE" "FALSE"

Filter backup configs based on suspended flag.

  • BACKUP_CONFIG_SUSPENDED_UNSPECIFIED: List all backup configs.
  • TRUE: List only suspended backup configs.
  • FALSE: List only disabled backup configs.

Responses

Response samples

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

GetBackupConfig API returns the the backup configuration resource.

path Parameters
id
required
string

ID of the backup configuration.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "config": {
    },
  • "status": {
    }
}

DeleteBackupConfig API deletes the backup configuration.

path Parameters
id
required
string

ID of the backup configuration.

query Parameters
force
boolean

Force flag to delete backup configuration from control plane only.

Responses

Response samples

Content type
application/json
{ }

UpdateBackupConfig API updates the backup configuration of the backup.

path Parameters
id
required
string

ID of the backup configuration.

Request Body schema: application/json
required
suspend
string (v1BackupConfigSuspended)
Default: "BACKUP_CONFIG_SUSPENDED_UNSPECIFIED"
Enum: "BACKUP_CONFIG_SUSPENDED_UNSPECIFIED" "TRUE" "FALSE"

BackupConfigSuspended to accept value for suspended flag.

  • BACKUP_CONFIG_SUSPENDED_UNSPECIFIED: List all backup configs.
  • TRUE: List only suspended backup configs.
  • FALSE: List only disabled backup configs.
object

Labels to apply to the Backup Config object.

object

Annotations for the Backup Config object.

Responses

Request samples

Content type
application/json
{
  • "suspend": "BACKUP_CONFIG_SUSPENDED_UNSPECIFIED",
  • "labels": {
    },
  • "annotations": {
    }
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "config": {
    },
  • "status": {
    }
}

CreateBackupConfig API creates the backup configuration of the backup.

path Parameters
projectId
required
string

The parent project id under which backup configuration will be created.

Request Body schema: application/json
required
dataServiceDeploymentId
required
string

Data service Deployment id associated with the backup configuration.

required
object (v1BackupConfig)

Resource representing the backup configuration for a backup.

Responses

Request samples

Content type
application/json
{
  • "dataServiceDeploymentId": "string",
  • "backupConfig": {
    }
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "config": {
    },
  • "status": {
    }
}