Getting Started
Deploy Tyk
Managing APIs
Security in Tyk
Reference
curl --request GET \
--url https://{tenant}/tyk/apis/{apiID} \
--header 'X-Tyk-Authorization: <api-key>'{
"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"
}
}
}
}Get API definition with it's ID.
Get API definition from Tyk Gateway.
curl --request GET \
--url https://{tenant}/tyk/apis/{apiID} \
--header 'X-Tyk-Authorization: <api-key>'{
"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"
}
}
}
}Authorizations
Api key
Path Parameters
The API ID.
Response
API definition.
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
"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
Show child attributes
Show child attributes
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
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
Show 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?