API Documentation
This documentation covers the various job types available through the Customer Jobs API. Each job type allows you to perform specific network tests from different locations and ISPs.
DNS Lookup
Perform a DNS lookup for specified hostnames.
Endpoint
POST /dns
Request Body
Field | Type | Description |
---|---|---|
hostnames | string[] | Array of hostnames to lookup |
countryCode | string (optional) | Filter nodes by country code |
ispRegex | string (optional) | Filter nodes by ISP regex |
configuration | object (optional) | DNS-specific configuration |
Configuration Object
Field | Type | Description |
---|---|---|
dnsServers | string[] (optional) | List of DNS servers to use |
lookupTypes | string[] (optional) | Types of DNS lookups to perform (e.g., “MX”, “NS”, “IP”, “TXT”, “SOA”, “SRV”, “TLSA”) |
Response
Returns the DNS lookup results along with node information.
HTTP Request
Perform an HTTP request to specified hostnames.
Endpoint
POST /http/:method
Parameters
Parameter | Description |
---|---|
method | The HTTP method to use (e.g., GET, POST) |
Request Body
Field | Type | Description |
---|---|---|
hostnames | string[] | Array of hostnames to send the request to |
countryCode | string (optional) | Filter nodes by country code |
ispRegex | string (optional) | Filter nodes by ISP regex |
configuration | object (optional) | HTTP-specific configuration |
Configuration Object
Field | Type | Description |
---|---|---|
headers | object (optional) | Key-value pairs of HTTP headers |
regex | string (optional) | Regex pattern to match in the response |
statusCodes | number[] (optional) | Expected status codes |
body | string (optional) | Request body for POST requests |
returnBody | boolean (optional) | Whether to return the response body |
Response
Returns the HTTP response along with node information.
ICMP Ping
Perform a ping test to specified hostnames.
Endpoint
POST /icmp
Request Body
Field | Type | Description |
---|---|---|
hostnames | string[] | Array of hostnames to ping |
countryCode | string (optional) | Filter nodes by country code |
ispRegex | string (optional) | Filter nodes by ISP regex |
configuration | object (optional) | ICMP-specific configuration |
Configuration Object
Field | Type | Description |
---|---|---|
attempts | number (optional) | Number of ping attempts |
payloadSize | number (optional) | Size of the ping payload |
timeoutMillis | number (optional) | Timeout in milliseconds |
Response
Returns the ping results along with node information.
HLS Stream Test
Perform an HLS (HTTP Live Streaming) test on specified stream URLs.
Endpoint
POST /hls
Request Body
Field | Type | Description |
---|---|---|
hostnames | string[] | Array of HLS stream URLs to test |
countryCode | string (optional) | Filter nodes by country code |
ispRegex | string (optional) | Filter nodes by ISP regex |
configuration | object (optional) | HLS-specific configuration |
Configuration Object
Field | Type | Description |
---|---|---|
headers | object (optional) | Key-value pairs of HTTP headers |
return_stream | boolean (optional) | Whether to return the stream content |
Response
Returns the HLS stream test results along with node information.