Skip to main content
API docs by Redocly

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

Download OpenAPI specification:Download

BackupService

ListBackups API lists the Backup resources.

query Parameters
dataServiceDeploymentId
string

Data service Deployment ID for which the backups will be listed.

backupConfigId
string

Backup Configuration ID for which the backups 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.

Responses

Response samples

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

GetBackup API returns the Backup resource.

path Parameters
id
required
string

UID of the Backup.

Responses

Response samples

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

DeleteBackup API deletes the Backup resource.

path Parameters
id
required
string

UID of the Backup.

query Parameters
force
boolean

Force flag to delete backup from control plane only.

Responses

Response samples

Content type
application/json
{ }