Checks

Pipeline checks

get

Checks associated to a pipeline.

Authorizations

userproject

Path parameters

pipelineIDstring · uuidRequired

Query parameters

lastintegerOptional

Last files.

beforestringOptional

End cursor.

Responses

application/json

object[]Optional

Pipeline check model.

get

HTTPcURLJavaScriptPython

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": 1,
    "port": 1,
    "host": "localhost",
    "createdAt": "2025-04-24T08:30:59.938Z",
    "updatedAt": "2025-04-24T08:30:59.938Z"
  }
]

Create pipeline check

post

Create check within a pipeline.

Authorizations

userproject

Path parameters

pipelineIDstring · uuidRequired

Body

Create pipeline check request body.

protocolstring · enumRequired

Valid protocol types defined for a pipelines.

Available options:

statusstring · enumOptional

The status of a check.

Default: newAvailable options:

retriesnumberOptional

number of retries for the check before marking it as failed

Default: 3

hoststringRequired

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

Example: localhost

portnumber · max: 65535Required

valid 0-65535 port number

Responses

application/json

objectOptional

Created pipeline check response body.

post

HTTPcURLJavaScriptPython

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": 1,
  "host": "localhost",
  "port": 1
}

201

Created

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-04-24T08:30:59.938Z"
}