Getting Started
Deploy Tyk
Managing APIs
Security in Tyk
Reference
- Overview
- Overview
- GETGet List of APIs
- POSTCreate API Definition
- GETGet API access rights (users and userGroups)
- PUTUpdate API access rights (users and userGroups)
- GETGet a single API by ID
- PUTUpdate API Definition
- DELDelete a single API by ID
- GETGet API URLs
- GETGet API Categories
- GETGet API Groups.
- GETSearch List of APIs
- GETGet a list of example API definitions.
- GETGet details of a single example API definition.
- GET
- Tyk Identity Broker
curl --request GET \
--url https://{tenant}/api/examples/{location} \
--header 'Authorization: Bearer <token>'{
"description": "Simple REST API wrapped in GQL using Universal Data Graph that allows user to check validity of a VAT number and display some details about it.",
"features": [
"REST Datasource"
],
"location": "udg/vat-checker",
"min_version": "5.0",
"name": "VAT number checker UDG"
}Get details of a single example API definition.
Get the details of a single API definition, details include full name, location in the repository, description, features and min tyk version.
curl --request GET \
--url https://{tenant}/api/examples/{location} \
--header 'Authorization: Bearer <token>'{
"description": "Simple REST API wrapped in GQL using Universal Data Graph that allows user to check validity of a VAT number and display some details about it.",
"features": [
"REST Datasource"
],
"location": "udg/vat-checker",
"min_version": "5.0",
"name": "VAT number checker UDG"
}Authorizations
The Tyk Dashboard API Access Credentials
Headers
URL that points to the index file (repository.json) or root of a repository housing examples.
Repository URL to fetch example API definitions from.
Path Parameters
Location of the tyk example in the repository defined in x-tyk-repo-url.
Query Parameters
If set to true, the response will contain the content of the Readme file for the specified example, the readme content will be present as the readme field.
If set to true, the response will contain the APIDefinition of the specified example, the definition will be present as the apiDefinition field.
Response
Details on the fetched example API definition.
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
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
x >= 0x >= 0x >= 0Show 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
x >= 0x >= 0x >= 0Show 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 >= 0Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
"30s"
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
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
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
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
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
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
Was this page helpful?