Checks
Checks associated to a core instance.
Authorizations
Path parameters
coreInstanceIDstring · uuidRequired
Query parameters
lastintegerOptional
Last checks.
beforestringOptional
End cursor.
Responses
200
OK
application/json
get
GET /v1/core_instances/{coreInstanceID}/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": 0,
"host": "localhost",
"port": 1,
"createdAt": "2025-06-28T00:54:29.207Z",
"updatedAt": "2025-06-28T00:54:29.207Z"
}
]
Create check within a core instance.
Authorizations
Path parameters
coreInstanceIDstring · uuidRequired
Body
Create core instance 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
portnumberRequired
valid 0-65535 port number
Responses
201
Created
application/json
post
POST /v1/core_instances/{coreInstanceID}/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-28T00:54:29.207Z"
}