Skip to main content
API docs by Redocly

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

Download OpenAPI specification:Download

RestoreService

CreateRestore API creates the Restore resource.

path Parameters
namespaceId
required
string

UID of the namespace where restore will be created.

Request Body schema: application/json
required
projectId
required
string

UID of the project associated with the restore.

required
object (v1Restore)

Restore represents a data service restore.

Responses

Request samples

Content type
application/json
{
  • "projectId": "string",
  • "restore": {
    }
}

Response samples

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

ListRestore API lists the Restore resources.

query Parameters
tenantId
string

Tenant ID for which the restore will be listed.

projectId
string

Project ID for which the restore will be listed.

dataServiceDeploymentId
string

Deployment ID for which the restore will be listed.

backupId
string

Backup ID for which the restore will be listed.

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.
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.

Responses

Response samples

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

GetRestore API returns the Restore resource.

path Parameters
id
required
string

UID of the restore.

Responses

Response samples

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

RecreateRestore API recreates a already failed restore.

path Parameters
id
required
string

UID of the existing restore.

Request Body schema: application/json
required
name
required
string

Name of the restore.

projectId
required
string

UID of the project associated with the restore.

namespaceId
required
string

UID of namespace where restore will be created.

Responses

Request samples

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

Response samples

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