Launch a metadata tracing request

post

https://{hostname}/edge-diagnostics/v1/metadata-tracer

Launches an asynchronous request to trace metadata for a URL configured in Property Manager. The metadata tracing works for the current property version active either on staging or production. To run the operation for a location, run the List available locations for metadata tracing operation first to get available values. If you don't provide a location ID or an edge server IP, then Edge Diagnostics runs the operation using a random location. The operation doesn't support requests for zone apex mapping (ZAM) and hostnames lacking a CNAME on the staging environment.

Query Params

accountSwitchKey

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

edgeIp

string

length ≥ 1

HTTP client IP from where the request initiated. Provide either this value or mdtLocationId.

httpBody

string

length between 1 and 4096

The POST call's request body.

httpMethod

string

enum

Defaults to GET

HTTP method you want to use to run the operation, either HEAD, POST, or the default GET method.

Allowed:

mdtLocationId

string

length ≥ 1

Unique identifier for an available location closest to your end users. To get this value, run the List available locations for metadata tracing operation first. For GET and HEAD, provide either this value or edgeIp.

requestHeaders

array of strings

length ≥ 0

Customized headers for metadata tracer request in the format header: value. Check Pragma headers for the list of Akamized Pragma headers you can use here.

requestHeaders

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

url

uri

required

URL configured in Property Manager you want to get the metadata trace for.

useStaging

boolean

Runs the request on the staging environment, false by default.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Response body

object

detail

string

length ≥ 1

Detail about the problem.

errors

array of objects

HTTP Problem Details objects indicating causes of failure.

errors

object

requestField

string

Request field name the error refers to. It can be a URL path or query parameter or any request payload field name.

requestValues

array

Lists values corresponding to the requestField.

requestValues

String

Integer

Object

title

string

required

Title of the error.

type

string

required

Type of error.

requestField

string

Request field name the error refers to. It can be a path or query parameter of the URL or any request payload field name.

requestValues

array

Lists values corresponding to the requestField.

requestValues

String

Integer

Object

status

integer

HTTP response code.

title

string

required

Title of the error.

type

string

required

Type of error.

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://hostname/edge-diagnostics/v1/metadata-tracer \
3
     --header 'accept: application/problem+json' \
4
     --header 'content-type: application/json'


xxxxxxxxxx
16
 
1
{
2
  "detail": "Provide only one of these members, either `edgeLocationId` or `edgeIp`.",
3
  "errors": [
4
    {
5
      "requestField": "edgeLocationId",
6
      "title": "Conflicting values.",
7
      "type": "field.conflict"
8
    },
9
    {
10
      "requestField": "edgeIp",
11
      "title": "Conflicting values.",
12
      "type": "field.conflict"
13
    }
14
  ],
15
  "status": 400,
16
  "title": "Incorrect request.",
17
  "type": "bad.request.error"
18
}

202Process successfully launched.

400Validation error.

401Authorization error.

403Permission error.

405Method not allowed.

429Too many requests.