Organisation Quotas

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}

Path parameters

keyIDstring required

The Key ID

Query parameters

orgIDstring

The Org ID

Response

access_rightsobject nullable

aliasstring

allowanceinteger

apply_policiesstring[] nullable

date_createdstring date-time

enable_detailed_recordingboolean

last_updatedstring

meta_dataobject nullable

org_idstring

perinteger

quota_maxinteger

quota_renewal_rateinteger

quota_renewsinteger

rateinteger

tagsstring[] nullable

throttle_intervalinteger

throttle_retry_limitinteger

Changes

Changed in 4 of the 52 revisions of this API.252629

Sep 18, 2024111affa17abe17215See the full diff
- ▲
  added the new path request parameter keyID
  new-request-path-parameter
- ▲
  the response property access_rights became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property access_rights/additionalProperties/allowed_urls became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property access_rights/additionalProperties/allowed_urls/items/methods became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property access_rights/additionalProperties/versions became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property apply_policies became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property meta_data became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property tags became nullable for the status 200
  response-property-became-nullable
- ▲
  the access_rights/additionalProperties/limit/quota_max response's property type/format changed from integer/int64 to integer/ for status 200
  response-property-type-changed
- ▲
  the access_rights/additionalProperties/limit/quota_remaining response's property type/format changed from integer/int64 to integer/ for status 200
  response-property-type-changed
- ▲
  the access_rights/additionalProperties/limit/quota_renewal_rate response's property type/format changed from integer/int64 to integer/ for status 200
  response-property-type-changed
- ▲
  the access_rights/additionalProperties/limit/throttle_retry_limit response's property type/format changed from integer/int64 to integer/ for status 200
  response-property-type-changed
- ▲
  the meta_data/additionalProperties/ response's property type/format changed from object/ to string/ for status 200
  response-property-type-changed
- ▲
  the quota_max response's property type/format changed from integer/int64 to integer/ for status 200
  response-property-type-changed
- ▲
  the quota_renewal_rate response's property type/format changed from integer/int64 to integer/ for status 200
  response-property-type-changed
- ▲
  the quota_renews response's property type/format changed from integer/int64 to integer/ for status 200
  response-property-type-changed
- ▲
  the throttle_retry_limit response's property type/format changed from integer/int64 to integer/ for status 200
  response-property-type-changed
- ●
  removed the optional property access_rights/additionalProperties/endpoints from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property access_rights/additionalProperties/limit/quota_renews from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property access_rights/additionalProperties/limit/set_by_policy from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property apply_policy_id from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property basic_auth_data from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property certificate from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property data_expires from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property enable_detail_recording from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property expires from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property hmac_enabled from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property hmac_string from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property id_extractor_deadline from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property is_inactive from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property jwt_data from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property last_check from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property monitor from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property oauth_client_id from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property oauth_keys from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property quota_remaining from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property session_lifetime from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property smoothing from the response with the 200 status
  response-optional-property-removed
- ○
  added the new optional query request parameter orgID
  new-optional-request-parameter
- ○
  added the non-success response with the status 403
  response-non-success-status-added
- ○
  added the non-success response with the status 404
  response-non-success-status-added
- ○
  added the optional property date_created to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property enable_detailed_recording to the response with the 200 status
  response-optional-property-added
This revision also has 28 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 21, 202431989871353c11See the full diff
- ●
  removed the optional property access_rights/additionalProperties/limit/smoothing from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property access_rights/additionalProperties/endpoints to the response with the 200 status
  response-optional-property-added
Jun 17, 20241938d97cb6b52See the full diff
- ○
  added the optional property access_rights/additionalProperties/limit/smoothing to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property smoothing to the response with the 200 status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 24, 2022111d8ca218648421See the full diff
- ▲
  the access_rights/additionalProperties/limit/per response's property type/format changed from integer/ to number/double for status 200
  response-property-type-changed
- ▲
  the access_rights/additionalProperties/limit/rate response's property type/format changed from integer/ to number/double for status 200
  response-property-type-changed
- ▲
  the access_rights/additionalProperties/limit/throttle_interval response's property type/format changed from integer/ to number/double for status 200
  response-property-type-changed
- ▲
  the allowance response's property type/format changed from integer/ to number/double for status 200
  response-property-type-changed
- ▲
  the meta_data/additionalProperties/ response's property type/format changed from string/ to object/ for status 200
  response-property-type-changed
- ▲
  the per response's property type/format changed from integer/ to number/double for status 200
  response-property-type-changed
- ▲
  the rate response's property type/format changed from integer/ to number/double for status 200
  response-property-type-changed
- ▲
  the throttle_interval response's property type/format changed from integer/ to number/double for status 200
  response-property-type-changed
- ●
  deleted the path request parameter keyID
  request-parameter-removed
- ●
  deleted the query request parameter orgID
  request-parameter-removed
- ●
  removed the optional property date_created from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property enable_detailed_recording from the response with the 200 status
  response-optional-property-removed
- ○
  removed the non-success response with the status 403
  response-non-success-status-removed
- ○
  removed the non-success response with the status 404
  response-non-success-status-removed
- ○
  added the optional property access_rights/additionalProperties/limit/quota_renews to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property access_rights/additionalProperties/limit/set_by_policy to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property apply_policy_id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property basic_auth_data to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property certificate to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property data_expires to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property enable_detail_recording to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property expires to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property hmac_enabled to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property hmac_string to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property id_extractor_deadline to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property is_inactive to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property jwt_data to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property last_check to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property monitor to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property oauth_client_id to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property oauth_keys to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property quota_remaining to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property session_lifetime to the response with the 200 status
  response-optional-property-added
This revision also has 155 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history