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

client.diagnostics.endpointHealthchecks.list(EndpointHealthcheckListParams { account_id } params, RequestOptionsoptions?): EndpointHealthcheckListResponse { check_type, endpoint, id, name }

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

Endpoint Health Check

client.diagnostics.endpointHealthchecks.create(EndpointHealthcheckCreateParams { account_id, check_type, endpoint, name } params, RequestOptionsoptions?): EndpointHealthcheckCreateResponse { check_type, endpoint, id, name }

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

Get Endpoint Health Check

client.diagnostics.endpointHealthchecks.get(stringid, EndpointHealthcheckGetParams { account_id } params, RequestOptionsoptions?): EndpointHealthcheckGetResponse { check_type, endpoint, id, name }

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

Delete Endpoint Health Check

client.diagnostics.endpointHealthchecks.delete(stringid, EndpointHealthcheckDeleteParams { account_id } params, RequestOptionsoptions?): EndpointHealthcheckDeleteResponse { errors, messages, success }

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

Update Endpoint Health Check

client.diagnostics.endpointHealthchecks.update(stringid, EndpointHealthcheckUpdateParams { account_id, check_type, endpoint, name } params, RequestOptionsoptions?): EndpointHealthcheckUpdateResponse { check_type, endpoint, id, name }

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

ModelsExpand Collapse

EndpointHealthcheck { 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?: string

Optional name associated with this check

EndpointHealthcheckListResponse { 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?: string

UUID.

maxLength36

name?: string

Optional name associated with this check

EndpointHealthcheckCreateResponse { 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?: string

UUID.

maxLength36

name?: string

Optional name associated with this check

EndpointHealthcheckGetResponse { 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?: string

UUID.

maxLength36

name?: string

Optional name associated with this check

EndpointHealthcheckDeleteResponse { errors, messages, success }

errors: Array<Error>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

messages: Array<Message>

code: number

minimum1000

message: string

documentation_url?: string

source?: Source { pointer }

pointer?: string

success: true

Whether the API call was successful.

EndpointHealthcheckUpdateResponse { 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?: string

UUID.

maxLength36

name?: string

Optional name associated with this check