Skip to main content
API docs by Redocly

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

Download OpenAPI specification:Download

BackupPolicyService

List API lists all the backup policies for a Tenant (Organization)

query Parameters
tenantId
string

Tenant (Organization) ID for which the backup policies 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.
respData
string
Default: "RESP_DATA_UNSPECIFIED"
Enum: "RESP_DATA_UNSPECIFIED" "INDEX" "LITE" "FULL"

Response data flags for listing backup policies.

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

Responses

Response samples

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

Get API returns the backup policy for the given ID.

path Parameters
id
required
string

ID of the schedule.

Responses

Response samples

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

Delete API deletes a backup policy.

path Parameters
id
required
string

ID of the backup policy.

Responses

Response samples

Content type
application/json
{ }

Update API updates a the meta data of a backup policy.

path Parameters
meta.uid
required
string

UID of the resource of the format -.

Request Body schema: application/json
required

Metadata of the backup policy to be updated.

name
string

Name of the resource.

description
string

Description of the resource.

resourceVersion
string

A string that identifies the version of this object that can be used by clients to determine when objects have changed. This value must be passed unmodified back to the server by the client.

object

Labels to apply to the object.

object

Annotations for the object.

object (v1Reference)

Reference identifies the resource type, version of the uid and the resource.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "resourceVersion": "string",
  • "labels": {
    },
  • "annotations": {
    },
  • "parentReference": {
    }
}

Response samples

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

List API lists all the backup policies for a Tenant (Organization)

Request Body schema: application/json
required

Request to list the backup policies for a Tenant (Organization).

tenantId
string

Tenant (Organization) ID for which the backup policies 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.

object (v1Sort)

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

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.

Responses

Request samples

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

Response samples

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

Create API creates a backup policy for a Tenant (Organization).

path Parameters
tenantId
required
string

The parent Tenant (Organization) id under which schedule will be created.

Request Body schema: application/json
required

Backup Policy configuration.

object (v1Meta)

Meta holds general resource metadata.

object (v1Config)

Desired configuration of the backup policy.

Responses

Request samples

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

Response samples

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