Create custom key / Import key

You can use this endpoint to import existing keys into Tyk or to create a new custom key.

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 · boolean

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

Body

application/json

access_rights · object | null

Show child attributes

alias · string

Example:

"[e-mail]"

allowance · number

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

certificate · string

data_expires · integer

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

Example:

1712895619

hmac_enabled · boolean

Example:

false

hmac_string · string

id_extractor_deadline · integer

is_inactive · boolean

Example:

false

jwt_data · object

Show child attributes

last_check · integer

Example:

0

last_updated · string

Example:

"1710302206"

max_query_depth · integer

Example:

-1

meta_data · object | null

Show child attributes

Example:

{
  "tyk_developer_id": "62b3fb9a1d5e4f00017226f5"
}

monitor · object

Show child attributes

oauth_client_id · string

oauth_keys · object | null

Show child attributes

org_id · string

Example:

"5e9d9544a1dcd60001d0ed20"

per · number

Example:

5

quota_max · integer

Example:

20000

quota_remaining · integer

Example:

20000

quota_renewal_rate · integer

Example:

31556952

quota_renews · integer

Example:

1710302205

rate · number

Example:

1

rsa_certificate_id · string

session_lifetime · integer

Example:

0

smoothing · object | null

Show child attributes

tags · string[] | null

Example:

["edge", "edge-eu"]

throttle_interval · number

Example:

10

throttle_retry_limit · integer

Example:

1000

Response

200

application/json

New custom key added.

action · string

Example:

"modified"

key · string

Example:

"b13d928b9972bd18"

key_hash · string

status · string

Example:

"ok"