Skip to main content
API docs by Redocly

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

Download OpenAPI specification:Download

ApplicationService

UpdateApplication API updates specified application on the target cluster.

path Parameters
application.meta.uid
required
string

UID of the resource of the format -.

Request Body schema: application/json
required

application to be updated.

object (Metadata of the application(Resource Meta).)

Metadata of the application(Resource Meta).

object (v1Config)

Desired configuration of the Application.

object (applicationv1Status)

Status of the Application.

Responses

Request samples

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

Response samples

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

GetApplication API returns the info about application with given id.

path Parameters
id
required
string

Unique identifier of the application whose details needs to be fetched.

query Parameters
clusterId
string

Unique identifier of the cluster whose details needs to be fetched.

Responses

Response samples

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

UninstallApplication API uninstalls the specified application on the target cluster.

path Parameters
id
required
string

unique identifier of the application.

query Parameters
clusterId
string

Unique identifier of the cluster whose details needs to be fetched.

Responses

Response samples

Content type
application/json
{ }

ListApplications API lists the applications installed on the target cluster.

path Parameters
clusterId
required
string

Unique identifier of the cluster whose details needs to be fetched.

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.

Responses

Response samples

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

InstallApplication API installs specified application on the target cluster.

path Parameters
clusterId
required
string

unique identifier of the cluster where application needs to be installed

Request Body schema: application/json
required

application to be installed.

object (v1Meta)

Meta holds general resource metadata.

object (v1Config)

Desired configuration of the Application.

object (applicationv1Status)

Status of the Application.

Responses

Request samples

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

Response samples

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

GetApplication API returns the info about application with given id.

path Parameters
clusterId
required
string

Unique identifier of the cluster whose details needs to be fetched.

id
required
string

Unique identifier of the application whose details needs to be fetched.

Responses

Response samples

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

UninstallApplication API uninstalls the specified application on the target cluster.

path Parameters
clusterId
required
string

Unique identifier of the cluster whose details needs to be fetched.

id
required
string

unique identifier of the application.

Responses

Response samples

Content type
application/json
{ }