Skip to content
Cloudflare API
Start here
API Reference
Diagnostics

Endpoint Healthchecks

List Endpoint Health Checks
diagnostics.endpoint_healthchecks.list(EndpointHealthcheckListParams**kwargs) -> EndpointHealthcheckListResponse
GET/accounts/{account_id}/diagnostics/endpoint-healthchecks
Endpoint Health Check
diagnostics.endpoint_healthchecks.create(EndpointHealthcheckCreateParams**kwargs) -> EndpointHealthcheckCreateResponse
POST/accounts/{account_id}/diagnostics/endpoint-healthchecks
Get Endpoint Health Check
diagnostics.endpoint_healthchecks.get(strid, EndpointHealthcheckGetParams**kwargs) -> EndpointHealthcheckGetResponse
GET/accounts/{account_id}/diagnostics/endpoint-healthchecks/{id}
Delete Endpoint Health Check
diagnostics.endpoint_healthchecks.delete(strid, EndpointHealthcheckDeleteParams**kwargs) -> EndpointHealthcheckDeleteResponse
DELETE/accounts/{account_id}/diagnostics/endpoint-healthchecks/{id}
Update Endpoint Health Check
diagnostics.endpoint_healthchecks.update(strid, EndpointHealthcheckUpdateParams**kwargs) -> EndpointHealthcheckUpdateResponse
PUT/accounts/{account_id}/diagnostics/endpoint-healthchecks/{id}
ModelsExpand Collapse
class EndpointHealthcheck: …
check_type: Literal["icmp"]

type of check to perform

endpoint: str

the IP address of the host to perform checks against

name: Optional[str]

Optional name associated with this check

class EndpointHealthcheckListResponse: …
check_type: Literal["icmp"]

type of check to perform

endpoint: str

the IP address of the host to perform checks against

id: Optional[str]

UUID.

maxLength36
name: Optional[str]

Optional name associated with this check

class EndpointHealthcheckCreateResponse: …
check_type: Literal["icmp"]

type of check to perform

endpoint: str

the IP address of the host to perform checks against

id: Optional[str]

UUID.

maxLength36
name: Optional[str]

Optional name associated with this check

class EndpointHealthcheckGetResponse: …
check_type: Literal["icmp"]

type of check to perform

endpoint: str

the IP address of the host to perform checks against

id: Optional[str]

UUID.

maxLength36
name: Optional[str]

Optional name associated with this check

class EndpointHealthcheckDeleteResponse: …
errors: List[Error]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[ErrorSource]
pointer: Optional[str]
messages: List[Message]
code: int
minimum1000
message: str
documentation_url: Optional[str]
source: Optional[MessageSource]
pointer: Optional[str]
success: Literal[true]

Whether the API call was successful.

class EndpointHealthcheckUpdateResponse: …
check_type: Literal["icmp"]

type of check to perform

endpoint: str

the IP address of the host to perform checks against

id: Optional[str]

UUID.

maxLength36
name: Optional[str]

Optional name associated with this check