Test a Tyk Classic or Tyk OAS API definition.

curl --request POST \
  --url https://{tenant}/tyk/debug \
  --header 'Content-Type: application/json' \
  --header 'X-Tyk-Authorization: <api-key>' \
  --data '
{
  "request": {
    "method": "GET",
    "path": "/update-listen-path"
  },
  "spec": {
    "api_id": "b84fe1a04e5648927971c0557971565c",
    "auth": {
      "auth_header_name": "authorization"
    },
    "definition": {
      "key": "version",
      "location": "header"
    },
    "name": "Tyk Test API",
    "org_id": "664a14650619d40001f1f00f",
    "proxy": {
      "listen_path": "/tyk-api-test/",
      "strip_listen_path": true,
      "target_url": "https://httpbin.org"
    },
    "use_oauth2": true,
    "version_data": {
      "not_versioned": true,
      "versions": {
        "Default": {
          "name": "Default"
        }
      }
    }
  }
}
'

{
  "logs": "{\"level\":\"warning\",\"msg\":\"Legacy path detected! Upgrade to extended....",
  "message": "ok",
  "response": "====== Request ======\nGET / HTTP/1.1\r\nHost: httpbin.org\r\n\r\n\n====== Response..."
}

{
  "message": "Request malformed",
  "status": "error"
}

{
  "message": "Attempted administrative access with invalid or missing key!",
  "status": "error"
}

{
  "message": "Unexpected failure:",
  "status": "error"
}

POST

tyk

debug

curl --request POST \
  --url https://{tenant}/tyk/debug \
  --header 'Content-Type: application/json' \
  --header 'X-Tyk-Authorization: <api-key>' \
  --data '
{
  "request": {
    "method": "GET",
    "path": "/update-listen-path"
  },
  "spec": {
    "api_id": "b84fe1a04e5648927971c0557971565c",
    "auth": {
      "auth_header_name": "authorization"
    },
    "definition": {
      "key": "version",
      "location": "header"
    },
    "name": "Tyk Test API",
    "org_id": "664a14650619d40001f1f00f",
    "proxy": {
      "listen_path": "/tyk-api-test/",
      "strip_listen_path": true,
      "target_url": "https://httpbin.org"
    },
    "use_oauth2": true,
    "version_data": {
      "not_versioned": true,
      "versions": {
        "Default": {
          "name": "Default"
        }
      }
    }
  }
}
'

{
  "logs": "{\"level\":\"warning\",\"msg\":\"Legacy path detected! Upgrade to extended....",
  "message": "ok",
  "response": "====== Request ======\nGET / HTTP/1.1\r\nHost: httpbin.org\r\n\r\n\n====== Response..."
}

{
  "message": "Request malformed",
  "status": "error"
}

{
  "message": "Attempted administrative access with invalid or missing key!",
  "status": "error"
}

{
  "message": "Unexpected failure:",
  "status": "error"
}

Authorizations

X-Tyk-Authorization

string

header

required

Api key

Body

application/json

Option 1
Option 2

oas

object

required

The description of OpenAPI v3.0.x documents, as defined by https://spec.openapis.org/oas/v3.0.3

Option 1
Option 2

Show child attributes

request

object

Show child attributes

spec

object

Show child attributes

Response

Success tracing request.

logs

string

Example:

"{\"level\":\"warning\",\"msg\":\"Legacy path detected! Upgrade to extended...."

message

string

Example:

"ok"

response

string

Example:

"====== Request ======\nGET / HTTP/1.1\r\nHost: httpbin.org\r\n\r\n\n====== Response..."

Getting Started

Deploy Tyk

Design & Create APIs

Secure APIs

Control Traffic

Routing Traffic

Transform Traffic

Observe APIs

Maintain APIs

Platform Administration

Guides

Reference

Developer Support

Test a Tyk Classic or Tyk OAS API definition.

Authorizations

Body

Response