API Reference

Diagnostics

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Endpoint Healthchecks

List Endpoint Health Checks

GET/accounts/{account_id}/diagnostics/endpoint-healthchecks

Endpoint Health Check

POST/accounts/{account_id}/diagnostics/endpoint-healthchecks

Get Endpoint Health Check

GET/accounts/{account_id}/diagnostics/endpoint-healthchecks/{id}

Delete Endpoint Health Check

DELETE/accounts/{account_id}/diagnostics/endpoint-healthchecks/{id}

Update Endpoint Health Check

PUT/accounts/{account_id}/diagnostics/endpoint-healthchecks/{id}

ModelsExpand Collapse

EndpointHealthcheck object { check_type, endpoint, name }

check_type: "icmp"

type of check to perform

endpoint: string

the IP address of the host to perform checks against

name: optional string

Optional name associated with this check

EndpointHealthcheckListResponse object { check_type, endpoint, id, name }

check_type: "icmp"

type of check to perform

endpoint: string

the IP address of the host to perform checks against

id: optional string

UUID.

maxLength36

name: optional string

Optional name associated with this check

EndpointHealthcheckCreateResponse object { check_type, endpoint, id, name }

check_type: "icmp"

type of check to perform

endpoint: string

the IP address of the host to perform checks against

id: optional string

UUID.

maxLength36

name: optional string

Optional name associated with this check

EndpointHealthcheckGetResponse object { check_type, endpoint, id, name }

check_type: "icmp"

type of check to perform

endpoint: string

the IP address of the host to perform checks against

id: optional string

UUID.

maxLength36

name: optional string

Optional name associated with this check

EndpointHealthcheckDeleteResponse object { errors, messages, success }

errors: array of object { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

messages: array of object { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

success: true

Whether the API call was successful.

EndpointHealthcheckUpdateResponse object { check_type, endpoint, id, name }

check_type: "icmp"

type of check to perform

endpoint: string

the IP address of the host to perform checks against

id: optional string

UUID.

maxLength36

name: optional string

Optional name associated with this check