Pipeline checks

Pipeline check

Check by ID.

get

/v1/pipeline_checks/{checkID}

Authorizations

userproject

Path parameters

checkIDstring · uuidrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "protocol": "tcp",
  "status": "new",
  "retries": 3,
  "port": 1,
  "host": "localhost",
  "createdAt": "2025-03-12T02:02:08.773Z",
  "updatedAt": "2025-03-12T02:02:08.773Z"
}

OK

Delete pipeline check

Delete pipeline check by its ID.

delete

/v1/pipeline_checks/{checkID}

Authorizations

userproject

Path parameters

checkIDstring · uuidrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

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

204

204

No body

No Content

Update pipeline check

Update check by its ID.

patch

/v1/pipeline_checks/{checkID}

Authorizations

userproject

Path parameters

checkIDstring · uuidrequired

Body

protocolstring · enum | nullable

Valid protocol types defined for a pipelines.

Options: tcp, udp

statusstring · enum | nullable

The status of a check.

Options: new, failed, running, ok

retriesnumber | nullable

number of retries for the check before marking it as unreachable.

hoststring | nullable

DNS label format as of defined on RFC1123 or an IPv4 address.

Example: localhost

portnumber | nullable

valid 0-65535 port number

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://cloud-api.calyptia.com/v1/pipeline_checks/{checkID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "protocol": null,
    "status": null,
    "retries": null,
    "host": "localhost",
    "port": null
  }'

204

204

No body

No Content