Get an Organisation Key

Get session info about specified organisation key. Should return up to date rate limit and quota usage numbers.

GET /tyk/org/keys/{keyID}

Try it

Get an Organisation Key

cURL

curl --request GET \
  --url https://{tenant}/tyk/org/keys/{keyID} \
  --header 'X-Tyk-Authorization: <api-key>'

200

{
  "access_rights": {},
  "alias": "<string>",
  "allowance": 123,
  "apply_policies": [
    "<string>"
  ],
  "date_created": "2023-11-07T05:31:56Z",
  "enable_detailed_recording": true,
  "last_updated": "<string>",
  "meta_data": {},
  "org_id": "<string>",
  "per": 123,
  "quota_max": 123,
  "quota_renewal_rate": 123,
  "quota_renews": 123,
  "rate": 123,
  "tags": [
    "<string>"
  ],
  "throttle_interval": 123,
  "throttle_retry_limit": 123
}

Authorizations

X-Tyk-Authorization · string · header · required

Api key

Path Parameters

keyID · string · required

The Key ID

Query Parameters

orgID · string

The Org ID

Response

200

application/json

OK

access_rights · object

Show child attributes

access_rights. {key} · object

Show child attributes

access_rights.{key}. allowed_urls · object[] | null

Show child attributes

access_rights.{key}.allowed_urls. methods · string[] | null

access_rights.{key}.allowed_urls. url · string

access_rights.{key}. api_id · string

access_rights.{key}. api_name · string

access_rights.{key}. limit · object

Show child attributes

access_rights.{key}.limit. per · integer

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. rate · integer

access_rights.{key}.limit. throttle_interval · integer

access_rights.{key}.limit. throttle_retry_limit · integer

access_rights.{key}. versions · string[] | null

alias · string

allowance · integer

apply_policies · string[] | null

date_created · string<date-time>

enable_detailed_recording · boolean

last_updated · string

meta_data · object

Show child attributes

meta_data. {key} · string

org_id · string

per · integer

quota_max · integer

quota_renewal_rate · integer

quota_renews · integer

rate · integer

tags · string[] | null

throttle_interval · integer

throttle_retry_limit · integer