Checks
Checks associated to a pipeline.
Authorizations
Path parameters
pipelineIDstring · uuidRequired
Query parameters
lastintegerOptional
Last files.
beforestringOptional
End cursor.
Responses
200
OK
application/json
get
GET /v1/pipelines/{pipelineID}/checks 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-28T01:19:31.049Z",
"updatedAt": "2025-06-28T01:19:31.049Z"
}
]
Create check within a pipeline.
Authorizations
Path parameters
pipelineIDstring · uuidRequired
Body
Create pipeline check request body.
protocolstring · enumRequiredPossible values:
Valid protocol types defined for a pipelines.
statusstring · enumOptionalDefault:
The status of a check.
new
Possible values: retriesnumberOptionalDefault:
number of retries for the check before marking it as failed
3
hoststringRequiredExample:
DNS label format as of defined on RFC1123 or an IPv4 address.
localhost
portnumber · max: 65535Required
valid 0-65535 port number
Responses
201
Created
application/json
post
POST /v1/pipelines/{pipelineID}/checks 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": 3,
"host": "localhost",
"port": 1
}
201
Created
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"createdAt": "2025-06-28T01:19:31.049Z"
}