Cluster objects

Get a list of cluster objects associated to a pipeline.

Get a list of all the cluster objects that are associated to a pipeline.

GEThttps://cloud-api.calyptia.com/v1/pipelines/{pipelineID}/cluster_objects

Authorization

userproject

Path parameters

pipelineID*string (uuid)

Query parameters

Response

200

OK

Headers

Body

application/json

id*string (uuid)

name*string (kubernetes label)

kind*ClusterObjectKind (enum)

Kind of the kubernetes object

namespace

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('https://cloud-api.calyptia.com/v1/pipelines/{pipelineID}/cluster_objects', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "kind": "namespace",
    "createdAt": "2024-09-16T19:05:34.813Z",
    "updatedAt": "2024-09-16T19:05:34.813Z"
  }
]

Remove the relation between the cluster objects and the given pipeline.

Remove the relation between the cluster objects and the pipeline (only for daemonSet kind).

DELETEhttps://cloud-api.calyptia.com/v1/pipelines/{pipelineID}/cluster_objects

Authorization

userproject

Path parameters

pipelineID*string (uuid)

Query parameters

Response

204

Deleted

Request

JavaScriptCurlPython

const response = await fetch('https://cloud-api.calyptia.com/v1/pipelines/{pipelineID}/cluster_objects', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Update the cluster objects related to a pipeline (only for daemonSet kind).

Updates a pipeline to be related to a set of given cluster objects this is only supported for pipelines of kind daemonSet.

PATCHhttps://cloud-api.calyptia.com/v1/pipelines/{pipelineID}/cluster_objects

Authorization

userproject

Path parameters

pipelineID*string (uuid)

Body

application/json

clusterObjectsIDsarray of string

Response

204

No Content

Request

JavaScriptCurlPython

const response = await fetch('https://cloud-api.calyptia.com/v1/pipelines/{pipelineID}/cluster_objects', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();