Get a key with ID. - Tyk Documentation

{ "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 }

Authorizations

X-Tyk-Authorization

string

header

required

Api key

Path Parameters

keyID

string

required

The key ID.

Query Parameters

hashed

boolean

Use the hash of the key as input instead of the full key.

Response

Key fetched.

access_rights

object

Show child attributes

alias

string

Example:

"portal-developer@example.org"

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

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

last_check

integer<int64>

Example:

0

last_updated

string

Example:

"1710302206"

max_query_depth

integer

Example:

-1

meta_data

object

Show child attributes

Example:

{
  "tyk_developer_id": "62b3fb9a1d5e4f00017226f5"
}

monitor

object

Show child attributes

oauth_client_id

string

oauth_keys

object

Show child attributes

org_id

string

Example:

"5e9d9544a1dcd60001d0ed20"

per

number<double>

Example:

5

post_expiry_action

enum<string>

Defines the action to take on a Session in Redis after it expires. Valid values are "retain" and "delete".

Available options:

retain,

delete

Example:

"delete"

post_expiry_grace_period

integer<int64>

Duration in seconds to retain a Session in Redis after it expires. Used with post_expiry_action "retain". Set to -1 to retain indefinitely.

Example:

0

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