Skip to content
Cloudflare API
Start here
API Reference

Diagnostics

DiagnosticsTraceroutes

Traceroute
diagnostics.traceroutes.create(TracerouteCreateParams**kwargs) -> SyncSinglePage[Traceroute]
POST/accounts/{account_id}/diagnostics/traceroute
ModelsExpand Collapse
class Traceroute: …
colos: Optional[List[Colo]]
colo: Optional[ColoColo]
city: Optional[str]

Source colo city.

name: Optional[str]

Source colo name.

error: Optional[Literal["", "Could not gather traceroute data: Code 1", "Could not gather traceroute data: Code 2", 2 more]]

Errors resulting from collecting traceroute from colo to target.

One of the following:
""
"Could not gather traceroute data: Code 1"
"Could not gather traceroute data: Code 2"
"Could not gather traceroute data: Code 3"
"Could not gather traceroute data: Code 4"
hops: Optional[List[ColoHop]]
nodes: Optional[List[ColoHopNode]]

An array of node objects.

asn: Optional[str]

AS number associated with the node object.

ip: Optional[str]

IP address of the node.

labels: Optional[List[str]]

Field appears if there is an additional annotation printed when the probe returns. Field also appears when running a GRE+ICMP traceroute to denote which traceroute a node comes from.

max_rtt_ms: Optional[float]

Maximum RTT in ms.

mean_rtt_ms: Optional[float]

Mean RTT in ms.

min_rtt_ms: Optional[float]

Minimum RTT in ms.

name: Optional[str]

Host name of the address, this may be the same as the IP address.

packet_count: Optional[int]

Number of packets with a response from this node.

std_dev_rtt_ms: Optional[float]

Standard deviation of the RTTs in ms.

packets_lost: Optional[int]

Number of packets where no response was received.

packets_sent: Optional[int]

Number of packets sent with specified TTL.

packets_ttl: Optional[int]

The time to live (TTL).

target_summary: Optional[object]

Aggregated statistics from all hops about the target.

traceroute_time_ms: Optional[int]

Total time of traceroute in ms.

target: Optional[str]

The target hostname, IPv6, or IPv6 address.

DiagnosticsEndpoint 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