Core instance checks

Core Instance check

Check by ID.

GEThttps://cloud-api.calyptia.com/v1/core_instance_checks/{checkID}
Authorization
Path parameters
checkID*string (uuid)
Response

OK

Body
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

host*string

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

Example: "localhost"
port*number
createdAt*string (date-time)
updatedAt*string (date-time)
Request
const response = await fetch('https://cloud-api.calyptia.com/v1/core_instance_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": 0,
  "host": "localhost",
  "port": 0,
  "createdAt": "2024-12-22T05:07:36.511Z",
  "updatedAt": "2024-12-22T05:07:36.511Z"
}

Delete core instance check

Delete core instance check by its ID.

DELETEhttps://cloud-api.calyptia.com/v1/core_instance_checks/{checkID}
Authorization
Path parameters
checkID*string (uuid)
Response

No Content

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

Update core instance check

Update check by its ID.

PATCHhttps://cloud-api.calyptia.com/v1/core_instance_checks/{checkID}
Authorization
Path parameters
checkID*string (uuid)
Body
protocolPipelinePortProtocol (enum)

Valid protocol types defined for a pipelines.

tcpudp
statusCheckStatus (enum)

The status of a check.

newfailedrunningok
hostnullable string

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

Example: "localhost"
portnullable number

valid 0-65535 port number

retriesnullable number

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

Response

No Content

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