Support PortalCalyptia CoreContact Us

Cluster objects

Get a list of cluster objects associated to a pipeline.

get

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

Authorizations
Path parameters
pipelineIDstring · uuidRequired
Query parameters
lastintegerOptional

Last cluster objects.

beforestringOptional

Cluster objects before the given cursor.

Responses
200
OK
application/json
get
GET /v1/pipelines/{pipelineID}/cluster_objects HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "kind": "namespace",
    "createdAt": "2025-06-27T22:25:12.721Z",
    "updatedAt": "2025-06-27T22:25:12.721Z"
  }
]

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

delete

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

Authorizations
Path parameters
pipelineIDstring · uuidRequired
Query parameters
cluster_object_idstring · uuid[]Optional

List of cluster object IDs to delete.

Responses
204
Deleted
delete
DELETE /v1/pipelines/{pipelineID}/cluster_objects HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
204

Deleted

No content

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

patch

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

Authorizations
Path parameters
pipelineIDstring · uuidRequired
Body
clusterObjectsIDsstring[]Optional
Responses
204
No Content
patch
PATCH /v1/pipelines/{pipelineID}/cluster_objects HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "clusterObjectsIDs": [
    "text"
  ]
}
204

No Content

No content
PreviousChecksNextMetadata