Skip to main content
API docs by Redocly

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

Download OpenAPI specification:Download

ProjectService

List API lists all the projects for a tenant

query Parameters
tenantId
string

Tenant id for which projects to be listed.

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

Response data flags for listing projects.

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

Responses

Response samples

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

Update project api updates a project meta.

path Parameters
meta.uid
required
string

UID of the resource of the format -.

Request Body schema: application/json
required
object (Metadata of the project.)

Metadata of the project.

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
{
  • "meta": {
    }
}

Response samples

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

Get project apis returns a requested project.

path Parameters
projectId
required
string

Project id.

Responses

Response samples

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

Deletes a project and its associated resources.

path Parameters
projectId
required
string

ID of the project which needs to be deleted.

Responses

Response samples

Content type
application/json
{ }

AssociateResources will append the supplied resources to existing infra resources of a given project config.

path Parameters
projectId
required
string

ID of the project.

Request Body schema: application/json
required
object (v1Resources)

Infra resource are platform managed resources, used by associated applications.

clusters
Array of strings

Clusters represents the target k8s clusters.

namespaces
Array of strings

Namespaces created in k8s cluster to provide the logical isolation.

credentials
Array of strings

Credentials required to connect to a backup target.

backupLocations
Array of strings

Backup locations where backups can be placed.

templates
Array of strings

Templates can be used by applications to manage its resources.

backupPolicies
Array of strings

Backup Policies where the schedules are defined.

Responses

Request samples

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

Response samples

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

DisassociateResource will remove the infra resources supplied in the request from the project config.

path Parameters
projectId
required
string

ID of the project from which infra resources to be disassociated.

Request Body schema: application/json
required
object (v1Resources)

Infra resource are platform managed resources, used by associated applications.

clusters
Array of strings

Clusters represents the target k8s clusters.

namespaces
Array of strings

Namespaces created in k8s cluster to provide the logical isolation.

credentials
Array of strings

Credentials required to connect to a backup target.

backupLocations
Array of strings

Backup locations where backups can be placed.

templates
Array of strings

Templates can be used by applications to manage its resources.

backupPolicies
Array of strings

Backup Policies where the schedules are defined.

Responses

Request samples

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

Response samples

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

List API lists all the projects for a tenant

Request Body schema: application/json
required

ListProjectsRequest is the request message to the ListProjects API and it takes the multiple selector details for which the projects visible to the caller will be returned.

tenantId
string

Tenant id for which projects to be listed.

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.

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 (v1PageBasedPaginationRequest)

Request parameters for page-based pagination.

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

Response samples

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

Create project api creates a project.

path Parameters
tenantId
required
string

The parent tenant under which project will be created

Request Body schema: application/json
required
object (v1Project)

Project is a logical collection of objects and/or services that users can access.

object (v1Meta)

Meta holds general resource metadata.

object (v1Config)

Configuration represents the associated resource details for project.

object (projectv1Status)

Status represents the current state of the project.

Responses

Request samples

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

Response samples

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