Create custom key / Import key

curl --request POST \
  --url https://{tenant}/tyk/keys/{keyID} \
  --header 'Content-Type: application/json' \
  --header 'X-Tyk-Authorization: <api-key>' \
  --data '
{
  "access_rights": {
    "itachi-api": {
      "allowed_urls": [
        {
          "methods": [
            "GET"
          ],
          "url": "/users"
        }
      ],
      "api_id": "8ddd91f3cda9453442c477b06c4e2da4",
      "api_name": "Itachi api",
      "limit": {
        "per": 60,
        "quota_max": 10000,
        "quota_remaining": 10000,
        "quota_renewal_rate": 3600,
        "rate": 1000,
        "throttle_interval": 10,
        "throttle_retry_limit": 10
      },
      "versions": [
        "Default"
      ]
    }
  },
  "alias": "portal-key",
  "allowance": 1000,
  "apply_policies": [
    "5ead7120575961000181867e"
  ],
  "date_created": "2024-08-09T14:40:34.87614+03:00",
  "enable_detailed_recording": true,
  "last_updated": "1723203634",
  "meta_data": {
    "new-update-key-sample": "update-key-sample",
    "tyk_developer_id": "62b3fb9a1d5e4f00017226f5",
    "update": "sample policy update",
    "user_type": "mobile_user"
  },
  "org_id": "5e9d9544a1dcd60001d0ed20",
  "per": 60,
  "quota_max": 10000,
  "quota_renewal_rate": 3600,
  "quota_renews": 1723207234,
  "rate": 1000,
  "tags": [
    "security",
    "edge",
    "edge-eu"
  ],
  "throttle_interval": 10,
  "throttle_retry_limit": 10
}
'

{
  "action": "added",
  "key": "5e9d9544a1dcd60001d0ed20customKey",
  "status": "ok"
}

POST

tyk

keys

{keyID}

Create custom key / Import key

curl --request POST \
  --url https://{tenant}/tyk/keys/{keyID} \
  --header 'Content-Type: application/json' \
  --header 'X-Tyk-Authorization: <api-key>' \
  --data '
{
  "access_rights": {
    "itachi-api": {
      "allowed_urls": [
        {
          "methods": [
            "GET"
          ],
          "url": "/users"
        }
      ],
      "api_id": "8ddd91f3cda9453442c477b06c4e2da4",
      "api_name": "Itachi api",
      "limit": {
        "per": 60,
        "quota_max": 10000,
        "quota_remaining": 10000,
        "quota_renewal_rate": 3600,
        "rate": 1000,
        "throttle_interval": 10,
        "throttle_retry_limit": 10
      },
      "versions": [
        "Default"
      ]
    }
  },
  "alias": "portal-key",
  "allowance": 1000,
  "apply_policies": [
    "5ead7120575961000181867e"
  ],
  "date_created": "2024-08-09T14:40:34.87614+03:00",
  "enable_detailed_recording": true,
  "last_updated": "1723203634",
  "meta_data": {
    "new-update-key-sample": "update-key-sample",
    "tyk_developer_id": "62b3fb9a1d5e4f00017226f5",
    "update": "sample policy update",
    "user_type": "mobile_user"
  },
  "org_id": "5e9d9544a1dcd60001d0ed20",
  "per": 60,
  "quota_max": 10000,
  "quota_renewal_rate": 3600,
  "quota_renews": 1723207234,
  "rate": 1000,
  "tags": [
    "security",
    "edge",
    "edge-eu"
  ],
  "throttle_interval": 10,
  "throttle_retry_limit": 10
}
'

{
  "action": "added",
  "key": "5e9d9544a1dcd60001d0ed20customKey",
  "status": "ok"
}

Authorizations

X-Tyk-Authorization

string

header

required

Api key

Path Parameters

keyID

string

required

Name to give the custom key.

Query Parameters

suppress_reset

enum<string>

Adding the suppress_reset parameter and setting it to 1, will cause Tyk not to reset the quota limit that is in the current live quota manager. By default Tyk will reset the quota in the live quota manager (initialising it) when adding a key. Adding the suppress_reset flag to the URL parameters will avoid this behaviour.

Available options:

1

hashed

enum<boolean>

When set to true the key_hash returned will be similar to the un-hashed key name.

Available options:

true,

false

Body

application/json

access_rights

object

Show child attributes

access_rights.{key}

object

Show child attributes

access_rights.{key}.allowance_scope

string

Example:

"d371b83b249845a2497ab9a947fd6210"

access_rights.{key}.allowed_types

object[] | null

Show child attributes

access_rights.{key}.allowed_types.fields

string[] | null

access_rights.{key}.allowed_types.name

string

access_rights.{key}.allowed_urls

object[] | null

Show child attributes

access_rights.{key}.allowed_urls.methods

string[] | null

Example:

["GET", "POST", "DELETE", "PUT"]

access_rights.{key}.allowed_urls.url

string

Example:

"anything/rate-limit-1-per-5"

access_rights.{key}.api_id

string

Example:

"d1dfc6a927a046c54c0ed470f19757cc"

access_rights.{key}.api_name

string

Example:

"Rate Limit Proxy API"

access_rights.{key}.disable_introspection

boolean

Example:

false

access_rights.{key}.endpoints

object[]

Show child attributes

access_rights.{key}.endpoints.methods

object[]

Show child attributes

access_rights.{key}.endpoints.methods.limit

object

Show child attributes

access_rights.{key}.endpoints.methods.limit.per

number

access_rights.{key}.endpoints.methods.limit.rate

number

access_rights.{key}.endpoints.methods.limit.smoothing

object

Show child attributes

access_rights.{key}.endpoints.methods.limit.smoothing.delay

integer

access_rights.{key}.endpoints.methods.limit.smoothing.enabled

boolean

access_rights.{key}.endpoints.methods.limit.smoothing.step

integer

access_rights.{key}.endpoints.methods.limit.smoothing.threshold

integer

access_rights.{key}.endpoints.methods.limit.smoothing.trigger

number

access_rights.{key}.endpoints.methods.name

string

access_rights.{key}.endpoints.path

string

access_rights.{key}.field_access_rights

object[] | null

Show child attributes

access_rights.{key}.field_access_rights.field_name

string

access_rights.{key}.field_access_rights.limits

object

Show child attributes

access_rights.{key}.field_access_rights.limits.max_query_depth

integer

access_rights.{key}.field_access_rights.type_name

string

access_rights.{key}.limit

object

Show child attributes

access_rights.{key}.limit.max_query_depth

integer

access_rights.{key}.limit.per

number

access_rights.{key}.limit.quota_max

integer

access_rights.{key}.limit.quota_remaining

integer

access_rights.{key}.limit.quota_renewal_rate

integer

access_rights.{key}.limit.quota_renews

integer

access_rights.{key}.limit.rate

number

access_rights.{key}.limit.smoothing

object

Show child attributes

access_rights.{key}.limit.smoothing.delay

integer

access_rights.{key}.limit.smoothing.enabled

boolean

access_rights.{key}.limit.smoothing.step

integer

access_rights.{key}.limit.smoothing.threshold

integer

access_rights.{key}.limit.smoothing.trigger

number

access_rights.{key}.limit.throttle_interval

number

access_rights.{key}.limit.throttle_retry_limit

integer

access_rights.{key}.restricted_types

object[] | null

Show child attributes

access_rights.{key}.restricted_types.fields

string[] | null

access_rights.{key}.restricted_types.name

string

access_rights.{key}.versions

string[] | null

Example:

["Default", "v2"]

alias

string

Example:

"[email protected]"

allowance

number<double>

Example:

1000

apply_policies

string[] | null

Example:

["641c15dd0fffb800010197bf"]

apply_policy_id

string

deprecated

deprecated use apply_policies going forward instead to send a list of policies ids

Example:

"641c15dd0fffb800010197bf"

basic_auth_data

object

Show child attributes

basic_auth_data.hash_type

string

basic_auth_data.password

string

certificate

string

data_expires

integer<int64>

Example:

0

date_created

string<date-time>

Example:

"2024-03-13T03:56:46.568042549Z"

enable_detail_recording

boolean

deprecated

deprecated use enable_detailed_recording going forward instead

Example:

false

enable_detailed_recording

boolean

Example:

true

enable_http_signature_validation

boolean

Example:

false

expires

integer<int64>

Example:

1712895619

hmac_enabled

boolean

Example:

false

hmac_string

string

id_extractor_deadline

integer<int64>

is_inactive

boolean

Example:

false

jwt_data

object

Show child attributes

jwt_data.secret

string

last_check

integer<int64>

Example:

0

last_updated

string

Example:

"1710302206"

max_query_depth

integer

Example:

-1

meta_data

object

Show child attributes

meta_data.{key}

any

Example:

{
  "tyk_developer_id": "62b3fb9a1d5e4f00017226f5"
}

monitor

object

Show child attributes

monitor.trigger_limits

number[] | null

Example:

[80, 60, 50]

oauth_client_id

string

oauth_keys

object

Show child attributes

oauth_keys.{key}

string

org_id

string

Example:

"5e9d9544a1dcd60001d0ed20"

per

number<double>

Example:

5

quota_max

integer<int64>

Example:

20000

quota_remaining

integer<int64>

Example:

20000

quota_renewal_rate

integer<int64>

Example:

31556952

quota_renews

integer<int64>

Example:

1710302205

rate

number<double>

Example:

1

rsa_certificate_id

string

session_lifetime

integer<int64>

Example:

0

smoothing

object

Show child attributes

smoothing.delay

integer

smoothing.enabled

boolean

smoothing.step

integer

smoothing.threshold

integer

smoothing.trigger

number

Response

New custom key added.

action

string

Example:

"modified"

key

string

Example:

"b13d928b9972bd18"

key_hash

string

status

string

Example:

"ok"

Update key.Delete a key.

⌘I

Overview

Getting Started

Deploy Tyk

Managing APIs

Security in Tyk

Reference

Developer Support

Create custom key / Import key

Authorizations

Path Parameters

Query Parameters

Body

Response