Sign in
Keys

Create a key

Tyk will generate the access token based on the OrgID specified in the API Definition and a random UUID. This ensures that keys can be "owned" by different API Owners should segmentation be needed at an organisational level. <br/><br/> API keys without access_rights data will be written to all APIs on the system (this also means that they will be created across all SessionHandlers and StorageHandlers, it is recommended to always embed access_rights data in a key to ensure that only targeted APIs and their back-ends are written to.

post/tyk/keys

Request body

tagsstring[]
access_rightsobject
aliasstring
allowancenumber double
apply_policiesstring[]
apply_policy_idstring
certificatestring
data_expiresinteger
enable_detail_recordingboolean
expiresinteger
hmac_enabledboolean
hmac_stringstring
id_extractor_deadlineinteger
is_inactiveboolean
last_checkinteger
last_updatedstring
meta_dataobject
oauth_client_idstring
oauth_keysobject
org_idstring
pernumber double
quota_maxinteger
quota_remaininginteger
quota_renewal_rateinteger
quota_renewsinteger
ratenumber double
session_lifetimeinteger
throttle_intervalnumber double
throttle_retry_limitinteger

Response

New Key added

actionstring
keystring

in:body

key_hashstring
statusstring

Changes