Skip to main content
API docs by Redocly

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

Download OpenAPI specification:Download

TemplateService

List API lists all the templates for a tenant

query Parameters
tenantId
string

Tenant ID for which the credentials 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 templates.

  • 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
{
  • "templates": [
    ],
  • "pagination": {
    }
}

Get API returns the template details sans the actual credentials.

path Parameters
id
required
string

ID of the template instance.

Responses

Response samples

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

Delete API deletes the templates.

path Parameters
id
required
string

ID of the template instance.

Responses

Response samples

Content type
application/json
{ }

Update API updates a template.

path Parameters
template.meta.uid
required
string

UID of the resource of the format -.

Request Body schema: application/json
required
object (Desired template configuration.)

Desired template configuration.

object (Metadata of the resource.)

Metadata of the resource.

object (v1Config)

Config provides configuration data of the template instance.

object (templatev1Status)

Status provides the current status of template.

Responses

Request samples

Content type
application/json
{
  • "template": {
    }
}

Response samples

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

List API lists all the templates for a tenant

Request Body schema: application/json
required

Request to list the templates for a tenant.

tenantId
string

Tenant ID for which the credentials 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
{
  • "templates": [
    ],
  • "pagination": {
    }
}

Create API creates a set of templates for a tenant.

path Parameters
tenantId
required
string

The parent tenant id under which template will be created.

Request Body schema: application/json
required

Information about the template instance that needs to be created.

object (v1Meta)

Meta holds general resource metadata.

object (v1Config)

Config provides configuration data of the template instance.

object (templatev1Status)

Status provides the current status of template.

Responses

Request samples

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

Response samples

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