Documentation Documentation

Create an API Key - Pro Edition

Tutorial: Create an API Key with the Dashboard

The Tyk Dashboard is the simplest way to generate a new Key.

Step 1: Select "Keys" from the "System Management" section

Keys menu link location

Step 2: Click Add key

Add key button location

Step 3: Set Access Rights

Select the API you created in the Create an API tutorial from the Access Rights drop-down list, then click Add. This sets an access rule to the API Key for your API. You must set an access rule for an API key.

You can leave all other options at their default settings.

Access rights location

Step 4: Click Create

Create button location

A Key successfully generated pop-up will be displayed with the key shown. You must save this somewhere for future reference as it will not be displayed again. Click Copy to clipboard and paste into a text document.

Key success message location

That's it, you've created a key - now we can try and use it.

Tutorial: Create an API Key with the API

To create an API key, we will need the API ID that we wish to grant the key access to. Creating the token is then a simple API call to the endpoint.

You will also need your own API Key, to get these values:

  1. Select "Users" from the "System Management" section.
  2. In the users list, click "Edit" for your user.
  3. The API key is the Tyk Dashboard API Access Credentials, copy this somewhere you can reference it.
    API key location
  4. Select "APIs" from the "System Management" section.
  5. The API ID is next to your API name, copy this somewhere for reference too.

API ID location

Once you have these values, you can use them to access the dashboard API, the below curl command will generate a token for one of your APIs:

    curl -X POST -H "authorization: 1238b7e0e2ff4c2957321724409ee2eb" \
     -s \
     -H "Content-Type: application/json" \
     -X POST \
     -d '{
        "allowance": 1000,
        "rate": 1000,
        "per": 1,
        "expires": -1,
        "quota_max": -1,
        "quota_renews": 1449051461,
        "quota_remaining": -1,
        "quota_renewal_rate": 60,
        "access_rights": {
            "ad5004d961a147d4649fd3216694ebe2": {
                "api_id": "ad5004d961a147d4649fd3216694ebe2",
                "api_name": "test-api",
                "versions": ["Default"]
            }
        },
        "meta_data": {}
     }' http://admin.cloud.tyk.io/api/keys | python -mjson.tool

You will see a response with your new key:

    {
        "action": "create",
        "key": "c2cb92a78f944e9a46de793fe28e847e",
        "status": "ok"
    }

The value returned in the key parameter of the response is the access token you can now use to access the API that was specified in the access_rights section of the call