Skip to main content
API docs by Redocly

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

Download OpenAPI specification:Download

NamespaceService

List API lists all the namespaces for a tenant

query Parameters
tenantId
string

tenant ID for which namespace need to be fetched.

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

Response data flags for listing cloud credentials.

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

DeleteNamespace API will trigger deletion and cleanup on the control plane.

path Parameters
id
required
string

ID of the namespace instance.

Responses

Response samples

Content type
application/json
{ }

List API lists all the namespaces for a tenant

Request Body schema: application/json
required

ListNamespacesRequest request message for the ListNamespaces API.

tenantId
string

tenant ID for which namespace need to be fetched.

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.

object (v1PageBasedPaginationRequest)

Request parameters for page-based pagination.

Responses

Request samples

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

Response samples

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