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.

get

/v1/cluster_object_regexes/{regexID}

Authorizations

userproject

Path parameters

regexIDstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://cloud-api.calyptia.com/v1/cluster_object_regexes/{regexID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "pipelineID": "123e4567-e89b-12d3-a456-426614174000",
  "regex": "text",
  "description": "text",
  "createdAt": "2025-03-12T04:22:38.437Z",
  "updatedAt": "2025-03-12T04:22:38.437Z",
  "clusterObjects": null
}

OK

Delete cluster object regex

Delete a single cluster object regex by its ID.

delete

/v1/cluster_object_regexes/{regexID}

Authorizations

userproject

Path parameters

regexIDstring · uuidrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://cloud-api.calyptia.com/v1/cluster_object_regexes/{regexID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

204

204

No body

No Content

Update cluster object regex

Update a cluster object regex details.

patch

/v1/cluster_object_regexes/{regexID}

Authorizations

userproject

Path parameters

regexIDstring · uuidrequired

Body

regexstring | nullable

descriptionstring | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://cloud-api.calyptia.com/v1/cluster_object_regexes/{regexID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "regex": null,
    "description": null
  }'

200

200

{
  "updatedAt": "2025-03-12T04:22:38.437Z"
}

Updated.