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

FieldTypeDescription
hostnamesstring[]Array of hostnames to lookup
countryCodestring (optional)Filter nodes by country code
ispRegexstring (optional)Filter nodes by ISP regex
configurationobject (optional)DNS-specific configuration

Configuration Object

FieldTypeDescription
dnsServersstring[] (optional)List of DNS servers to use
lookupTypesstring[] (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

ParameterDescription
methodThe HTTP method to use (e.g., GET, POST)

Request Body

FieldTypeDescription
hostnamesstring[]Array of hostnames to send the request to
countryCodestring (optional)Filter nodes by country code
ispRegexstring (optional)Filter nodes by ISP regex
configurationobject (optional)HTTP-specific configuration

Configuration Object

FieldTypeDescription
headersobject (optional)Key-value pairs of HTTP headers
regexstring (optional)Regex pattern to match in the response
statusCodesnumber[] (optional)Expected status codes
bodystring (optional)Request body for POST requests
returnBodyboolean (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

FieldTypeDescription
hostnamesstring[]Array of hostnames to ping
countryCodestring (optional)Filter nodes by country code
ispRegexstring (optional)Filter nodes by ISP regex
configurationobject (optional)ICMP-specific configuration

Configuration Object

FieldTypeDescription
attemptsnumber (optional)Number of ping attempts
payloadSizenumber (optional)Size of the ping payload
timeoutMillisnumber (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

FieldTypeDescription
hostnamesstring[]Array of HLS stream URLs to test
countryCodestring (optional)Filter nodes by country code
ispRegexstring (optional)Filter nodes by ISP regex
configurationobject (optional)HLS-specific configuration

Configuration Object

FieldTypeDescription
headersobject (optional)Key-value pairs of HTTP headers
return_streamboolean (optional)Whether to return the stream content

Response

Returns the HLS stream test results along with node information.

© 2024 Bitping Pty. Ltd.