API

Run the URL health check

post
https://{hostname}/edge-diagnostics/v1/url-health-check

Launches an asynchronous request to simultaneously run Launch a GREP request, Get domain details with dig, Request content with cURL, Test network connectivity with MTR and Translate an Akamaized URL operations for a URL. Successful operations return fetched GREP, dig, cURL, and MTR data and Akamaized URL (ARL) details.

Query Params
string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Body Params

Collects data to use in the URL health check request.

string
length ≥ 1

Unique identifier for an edge server location closest to your end users. Run the List available edge server locations operation to get this value.

string
enum

IP version for the URL health check to use to run cURL and MTR, either IPV4 or IPV6.

Allowed:
string
enum

Packet type for the URL health check to use to run MTR, either ICMP or TCP. Provide it only for requests with CONNECTIVITY in the viewsAllowed array.

Allowed:
integer
enum

Port number for the URL health check to use to run MTR, either 80 or 443. Provide it only for requests with CONNECTIVITY in the viewsAllowed array.

Allowed:
string
enum

DNS query type you want to get the records of with the DIG command. Possible values are: A, AAAA, SOA, CNAME, PTR, MX, NS, TXT, SRV, CAA, or ANY. To learn more about them, check Supported DNS record types.

requestHeaders
array of strings
length ≥ 0

Customized headers for the curl request in the format header: value. The request includes Akamai Pragma headers by default.

requestHeaders
boolean

Runs a URL health check from a Site Shield map. To learn more, check Site Shield requests.

sensitiveRequestHeaderKeys
array of strings
length ≥ 0

Sensitive requestHeaders you don't want to store in the database after running the request. Check Sensitive headers to see the list of request headers treated as sensitive by default.

sensitiveRequestHeaderKeys
string
length ≥ 1

IP of the edge server you want to serve traffic from. You can use the edge server IP value from the answerSection array in the Get domain details with dig operation response.

string
required
length ≥ 1

URL you want to run the health check for.

viewsAllowed
array of strings
length ≥ 0

Additional operations for the URL health check to run. CONNECTIVITY runs the Test network connectivity with MTR operation and LOGS runs the Get specific logs operation.

viewsAllowed
Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 4 months ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated 4 months ago