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>'
{
  "api_definition": {
    "CORS": {
      "allow_credentials": true,
      "allowed_headers": [
        "<string>"
      ],
      "allowed_methods": [
        "<string>"
      ],
      "allowed_origins": [
        "<string>"
      ],
      "debug": true,
      "enable": true,
      "exposed_headers": [
        "<string>"
      ],
      "max_age": 123,
      "options_passthrough": true
    },
    "active": true,
    "allowed_ips": [
      "<string>"
    ],
    "analytics_plugin": {
      "enable": true,
      "func_name": "<string>",
      "plugin_path": "<string>"
    },
    "api_id": "<string>",
    "auth": {
      "auth_header_name": "<string>",
      "cookie_name": "<string>",
      "disable_header": true,
      "name": "<string>",
      "param_name": "<string>",
      "signature": {
        "algorithm": "<string>",
        "allowed_clock_skew": 123,
        "error_code": 123,
        "error_message": "<string>",
        "header": "<string>",
        "param_name": "<string>",
        "secret": "<string>",
        "use_param": true
      },
      "use_certificate": true,
      "use_cookie": true,
      "use_param": true,
      "validate_signature": true
    },
    "auth_configs": {},
    "auth_provider": {
      "meta": {},
      "name": "<string>",
      "storage_engine": "<string>"
    },
    "base_identity_provided_by": "<string>",
    "basic_auth": {
      "body_password_regexp": "<string>",
      "body_user_regexp": "<string>",
      "cache_ttl": 123,
      "disable_caching": true,
      "extract_from_body": true
    },
    "blacklisted_ips": [
      "<string>"
    ],
    "cache_options": {
      "cache_all_safe_requests": true,
      "cache_by_headers": [
        "<string>"
      ],
      "cache_control_ttl_header": "<string>",
      "cache_response_codes": [
        123
      ],
      "cache_timeout": 123,
      "enable_cache": true,
      "enable_upstream_cache_control": true
    },
    "certificate_pinning_disabled": true,
    "certificates": [
      "<string>"
    ],
    "client_certificates": [
      "<string>"
    ],
    "config_data": {},
    "config_data_disabled": true,
    "custom_middleware": {
      "auth_check": {
        "disabled": true,
        "name": "<string>",
        "path": "<string>",
        "raw_body_only": true,
        "require_session": true
      },
      "driver": "<string>",
      "id_extractor": {
        "disabled": true,
        "extract_from": "<string>",
        "extract_with": "<string>",
        "extractor_config": {}
      },
      "post": [
        {
          "disabled": true,
          "name": "<string>",
          "path": "<string>",
          "raw_body_only": true,
          "require_session": true
        }
      ],
      "post_key_auth": [
        {
          "disabled": true,
          "name": "<string>",
          "path": "<string>",
          "raw_body_only": true,
          "require_session": true
        }
      ],
      "pre": [
        {
          "disabled": true,
          "name": "<string>",
          "path": "<string>",
          "raw_body_only": true,
          "require_session": true
        }
      ],
      "response": [
        {
          "disabled": true,
          "name": "<string>",
          "path": "<string>",
          "raw_body_only": true,
          "require_session": true
        }
      ]
    },
    "custom_middleware_bundle": "<string>",
    "custom_middleware_bundle_disabled": true,
    "custom_plugin_auth_enabled": true,
    "definition": {
      "default": "<string>",
      "enabled": true,
      "fallback_to_default": true,
      "key": "<string>",
      "location": "<string>",
      "name": "<string>",
      "strip_path": true,
      "strip_versioning_data": true,
      "url_versioning_pattern": "<string>",
      "versions": {}
    },
    "detailed_tracing": true,
    "disable_quota": true,
    "disable_rate_limit": true,
    "do_not_track": true,
    "domain": "<string>",
    "domain_disabled": true,
    "dont_set_quota_on_create": true,
    "enable_batch_request_support": true,
    "enable_context_vars": true,
    "enable_coprocess_auth": true,
    "enable_detailed_recording": true,
    "enable_ip_blacklisting": true,
    "enable_ip_whitelisting": true,
    "enable_jwt": true,
    "enable_proxy_protocol": true,
    "enable_signature_checking": true,
    "event_handlers": {
      "events": {}
    },
    "expiration": "<string>",
    "expire_analytics_after": 123,
    "external_oauth": {
      "enabled": true,
      "providers": [
        {
          "introspection": {
            "cache": {
              "enabled": true,
              "timeout": 123
            },
            "client_id": "<string>",
            "client_secret": "<string>",
            "enabled": true,
            "identity_base_field": "<string>",
            "url": "<string>"
          },
          "jwt": {
            "enabled": true,
            "expires_at_validation_skew": 1,
            "identity_base_field": "<string>",
            "issued_at_validation_skew": 1,
            "not_before_validation_skew": 1,
            "signing_method": "<string>",
            "source": "<string>"
          }
        }
      ]
    },
    "global_rate_limit": {
      "disabled": true,
      "per": 123,
      "rate": 123
    },
    "graphql": {
      "enabled": true,
      "engine": {
        "data_sources": [
          {
            "config": "<unknown>",
            "internal": true,
            "kind": "<string>",
            "name": "<string>",
            "root_fields": [
              {
                "fields": [
                  "<string>"
                ],
                "type": "<string>"
              }
            ]
          }
        ],
        "field_configs": [
          {
            "disable_default_mapping": true,
            "field_name": "<string>",
            "path": [
              "<string>"
            ],
            "type_name": "<string>"
          }
        ],
        "global_headers": [
          {
            "key": "<string>",
            "value": "<string>"
          }
        ]
      },
      "execution_mode": "<string>",
      "introspection": {
        "disabled": true
      },
      "last_schema_update": "2023-11-07T05:31:56Z",
      "playground": {
        "enabled": true,
        "path": "<string>"
      },
      "proxy": {
        "auth_headers": {},
        "features": {
          "use_immutable_headers": true
        },
        "request_headers": {},
        "request_headers_rewrite": {},
        "subscription_type": "<string>",
        "use_response_extensions": {
          "on_error_forwarding": true
        }
      },
      "schema": "<string>",
      "subgraph": {
        "sdl": "<string>"
      },
      "supergraph": {
        "disable_query_batching": true,
        "global_headers": {},
        "merged_sdl": "<string>",
        "subgraphs": [
          {
            "api_id": "<string>",
            "headers": {},
            "name": "<string>",
            "sdl": "<string>",
            "subscription_type": "<string>",
            "url": "<string>"
          }
        ],
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "type_field_configurations": [
        {
          "data_source": {
            "data_source_config": "<unknown>",
            "kind": "<string>"
          },
          "field_name": "<string>",
          "mapping": {
            "disabled": true,
            "path": "<string>"
          },
          "type_name": "<string>"
        }
      ],
      "version": "<string>"
    },
    "hmac_allowed_algorithms": [
      "<string>"
    ],
    "hmac_allowed_clock_skew": 123,
    "id": "<string>",
    "idp_client_id_mapping_disabled": true,
    "internal": true,
    "is_oas": true,
    "jwt_client_base_field": "<string>",
    "jwt_default_policies": [
      "<string>"
    ],
    "jwt_expires_at_validation_skew": 1,
    "jwt_identity_base_field": "<string>",
    "jwt_issued_at_validation_skew": 1,
    "jwt_not_before_validation_skew": 1,
    "jwt_policy_field_name": "<string>",
    "jwt_scope_claim_name": "<string>",
    "jwt_scope_to_policy_mapping": {},
    "jwt_signing_method": "<string>",
    "jwt_skip_kid": true,
    "jwt_source": "<string>",
    "listen_port": 123,
    "name": "<string>",
    "notifications": {
      "oauth_on_keychange_url": "<string>",
      "shared_secret": "<string>"
    },
    "oauth_meta": {
      "allowed_access_types": [
        "<string>"
      ],
      "allowed_authorize_types": [
        "<string>"
      ],
      "auth_login_redirect": "<string>"
    },
    "openid_options": {
      "providers": [
        {
          "client_ids": {},
          "issuer": "<string>"
        }
      ],
      "segregate_by_client": true
    },
    "org_id": "<string>",
    "pinned_public_keys": {},
    "protocol": "<string>",
    "proxy": {
      "check_host_against_uptime_tests": true,
      "disable_strip_slash": true,
      "enable_load_balancing": true,
      "listen_path": "<string>",
      "preserve_host_header": true,
      "service_discovery": {
        "cache_disabled": true,
        "cache_timeout": 123,
        "data_path": "<string>",
        "endpoint_returns_list": true,
        "parent_data_path": "<string>",
        "port_data_path": "<string>",
        "query_endpoint": "<string>",
        "target_path": "<string>",
        "use_discovery_service": true,
        "use_nested_query": true,
        "use_target_list": true
      },
      "strip_listen_path": true,
      "target_list": [
        "<string>"
      ],
      "target_url": "<string>",
      "transport": {
        "proxy_url": "<string>",
        "ssl_ciphers": [
          "<string>"
        ],
        "ssl_force_common_name_check": true,
        "ssl_insecure_skip_verify": true,
        "ssl_max_version": 1,
        "ssl_min_version": 1
      }
    },
    "request_signing": {
      "algorithm": "<string>",
      "certificate_id": "<string>",
      "header_list": [
        "<string>"
      ],
      "is_enabled": true,
      "key_id": "<string>",
      "secret": "<string>",
      "signature_header": "<string>"
    },
    "response_processors": [
      {
        "name": "<string>",
        "options": "<unknown>"
      }
    ],
    "scopes": {
      "jwt": {
        "scope_claim_name": "<string>",
        "scope_to_policy": {}
      },
      "oidc": {
        "scope_claim_name": "<string>",
        "scope_to_policy": {}
      }
    },
    "session_lifetime": 123,
    "session_lifetime_respects_key_expiration": true,
    "session_provider": {
      "meta": {},
      "name": "<string>",
      "storage_engine": "<string>"
    },
    "slug": "<string>",
    "strip_auth_data": true,
    "tag_headers": [
      "<string>"
    ],
    "tags": [
      "<string>"
    ],
    "tags_disabled": true,
    "upstream_certificates": {},
    "upstream_certificates_disabled": true,
    "uptime_tests": {
      "check_list": [
        {
          "body": "<string>",
          "commands": [
            {
              "message": "<string>",
              "name": "<string>"
            }
          ],
          "enable_proxy_protocol": true,
          "headers": {},
          "method": "<string>",
          "protocol": "<string>",
          "timeout": "30s",
          "url": "<string>"
        }
      ],
      "config": {
        "expire_utime_after": 123,
        "recheck_wait": 123,
        "service_discovery": {
          "cache_disabled": true,
          "cache_timeout": 123,
          "data_path": "<string>",
          "endpoint_returns_list": true,
          "parent_data_path": "<string>",
          "port_data_path": "<string>",
          "query_endpoint": "<string>",
          "target_path": "<string>",
          "use_discovery_service": true,
          "use_nested_query": true,
          "use_target_list": true
        }
      }
    },
    "use_basic_auth": true,
    "use_go_plugin_auth": true,
    "use_keyless": true,
    "use_mutual_tls_auth": true,
    "use_oauth2": true,
    "use_openid": true,
    "use_standard_auth": true,
    "version_data": {
      "default_version": "<string>",
      "not_versioned": true,
      "versions": {}
    }
  },
  "description": "<string>",
  "features": [
    "<string>"
  ],
  "location": "<string>",
  "min_version": "<string>",
  "name": "<string>",
  "oas": {
    "components": {
      "callbacks": {},
      "examples": {},
      "headers": {},
      "links": {},
      "parameters": {},
      "requestBodies": {},
      "responses": {},
      "schemas": {},
      "securitySchemes": {}
    },
    "externalDocs": {
      "description": "<string>",
      "url": "<string>"
    },
    "info": {
      "contact": {
        "email": "<string>",
        "name": "<string>",
        "url": "<string>"
      },
      "description": "<string>",
      "license": {
        "name": "<string>",
        "url": "<string>"
      },
      "termsOfService": "<string>",
      "title": "<string>",
      "version": "<string>"
    },
    "openapi": "<string>",
    "paths": {},
    "security": [
      {}
    ],
    "servers": [
      {
        "description": "<string>",
        "url": "<string>",
        "variables": {}
      }
    ],
    "tags": [
      {
        "description": "<string>",
        "externalDocs": {
          "description": "<string>",
          "url": "<string>"
        },
        "name": "<string>"
      }
    ]
  },
  "readme": "<string>"
}

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