Tyk v2.2 Documentation Components

  1. Home
  2. Tyk v2.2 Documentation Components
  3. Tutorial: Create API Without GUI (OP:Pro)

Tutorial: Create API Without GUI (OP:Pro)

With Tyk Pro (On-Premise), it is possible to programatically create APIs using Tyk’s Dashboard REST API, in order to do so you will need an API key for your organisation and one command to create the API and make it live.

Step 1: Get an API Key

To get your API key, select:

  • Users
  • Your username
  • Scroll to the bottom of the page

Your API Key is the first entry:

Access credentials location

Step 2: Create an API

To create the API, let’s send a definition to the admin endpoint:

curl -H "Authorization: 1238b7e0e2ff4c2957321724409ee2eb" 
 -H "Content-Type: application/json" 
 -d '{
    "api_definition": {
        "name": "Test API",
        "slug": "test-api",
        "auth": {
            "auth_header_name": "Authorization"
        "definition": {
            "location": "header",
            "key": "x-api-version"
        "version_data": {
            "not_versioned": true,
            "versions": {
                "Default": {
                    "name": "Default",
                    "use_extended_paths": true
        "proxy": {
            "listen_path": "/test-api/",
            "target_url": "http://httpbin.org/",
            "strip_listen_path": true
        "active": true
 }' https://localhost:3000/api/apis/ | python -mjson.tool

If the command succeeds, you will see:

    "action": "added",
    "key": "xxxxxxxxx",
    "status": "ok"

What did we just do?

We just sent an API definition to the Tyk /apis endpoint, API definitions are discussed in detail in the API section of this documentation. These objects encapsulate all of the settings for an API within Tyk Cloud.