Akamai

Akamai: Edge Diagnostics API

Akamai: Edge Diagnostics API endpoints from Akamai

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Akamai: Edge Diagnostics API endpoints from Akamai

Endpoints 30

Connectivity problems

  • POSTRun the connectivity problems scenario/connectivity-problems?accountSwitchKey={{accountSwitchKey}}Launches an asynchronous request to simultaneously run Launch a GREP request, Request content with cURL, and Test network connectivity with MTR operations for…
  • GETGet the Connectivity problems scenario response/connectivity-problems/requests/:requestId?includeContentResponseBody={{includeContentResponseBody}}&accountSwitchKey={{accountSwitchKey}}Returns the status of the asynchronous Run the connectivity problems scenario request. Operations with the SUCCESS status include also fetched GREP, cURL, and…

Content problems

  • POSTRun the content problems scenario/content-problems?accountSwitchKey={{accountSwitchKey}}Launches an asynchronous request to simultaneously run Launch a GREP request and Request content with cURL operations for a URL. It may help you diagnose…
  • GETGet the Content problems scenario response/content-problems/requests/:requestId?includeContentResponseBody={{includeContentResponseBody}}&accountSwitchKey={{accountSwitchKey}}Returns the status of the asynchronous Run the content problems scenario request. Operations with the SUCCESS status include fetched GREP and cURL data.

CURL

  • POSTRequest content with cURL/curl?accountSwitchKey={{accountSwitchKey}}Requests content using the curl command to provide the raw HTML for a URL, including request headers. You can run this operation for a specific location, an…

Dig

  • POSTGet domain details with dig/dig?accountSwitchKey={{accountSwitchKey}}Uses the dig command to provide DNS details for the location of an edge server, a hostname or a domain name, or a GTM hostname. The results may help you…

Edge server locations

  • GETList available edge server locations/edge-locations?accountSwitchKey={{accountSwitchKey}}Lists active edge server locations you can use to run Request content with cURL, Get domain details with dig, Test network connectivity with MTR, Run the URL…

Error translator

  • POSTTranslate error string/error-translator?accountSwitchKey={{accountSwitchKey}}Launches an asynchronous request to fetch summary and logs for an error with a specific reference code. You can also translate any Global Request Number (GRN)…
  • GETGet a translate error string response/error-translator/requests/:requestId?accountSwitchKey={{accountSwitchKey}}Returns the status of the asynchronous Translate error string request. For operations with the SUCCESS status, the response includes details about the error.…

ESI debugger

  • POSTGet an ESI debugging report/esi-debugger-api/v1/debug?accountSwitchKey={{accountSwitchKey}}This operation provides a debugging report on the ESI code of your source page and all pages that the source page references.

Error statistics

  • POSTGet error statistics/estats?accountSwitchKey={{accountSwitchKey}}Returns HTTP status codes distribution statistics from delivering a URL or CP code based on the nine-second traffic sample from the last two minutes. You can…

Grep

  • GETGet specific logs/grep?edgeIp={{edgeIp}}&cpCode={{cpCode}}&clientIp={{clientIp}}&objectStatus={{objectStatus}}&httpStatusCode={{httpStatusCode}}&userAgent={{userAgent}}&arl={{arl}}&start={{start}}&end={{end}}&logType={{logType}}&accountSwitchKey={{accountSwitchKey}}Using the grep command, returns logs that match the query parameters. This operation gets the data directly. If you don't have detailed information about the…
  • POSTLaunch a GREP request/grep?accountSwitchKey={{accountSwitchKey}}Launches an asynchronous request to fetch logs for an edge server IP address using the grep command. To verify if an IP belongs to an edge server, run the…
  • GETCheck a GREP request status/grep/requests/:requestId?accountSwitchKey={{accountSwitchKey}}Returns the status of the asynchronous Launch a GREP request request. Operations with the SUCCESS status include also the grep logs.

GTM properties

  • GETList GTM properties/gtm/gtm-properties?accountSwitchKey={{accountSwitchKey}}Lists GTM properties you have access to. You can use the returned hostname values to run Test network connectivity with MTR and Get domain details with dig…
  • GETList test and target IPs for a GTM hostname/gtm/:property/:domain/gtm-property-ips?accountSwitchKey={{accountSwitchKey}}Lists test and target IPs for a GTM property. You can use the returned data to run the Test network connectivity with MTR operation for a GTM hostname. To get…

IPA hostnames

  • GETList IP acceleration hostnames/ipa/hostnames?accountSwitchKey={{accountSwitchKey}}Lists IP acceleration (IPA) hostnames you have access to and can generate a diagnostic link to collect diagnostic data.

IP network location

  • POSTLocate an IP network/locate-ip?accountSwitchKey={{accountSwitchKey}}Returns geolocation data of an IP's network. You can enter up to 10 IPs.

Metadata Tracer

  • POSTLaunch a metadata tracing request/metadata-tracer?accountSwitchKey={{accountSwitchKey}}Launches an asynchronous request to trace metadata for a URL configured in Property Manager. The metadata tracing works for the current property version…
  • GETList available edge server locations for metadata tracing/metadata-tracer/locations?accountSwitchKey={{accountSwitchKey}}Lists active locations you can use to run the Launch a metadata tracing request operation together with information about supported HTTP methods. The…
  • GETCheck a metadata tracing request status/metadata-tracer/requests/:requestId?accountSwitchKey={{accountSwitchKey}}Returns the status of the asynchronous Launch a Metadata Tracer request operation. For operations with the SUCCESS status, the response includes the metadata…

MTR

  • POSTTest network connectivity with MTR/mtr?accountSwitchKey={{accountSwitchKey}}Uses MTR to provide information about packet loss and latency between an edge server IP, location, or Site Shield map and a remote destination. To run this…

ARL translator

  • POSTTranslate an Akamaized URL/translated-url?accountSwitchKey={{accountSwitchKey}}Provides basic information about a specific hostname or domain name, such as typecode, origin server, CP code, serial number, and TTL. A URL becomes an…

URL Health Check

  • POSTRun the URL health check/url-health-check?accountSwitchKey={{accountSwitchKey}}Launches an asynchronous request to simultaneously run Launch a GREP request, Get domain details with dig, Request content with cURL, Test network…
  • GETGet a URL health check response/url-health-check/requests/:requestId?includeContentResponseBody={{includeContentResponseBody}}&accountSwitchKey={{accountSwitchKey}}Returns the status of the asynchronous Run the URL health check request. Operations with the SUCCESS status include also fetched GREP, dig, cURL, and MTR data.

User diagnostic data

  • GETList end user groups/user-diagnostic-data/groups?accountSwitchKey={{accountSwitchKey}}Lists groups created for collecting diagnostic data and their details. A group stores diagnostic data of end users of a particular domain experiencing similar…
  • POSTGenerate a diagnostic link/user-diagnostic-data/groups?accountSwitchKey={{accountSwitchKey}}Generates a diagnostic link for you to share with end users of a particular URL or IP acceleration hostname experiencing similar issues. After an end user…
  • GETGet diagnostic data for an end user group/user-diagnostic-data/groups/:groupId/records?includeCurl={{includeCurl}}&includeDig={{includeDig}}&includeMtr={{includeMtr}}&accountSwitchKey={{accountSwitchKey}}Returns collected diagnostic data for a specific group. You can also request additional cURL, DIG, and MTR data. To get the groupId value, run the List groups…

IP verification and location

  • POSTVerify an IP/verify-edge-ip?accountSwitchKey={{accountSwitchKey}}Verifies if an IP belongs to an edge server. For IPs verified positively, you can continue gathering diagnostic data with Request content with cURL, Get…
  • POSTVerify and locate an IP/verify-locate-ip?accountSwitchKey={{accountSwitchKey}}Verifies if an IP belongs to an edge server and gets the geolocation data of its network. For IPs verified positively, you can continue gathering diagnostic…

API details

Base URL
https://{hostname}/edge-diagnostics/v1
Authentication
None declared in the description
Operations
30 operations on 28 pathsPOST 16GET 14
Main resources
Grep 3Metadata Tracer 3User diagnostic data 3Connectivity problems 2Content problems 2Error translator 2GTM properties 2IP verification and location 2URL Health Check 2ARL translator 1
Response formats
application/problem+json application/json text/html
Description format
OpenAPI 3.0.0, API version v1

How to test the Akamai: Edge Diagnostics API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Akamai: Edge Diagnostics API collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “Run the connectivity problems scenario” (POST /connectivity-problems?accountSwitchKey={{accountSwitchKey}}), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Akamai: Edge Diagnostics API?

Akamai: Edge Diagnostics API endpoints from Akamai It is listed under Developer tools and has 30 endpoints.

Who publishes the Akamai: Edge Diagnostics API?

It is listed from Akamai's public API description (an OpenAPI document), not published by Akamai on Swastik Codes. Anyone who controls akamai.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Akamai: Edge Diagnostics API?

Requests go to https://{hostname}/edge-diagnostics/v1. Endpoint paths are added to this base URL.

How do I authenticate with the Akamai: Edge Diagnostics API?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the Akamai: Edge Diagnostics API have?

30 operations on 28 paths (16 POST, 14 GET). The largest groups are Grep, Metadata Tracer, User diagnostic data, Connectivity problems.

Is forking the Akamai: Edge Diagnostics API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.