Getting Started
Deploy Tyk
Managing APIs
Security in Tyk
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..."
}Test a Tyk Classic or Tyk OAS API definition.
Used to test API definition by sending sample request and analysing output of both response and logs.
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..."
}Authorizations
Api key
Body
- Option 1
- Option 2
- Option 1
- Option 2
Show child attributes
Show child attributes
Show child attributes
Show child attributes
false
[
"Origin",
"Accept",
"Content-Type",
"Authorization"
]["GET", "HEAD", "POST"]["https://*.foo.com"]true
false
["Accept", "Content-Type"]24
false
Show child attributes
Show child attributes
"Authorization"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
"Authorization"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
false
60
true
false
Show child attributes
Show child attributes
Show child attributes
Show child attributes
"PreMiddlewareFunction"
false
false
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
"PreMiddlewareFunction"
false
false
Show child attributes
Show child attributes
Show child attributes
Show child attributes
"x-api-version"
"header"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
x >= 0x >= 0x >= 0Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
proxyOnly, executionEngine, subgraph, supergraph, Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
1, 2, x >= 0x >= 0x >= 0Show child attributes
Show child attributes
"/relative-path-examples/"
Show child attributes
Show child attributes
true
"https://httpbin.org/"
Show child attributes
Show child attributes
x >= 0x >= 0Show child attributes
Show child attributes
["Default", "v1"]Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
no_action, reply Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
no_action, reply Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
json, xml blob, file Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
json, xml blob, file Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
all, any Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
blob, file Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
no_action, reply true
Was this page helpful?