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.
"localhost"
port*number
createdAt*string (date-time)
updatedAt*string (date-time)
Request
Response
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
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.
"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