Pipeline checks
Check by ID.
Authorizations
Path parameters
checkIDstring · uuidRequired
Responses
200
OK
application/json
get
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-28T00:28:15.989Z",
"updatedAt": "2025-06-28T00:28:15.989Z"
}
Update check by its ID.
Authorizations
Path parameters
checkIDstring · uuidRequired
Body
Update pipeline check request body.
protocolstring · enum | nullableOptionalDefault:
Valid protocol types defined for a pipelines.
null
Possible values: statusstring · enum | nullableOptionalDefault:
The status of a check.
null
Possible values: retriesnumber | nullableOptionalDefault:
number of retries for the check before marking it as unreachable.
null
hoststring | nullableOptionalDefault:
DNS label format as of defined on RFC1123 or an IPv4 address.
null
Example: localhost
portnumber | nullableOptionalDefault:
valid 0-65535 port number
null
Responses
204
No Content
patch
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