Skip to main content
API docs by Redocly

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

Download OpenAPI specification:Download

TenantService

ListTenants API lists the Tenants (Organizations) visible to the caller for the current account.

query Parameters
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 the behaviour of the list response attributes.

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

CreateTenant API creates a new Tenant (Organization).

Request Body schema: application/json
required

Tenant (Organization) details which to be created.

object (v1Meta)

Meta holds general resource metadata.

object (tenantv1Status)

Status represents the current state of the Tenant (Organization).

Responses

Request samples

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

Response samples

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

UpdateTenant API updates Tenant (Organization).

path Parameters
tenant.meta.uid
required
string

UID of the resource of the format -.

Request Body schema: application/json
required

Tenant (Organization) which needs to be updated.

object (Metadata of the Tenant (Organization).)

Metadata of the Tenant (Organization).

object (tenantv1Status)

Status represents the current state of the Tenant (Organization).

Responses

Request samples

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

Response samples

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

GetTenant API returns the info about for given Tenant (Organization) id.

path Parameters
tenantId
required
string

ID of the Tenant (Organization) which needs to get info.

Responses

Response samples

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

DeleteTenant removes a Tenant (Organization) record.

path Parameters
tenantId
required
string

ID of the Tenant (Organization) which needs to be deleted.

Responses

Response samples

Content type
application/json
{ }

GetResourceCount will fetch the count of each resource under the given Tenant (Organization).

path Parameters
tenantId
required
string

Tenant (Organization) id for which the resource count has to be listed.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "project": 0,
  • "targetCluster": 0,
  • "namespace": 0,
  • "credential": 0,
  • "backupLocation": 0,
  • "backupPolicy": 0,
  • "template": 0,
  • "dataServiceDeployment": 0,
  • "backup": 0,
  • "restore": 0
}

ListTenants API lists the Tenants (Organizations) visible to the caller for the current account.

Request Body schema: application/json
required

ListTenantsRequest is the request message to the ListTenants API.

object (v1PageBasedPaginationRequest)

Request parameters for page-based pagination.

object (v1ResourceSelector)

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

object (v1Selector)

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

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
{
  • "pagination": {
    },
  • "resourceSelector": {
    },
  • "fieldSelector": {
    },
  • "respData": "RESP_DATA_UNSPECIFIED",
  • "sort": {
    }
}

Response samples

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