NVIDIA Run:ai

Clusters

Use these endpoints to create, manage and delete NVIDIA Run:ai Kubernetes clusters.

Get a list of clusters.

Retrieve a list of clusters with details.

SecuritybearerAuth
Request
query Parameters
verbosity
string
Default: "full"

response verbosity level.

Enum: "metadata" "full"
Example: verbosity=full
includeRequestedForDelete
boolean

When true, includes clusters that are marked for deletion

Example: includeRequestedForDelete=true
Responses
200

Executed successfully.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

get/api/v1/clusters
Response samples
application/json
[
  • {
    }
]

Create a cluster.

Use to create a Kubernetes cluster.

SecuritybearerAuth
Request
Request Body schema: application/json
required

The cluster to create.

name
required
string
domain
string
version
string
Responses
201

Created

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

post/api/v1/clusters
Request samples
application/json
{
  • "name": "string",
  • "domain": "string",
  • "version": "string"
}
Response samples
application/json
{
  • "uuid": "A0EEBC99-9C0B-4EF8-BB6D-6BB9BD380A11",
  • "name": "example",
  • "tenantId": 1001,
  • "domain": "my.company.com",
  • "status": { },
  • "createdAt": "2020-01-01T00:00:00Z",
  • "updatedAt": "2020-01-02T00:00:00Z",
  • "lastLiveness": "2020-01-02T00:00:00Z",
  • "version": "2.15.0"
}

Get cluster by id.

Retrieve cluster details by Universally Unique Identifier (UUID).

SecuritybearerAuth
Request
path Parameters
clusterUuid
required
string <uuid> non-empty

The Universally Unique Identifier (UUID) of the cluster.

Example: 9f55255e-11ed-47c7-acef-fc4054768dbc
query Parameters
verbosity
string
Default: "full"

response verbosity level.

Enum: "metadata" "full"
Example: verbosity=full
Responses
200

Executed successfully.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

get/api/v1/clusters/{clusterUuid}
Response samples
application/json
{
  • "uuid": "A0EEBC99-9C0B-4EF8-BB6D-6BB9BD380A11",
  • "name": "example",
  • "tenantId": 1001,
  • "domain": "my.company.com",
  • "status": { },
  • "createdAt": "2020-01-01T00:00:00Z",
  • "updatedAt": "2020-01-02T00:00:00Z",
  • "lastLiveness": "2020-01-02T00:00:00Z",
  • "version": "2.15.0"
}

Delete a cluster by id.

Use to delete a cluster by Universally Unique Identifier (UUID). Will return 202 for success if this api was called on a cluster that its version is >=2.20, and force query param is false or not provided. Will return 204 for success if force query param is true, or if cluster is in a version < 2.20

SecuritybearerAuth
Request
path Parameters
clusterUuid
required
string <uuid> non-empty

The Universally Unique Identifier (UUID) of the cluster.

Example: 9f55255e-11ed-47c7-acef-fc4054768dbc
query Parameters
force
boolean
Default: false

if true will force cluster instant deletion otherwise will start cluster graceful deletion process.

Example: force=true
Responses
202

Accepted.

204

No Content.

401

Unauthorized

403

Forbidden

500

unexpected error

503

unexpected error

delete/api/v1/clusters/{clusterUuid}
Response samples
application/json
{
  • "code": 202,
  • "message": "Request has been accepted."
}

Update a cluster by id.

Use to update the details of a Kubernetes cluster by Universally Unique Identifier (UUID).

SecuritybearerAuth
Request
path Parameters
clusterUuid
required
string <uuid> non-empty

The Universally Unique Identifier (UUID) of the cluster.

Example: 9f55255e-11ed-47c7-acef-fc4054768dbc
Request Body schema: application/json
required

The cluster details to update

name
required
string
Responses
204

No Content.

400

Bad request.

401

Unauthorized

403

Forbidden

500

unexpected error

503

unexpected error

put/api/v1/clusters/{clusterUuid}
Request samples
application/json
{
  • "name": "string"
}
Response samples
application/json
{
  • "code": 400,
  • "message": "Required parameter is missing"
}

Retrieve the installation instructions of a cluster by ID.

Use to retrieve installation instruction for a cluster by Universally Unique Identifier (UUID). Supports clusters version 2.15 or above.

SecuritybearerAuth
Request
path Parameters
clusterUuid
required
string <uuid> non-empty

The Universally Unique Identifier (UUID) of the cluster.

Example: 9f55255e-11ed-47c7-acef-fc4054768dbc
query Parameters
version
required
string

The cluster version to install

Example: version=2.16
remoteClusterUrl
string

The remote URL of the runai cluster

Example: remoteClusterUrl=https://cluster.runai
Responses
200

Executed successfully.

401

Unauthorized

403

Forbidden

404

The specified resource was not found

500

unexpected error

503

unexpected error

get/api/v1/clusters/{clusterUuid}/cluster-install-info
Response samples
application/json
{
  • "installationStr": "helm update --update repo/runai-cluster -n runai --set cluster.url=test_cluster",
  • "repositoryName": "runai",
  • "chartRepoURL": "https://runai.jfrog.io/artifactory/charts",
  • "clientSecret": "ABC333DDD"
}
➔ Next to Tenant