Skip to main content
GET
/
api
/
examples
/
{location}
Get details of a single example API definition.
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

​
Authorization
string
header
required

The Tyk Dashboard API Access Credentials

Headers

​
x-tyk-examples-index
string
default:https://raw.githubusercontent.com/TykTechnologies/tyk-examples/main/repository.json

URL that points to the index file (repository.json) or root of a repository housing examples.

​
x-tyk-repo-url
string
default:https://github.com/TykTechnologies/tyk-examples.git

Repository URL to fetch example API definitions from.

Path Parameters

​
location
string
required

Location of the tyk example in the repository defined in x-tyk-repo-url.

Query Parameters

​
readme
boolean
default:false

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.

​
apiDef
boolean
default:false

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.

​
api_definition
object
​
description
string
​
features
string[] | null
​
location
string
​
min_version
string
​
name
string
​
oas
object
​
readme
string