Pipeline checks

Pipeline check

Check by ID.

GEThttps://cloud-api.calyptia.com/v1/pipeline_checks/{checkID}

Authorization

userproject

Path parameters

checkID*string (uuid)

Response

200

OK

Body

application/json

id*string (uuid)

protocol*PipelinePortProtocol (enum)

Valid protocol types defined for a pipelines.

tcpudp

status*CheckStatus (enum)

The status of a check.

newfailedrunningok

retries*number

number of retries for the check before marking it as failed

port*number

valid 0-65535 port number

host*string

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

createdAt*string (date-time)

updatedAt*string (date-time)

Request

JavaScriptCurl

const response = await fetch('https://cloud-api.calyptia.com/v1/pipeline_checks/{checkID}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "protocol": "tcp",
  "status": "new",
  "retries": 3,
  "port": 0,
  "host": "localhost",
  "createdAt": "2024-04-26T23:09:21.237Z",
  "updatedAt": "2024-04-26T23:09:21.237Z"
}

Delete pipeline check

Delete pipeline check by its ID.

DELETEhttps://cloud-api.calyptia.com/v1/pipeline_checks/{checkID}

Authorization

userproject

Path parameters

checkID*string (uuid)

Response

204

No Content

Request

JavaScriptCurl

const response = await fetch('https://cloud-api.calyptia.com/v1/pipeline_checks/{checkID}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Update pipeline check

Update check by its ID.

PATCHhttps://cloud-api.calyptia.com/v1/pipeline_checks/{checkID}

Authorization

userproject

Path parameters

checkID*string (uuid)

Body

application/json

protocolPipelinePortProtocol (enum)

Valid protocol types defined for a pipelines.

tcpudp

statusCheckStatus (enum)

The status of a check.

newfailedrunningok

retriesnullable number

number of retries for the check before marking it as unreachable.

hostnullable string

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

portnullable number

valid 0-65535 port number

Response

204

No Content

Request

JavaScriptCurl

const response = await fetch('https://cloud-api.calyptia.com/v1/pipeline_checks/{checkID}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();