Skip to main content
API docs by Redocly

public/portworx/platform/backuplocation/apiv1/backuplocation.proto (version not set)

Download OpenAPI specification:Download

BackupLocationService

List API lists all the backup locations for a tenant

query Parameters
tenantId
string

Tenant ID for which the backup locations 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.

respData
string
Default: "RESP_DATA_UNSPECIFIED"
Enum: "RESP_DATA_UNSPECIFIED" "INDEX" "LITE" "FULL"

Response data flags for listing backup locations.

  • RESP_DATA_UNSPECIFIED: RespData Unspecified. complete resource will be populated.
  • INDEX: only uid, name, labels should be populated.
  • LITE: only meta data should be populated.
  • FULL: complete resource should be populated.
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
{
  • "backupLocations": [
    ],
  • "pagination": {
    }
}

Get API returns the backup location.

path Parameters
id
required
string

ID of the backup location.

Responses

Response samples

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

Delete API deletes a backup location.

path Parameters
id
required
string

ID of the backup location.

Responses

Response samples

Content type
application/json
{ }

Update API updates a backup location.

path Parameters
id
required
string

ID of the backup location.

query Parameters
updateMask
string

Specifies the field that should be updated to the value specified in backup_location.

Request Body schema: application/json
required

Desired backup location configuration.

object (v1Meta)

Meta holds general resource metadata.

object (platformbackuplocationv1Config)

Desired configuration of the backup location.

object (backuplocationv1Status)

Status of the backup location.

Responses

Request samples

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

Response samples

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

List API lists all the backup locations for a tenant

Request Body schema: application/json
required

Request to list the backup locations for a tenant or a project.

tenantId
string

Tenant ID for which the backup locations will be listed.

object (v1PageBasedPaginationRequest)

Request parameters for page-based pagination.

object (v1Selector)

Selector is used to query resources using the associated labels or field names.

object (v1Selector)

Selector is used to query resources using the associated labels or field names.

object (v1ResourceSelector)

ResourceSelector is used to query resources using the associated infra resources.

respData
string (v1RespData)
Default: "RESP_DATA_UNSPECIFIED"
Enum: "RESP_DATA_UNSPECIFIED" "INDEX" "LITE" "FULL"

RespData provides flags which provides info about the fields that should be populated in the response.

  • RESP_DATA_UNSPECIFIED: RespData Unspecified. complete resource will be populated.
  • INDEX: only uid, name, labels should be populated.
  • LITE: only meta data should be populated.
  • FULL: complete resource should be populated.
object (v1Sort)

The details of the attribute for which the requested list of resource to be sorted.

Responses

Request samples

Content type
application/json
{
  • "tenantId": "string",
  • "pagination": {
    },
  • "labelSelector": {
    },
  • "fieldSelector": {
    },
  • "infraResourceSelector": {
    },
  • "respData": "RESP_DATA_UNSPECIFIED",
  • "sort": {
    }
}

Response samples

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

Create API creates a backup location for a tenant.

path Parameters
tenantId
required
string

The parent tenant id under which backup location will be created.

Request Body schema: application/json
required

Backup location configuration.

object (v1Meta)

Meta holds general resource metadata.

object (platformbackuplocationv1Config)

Desired configuration of the backup location.

object (backuplocationv1Status)

Status of the backup location.

Responses

Request samples

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

Response samples

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