Cluster object regexes

Cluster object regex

Retrieve a single cluster object regex by ID. On this endpoint, all the matching cluser objects are also returned.

GEThttps://cloud-api.calyptia.com/v1/cluster_object_regexes/{regexID}

Authorization

userproject

Path parameters

regexID*string (uuid)

Response

200

OK

Body

application/json

id*string (uuid)

pipelineID*string (uuid)

regex*string

description*string

createdAt*string (date-time)

updatedAt*string (date-time)

clusterObjectsnullable array of ClusterObject (object)

Will only be present on the clusterObjectRegex operation.

Request

JavaScriptCurlPython

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

Response

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "pipelineID": "123e4567-e89b-12d3-a456-426614174000",
  "regex": "text",
  "description": "text",
  "createdAt": "2024-11-21T09:29:29.442Z",
  "updatedAt": "2024-11-21T09:29:29.442Z",
  "clusterObjects": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "kind": "namespace",
      "createdAt": "2024-11-21T09:29:29.442Z",
      "updatedAt": "2024-11-21T09:29:29.442Z"
    }
  ]
}

Delete cluster object regex

Delete a single cluster object regex by its ID.

DELETEhttps://cloud-api.calyptia.com/v1/cluster_object_regexes/{regexID}

Authorization

userproject

Path parameters

regexID*string (uuid)

Response

204

No Content

Request

JavaScriptCurlPython

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

Update cluster object regex

Update a cluster object regex details.

PATCHhttps://cloud-api.calyptia.com/v1/cluster_object_regexes/{regexID}

Authorization

userproject

Path parameters

regexID*string (uuid)

Body

application/json

regexnullable string

descriptionnullable string

Response

200

Updated.

Body

application/json

updatedAt*string (date-time)

Request

JavaScriptCurlPython

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

Response

200

{
  "updatedAt": "2024-11-21T09:29:29.442Z"
}