Pipeline checks

Pipeline check

get

Check by ID.

Authorizations

userproject

Path parameters

checkIDstring · uuidRequired

Responses

200

OK

application/json

get

HTTPcURLJavaScriptPython

GET /v1/pipeline_checks/{checkID} HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "protocol": "tcp",
  "status": "new",
  "retries": 3,
  "port": 1,
  "host": "localhost",
  "createdAt": "2025-06-06T01:22:56.743Z",
  "updatedAt": "2025-06-06T01:22:56.743Z"
}

Delete pipeline check

delete

Delete pipeline check by its ID.

Authorizations

userproject

Path parameters

checkIDstring · uuidRequired

Responses

204

No Content

delete

HTTPcURLJavaScriptPython

DELETE /v1/pipeline_checks/{checkID} HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

No content

Update pipeline check

patch

Update check by its ID.

Authorizations

userproject

Path parameters

checkIDstring · uuidRequired

Body

Update pipeline check request body.

protocolstring · enum | nullableOptional

Valid protocol types defined for a pipelines.

Default: nullPossible values:

statusstring · enum | nullableOptional

The status of a check.

Default: nullPossible values:

retriesnumber | nullableOptional

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

Default: null

hoststring | nullableOptional

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

Default: nullExample: localhost

portnumber | nullableOptional

valid 0-65535 port number

Default: null

Responses

204

No Content

patch

HTTPcURLJavaScriptPython

PATCH /v1/pipeline_checks/{checkID} HTTP/1.1
Host: cloud-api.calyptia.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "protocol": "tcp",
  "status": "new",
  "retries": 1,
  "host": "localhost",
  "port": 1
}

204

No Content

No content