With API ID and key ID.

Authorizations

Authorization

string

header

required

The Tyk Dashboard API Access Credentials

Path Parameters

apiID

string

required

ID of API the keys grant access to. Can either be the internal or external API ID.

keyID

string

required

The Key ID.

Query Parameters

auto_guess

enum<boolean>

default:false

If you are not sure if a key is hashed you can send this as true.

Available options:

true,

false

hashed

string

Use the hash of the key as input instead of the full key. Any none empty string will be interpreted as to say you want to use hash input.

username

enum<boolean>

Set to true if the passed key ID is a username.

Available options:

true,

false

suppress_reset

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.

Body

application/json

access_rights

object

Show child attributes

access_rights.{key}

object

Show child attributes

access_rights.{key}.allowance_scope

string

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", "PATCH", "HEAD", "PUT", "DELETE"]

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

integer<int64>

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

integer<int64>

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<double>

access_rights.{key}.limit.quota_max

integer<int64>

access_rights.{key}.limit.quota_remaining

integer<int64>

access_rights.{key}.limit.quota_renewal_rate

integer<int64>

access_rights.{key}.limit.quota_renews

integer<int64>

access_rights.{key}.limit.rate

number<double>

access_rights.{key}.limit.set_by_policy

boolean

access_rights.{key}.limit.smoothing

object

Show child attributes

access_rights.{key}.limit.smoothing.delay

integer<int64>

Delay is a hold-off between smoothing events and controls how frequently the current allowance will step up or down (in seconds).

Required range: x >= 1

access_rights.{key}.limit.smoothing.enabled

boolean

Enabled indicates if rate limit smoothing is active.

access_rights.{key}.limit.smoothing.step

integer<int64>

Step is the increment by which the current allowance will be increased or decreased each time a smoothing event is emitted.

Required range: x >= 1

access_rights.{key}.limit.smoothing.threshold

integer<int64>

Threshold is the initial rate limit beyond which smoothing will be applied. It is a count of requests during the per interval and should be less than the maximum configured rate.

Required range: x >= 1

access_rights.{key}.limit.smoothing.trigger

number<double>

Trigger is a fraction (typically in the range 0.1-1.0) of the step at which point a smoothing event will be emitted as the request rate approaches the current allowance.

Required range: x >= 0Must be a multiple of 0.01

access_rights.{key}.limit.throttle_interval

number<double>

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",
  "615d2e528bf3980001c7c6c2"
]

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

Example:

"bcrypt"

basic_auth_data.password

string

Example:

"testuse1"

basic_auth_data.user

string

Example:

"[email protected]"

certificate

string

data_expires

integer<int64>

Example:

0

date_created

string<date-time>

Example:

"2024-05-14T13:15:46.560506+03:00"

enable_detailed_recording

boolean

Example:

true

expires

integer<int64>

Example:

1716895221

hmac_enabled

boolean

Example:

false

hmac_string

string

id_extractor_deadline

integer<int64>

Example:

0

is_inactive

boolean

jwt_data

object

Show child attributes

jwt_data.secret

string

key_id

string

last_check

integer<int64>

Example:

0

last_updated

string

Example:

"1715681746"

max_query_depth

integer

Example:

5

meta_data

any

monitor

object

Show child attributes

monitor.trigger_limits

number<double>[] | 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:

60

quota_max

integer<int64>

Example:

1710302205

quota_remaining

integer<int64>

Example:

20000

quota_renewal_rate

integer<int64>

Example:

-1

quota_renews

integer<int64>

Example:

1715681745

rate

number<double>

Example:

1000

session_lifetime

integer<int64>

Example:

0

smoothing

object

Show child attributes

smoothing.delay

integer<int64>

Delay is a hold-off between smoothing events and controls how frequently the current allowance will step up or down (in seconds).

Required range: x >= 1

smoothing.enabled

boolean

Enabled indicates if rate limit smoothing is active.

smoothing.step

integer<int64>

Step is the increment by which the current allowance will be increased or decreased each time a smoothing event is emitted.

Required range: x >= 1

smoothing.threshold

integer<int64>

Threshold is the initial rate limit beyond which smoothing will be applied. It is a count of requests during the per interval and should be less than the maximum configured rate.

Required range: x >= 1

smoothing.trigger

number<double>

Trigger is a fraction (typically in the range 0.1-1.0) of the step at which point a smoothing event will be emitted as the request rate approaches the current allowance.

Required range: x >= 0Must be a multiple of 0.01

Response

Key updated

api_model

object

data

object

Show child attributes

data.access_rights

object

Show child attributes

data.access_rights.{key}

object

Show child attributes

data.access_rights.{key}.allowance_scope

string

data.access_rights.{key}.allowed_types

object[] | null

Show child attributes

data.access_rights.{key}.allowed_types.fields

string[] | null

data.access_rights.{key}.allowed_types.name

string

data.access_rights.{key}.allowed_urls

object[] | null

Show child attributes

data.access_rights.{key}.allowed_urls.methods

string[] | null

Example:

["GET", "PATCH", "HEAD", "PUT", "DELETE"]

data.access_rights.{key}.allowed_urls.url

string

Example:

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

data.access_rights.{key}.api_id

string

Example:

"d1dfc6a927a046c54c0ed470f19757cc"

data.access_rights.{key}.api_name

string

Example:

"Rate Limit Proxy API"

data.access_rights.{key}.disable_introspection

boolean

Example:

false

data.access_rights.{key}.endpoints

object[]

Show child attributes

data.access_rights.{key}.endpoints.methods

object[]

Show child attributes

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

object

Show child attributes

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

integer<int64>

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

integer<int64>

data.access_rights.{key}.endpoints.methods.name

string

data.access_rights.{key}.endpoints.path

string

data.access_rights.{key}.field_access_rights

object[] | null

Show child attributes

data.access_rights.{key}.field_access_rights.field_name

string

data.access_rights.{key}.field_access_rights.limits

object

Show child attributes

data.access_rights.{key}.field_access_rights.limits.max_query_depth

integer

data.access_rights.{key}.field_access_rights.type_name

string

data.access_rights.{key}.limit

object

Show child attributes

data.access_rights.{key}.limit.max_query_depth

integer

data.access_rights.{key}.limit.per

number<double>

data.access_rights.{key}.limit.quota_max

integer<int64>

data.access_rights.{key}.limit.quota_remaining

integer<int64>

data.access_rights.{key}.limit.quota_renewal_rate

integer<int64>

data.access_rights.{key}.limit.quota_renews

integer<int64>

data.access_rights.{key}.limit.rate

number<double>

data.access_rights.{key}.limit.set_by_policy

boolean

data.access_rights.{key}.limit.smoothing

object

Show child attributes

data.access_rights.{key}.limit.smoothing.delay

integer<int64>

Delay is a hold-off between smoothing events and controls how frequently the current allowance will step up or down (in seconds).

Required range: x >= 1

data.access_rights.{key}.limit.smoothing.enabled

boolean

Enabled indicates if rate limit smoothing is active.

data.access_rights.{key}.limit.smoothing.step

integer<int64>

Step is the increment by which the current allowance will be increased or decreased each time a smoothing event is emitted.

Required range: x >= 1

data.access_rights.{key}.limit.smoothing.threshold

integer<int64>

Threshold is the initial rate limit beyond which smoothing will be applied. It is a count of requests during the per interval and should be less than the maximum configured rate.

Required range: x >= 1

data.access_rights.{key}.limit.smoothing.trigger

number<double>

Trigger is a fraction (typically in the range 0.1-1.0) of the step at which point a smoothing event will be emitted as the request rate approaches the current allowance.

Required range: x >= 0Must be a multiple of 0.01

data.access_rights.{key}.limit.throttle_interval

number<double>

data.access_rights.{key}.limit.throttle_retry_limit

integer

data.access_rights.{key}.restricted_types

object[] | null

Show child attributes

data.access_rights.{key}.restricted_types.fields

string[] | null

data.access_rights.{key}.restricted_types.name

string

data.access_rights.{key}.versions

string[] | null

Example:

["Default", "v2"]

data.alias

string

Example:

"[email protected]"

data.allowance

number<double>

Example:

1000

data.apply_policies

string[] | null

Example:

[
  "641c15dd0fffb800010197bf",
  "615d2e528bf3980001c7c6c2"
]

data.apply_policy_id

string

deprecated

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

Example:

"641c15dd0fffb800010197bf"

data.basic_auth_data

object

Show child attributes

data.basic_auth_data.hash_type

string

Example:

"bcrypt"

data.basic_auth_data.password

string

Example:

"testuse1"

data.basic_auth_data.user

string

Example:

"[email protected]"

data.certificate

string

data.data_expires

integer<int64>

Example:

0

data.date_created

string<date-time>

Example:

"2024-05-14T13:15:46.560506+03:00"

data.enable_detailed_recording

boolean

Example:

true

data.expires

integer<int64>

Example:

1716895221

data.hmac_enabled

boolean

Example:

false

data.hmac_string

string

data.id_extractor_deadline

integer<int64>

Example:

0

data.is_inactive

boolean

data.jwt_data

object

Show child attributes

data.jwt_data.secret

string

data.key_id

string

data.last_check

integer<int64>

Example:

0

data.last_updated

string

Example:

"1715681746"

data.max_query_depth

integer

Example:

5

data.meta_data

any

data.monitor

object

Show child attributes

data.monitor.trigger_limits

number<double>[] | null

Example:

[80, 60, 50]

data.oauth_client_id

string

data.oauth_keys

object

Show child attributes

data.oauth_keys.{key}

string

data.org_id

string

Example:

"5e9d9544a1dcd60001d0ed20"

data.per

number<double>

Example:

60

data.quota_max

integer<int64>

Example:

1710302205

data.quota_remaining

integer<int64>

Example:

20000

data.quota_renewal_rate

integer<int64>

Example:

-1

data.quota_renews

integer<int64>

Example:

1715681745

data.rate

number<double>

Example:

1000

data.session_lifetime

integer<int64>

Example:

0

data.smoothing

object

Show child attributes

data.smoothing.delay

integer<int64>

Delay is a hold-off between smoothing events and controls how frequently the current allowance will step up or down (in seconds).

Required range: x >= 1

data.smoothing.enabled

boolean

Enabled indicates if rate limit smoothing is active.

data.smoothing.step

integer<int64>

Step is the increment by which the current allowance will be increased or decreased each time a smoothing event is emitted.

Required range: x >= 1

data.smoothing.threshold

integer<int64>

Threshold is the initial rate limit beyond which smoothing will be applied. It is a count of requests during the per interval and should be less than the maximum configured rate.

Required range: x >= 1

data.smoothing.trigger

number<double>

Trigger is a fraction (typically in the range 0.1-1.0) of the step at which point a smoothing event will be emitted as the request rate approaches the current allowance.

Required range: x >= 0Must be a multiple of 0.01

data.tags

string[] | null

Example:

["edge", "edge-eu"]

data.throttle_interval

number<double>

Example:

10

data.throttle_retry_limit

integer

Example:

-1

key_hash

string

Example:

"41c5cb1e"

key_id

string

Example:

"5e9d9544a1dcd60001d0ed20e7f75f9e03534825b7aef9df749582e5"

Overview

Getting Started

Deploy Tyk

Managing APIs

Security in Tyk

Reference

Developer Support

Authorizations

Path Parameters

Query Parameters

Body

Response