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

Headers

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

Path Parameters

​
location
string
required

Query Parameters

​
readme
boolean
default:false
​
apiDef
boolean
default:false

Response

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