Checks

Pipeline checks

Checks associated to a pipeline.

get

/v1/pipelines/{pipelineID}/checks

Authorizations

userproject

Path parameters

pipelineIDstring · uuidrequired

Query parameters

lastinteger

Last files.

beforestring

End cursor.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://cloud-api.calyptia.com/v1/pipelines/{pipelineID}/checks' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

200

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "protocol": "tcp",
    "status": "new",
    "retries": 3,
    "port": 1,
    "host": "localhost",
    "createdAt": "2025-03-12T04:26:33.012Z",
    "updatedAt": "2025-03-12T04:26:33.012Z"
  }
]

OK

Create pipeline check

Create check within a pipeline.

post

/v1/pipelines/{pipelineID}/checks

Authorizations

userproject

Path parameters

pipelineIDstring · uuidrequired

Body

protocolstring · enumrequired

Valid protocol types defined for a pipelines.

Options: tcp, udp

statusstring · enum · default: new

The status of a check.

Options: new, failed, running, ok

retriesnumber · default: 3

number of retries for the check before marking it as failed

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

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://cloud-api.calyptia.com/v1/pipelines/{pipelineID}/checks' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "protocol": "tcp",
    "status": "new",
    "retries": 3,
    "host": "localhost",
    "port": 1
  }'

201

201

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-03-12T04:26:33.012Z"
}

Created