Update key

PUT {{baseUrl}}/api/apis/:apiID/keys/:keyID

You can also manually add keys to Tyk using your own key-generation algorithm. It is recommended if using this approach to ensure that the OrgID being used in the API Definition and the key data is blank so that Tyk does not try to prepend or manage the key in any way.

Request Body

{"tags"=>["<string>", "<string>"], "access_rights"=>{"eu018"=>{"allowed_urls"=>[{"methods"=>["<string>", "<string>"], "url"=>"<string>"}, {"methods"=>["<string>", "<string>"], "url"=>"<string>"}], "api_id"=>"<string>", "api_name"=>"<string>", "limit"=>{"per"=>"<double>", "quota_max"=>"<long>", "quota_remaining"=>"<long>", "quota_renewal_rate"=>"<long>", "quota_renews"=>"<long>", "rate"=>"<double>", "set_by_policy"=>"<boolean>", "throttle_interval"=>"<double>", "throttle_retry_limit"=>"<long>", "smoothing"=>{"delay"=>"<long>", "enabled"=>"<boolean>", "step"=>"<long>", "threshold"=>"<long>", "trigger"=>"<double>"}}, "versions"=>["<string>", "<string>"]}, "anim_32"=>{"allowed_urls"=>[{"methods"=>["<string>", "<string>"], "url"=>"<string>"}, {"methods"=>["<string>", "<string>"], "url"=>"<string>"}], "api_id"=>"<string>", "api_name"=>"<string>", "limit"=>{"per"=>"<double>", "quota_max"=>"<long>", "quota_remaining"=>"<long>", "quota_renewal_rate"=>"<long>", "quota_renews"=>"<long>", "rate"=>"<double>", "set_by_policy"=>"<boolean>", "throttle_interval"=>"<double>", "throttle_retry_limit"=>"<long>", "smoothing"=>{"delay"=>"<long>", "enabled"=>"<boolean>", "step"=>"<long>", "threshold"=>"<long>", "trigger"=>"<double>"}}, "versions"=>["<string>", "<string>"]}, "consequat_9"=>{"allowed_urls"=>[{"methods"=>["<string>", "<string>"], "url"=>"<string>"}, {"methods"=>["<string>", "<string>"], "url"=>"<string>"}], "api_id"=>"<string>", "api_name"=>"<string>", "limit"=>{"per"=>"<double>", "quota_max"=>"<long>", "quota_remaining"=>"<long>", "quota_renewal_rate"=>"<long>", "quota_renews"=>"<long>", "rate"=>"<double>", "set_by_policy"=>"<boolean>", "throttle_interval"=>"<double>", "throttle_retry_limit"=>"<long>", "smoothing"=>{"delay"=>"<long>", "enabled"=>"<boolean>", "step"=>"<long>", "threshold"=>"<long>", "trigger"=>"<double>"}}, "versions"=>["<string>", "<string>"]}}, "alias"=>"<string>", "allowance"=>"<double>", "apply_policies"=>["<string>", "<string>"], "apply_policy_id"=>"<string>", "basic_auth_data"=>{"hash_type"=>"<string>", "password"=>"<string>"}, "certificate"=>"<string>", "data_expires"=>"<long>", "enable_detail_recording"=>"<boolean>", "expires"=>"<long>", "hmac_enabled"=>"<boolean>", "hmac_string"=>"<string>", "id_extractor_deadline"=>"<long>", "is_inactive"=>"<boolean>", "jwt_data"=>{"secret"=>"<string>"}, "last_check"=>"<long>", "last_updated"=>"<string>", "monitor"=>{"trigger_limits"=>["<double>", "<double>"]}, "oauth_client_id"=>"<string>", "oauth_keys"=>{"voluptatef7e"=>"<string>", "nulla_065"=>"<string>"}, "org_id"=>"<string>", "per"=>"<double>", "quota_max"=>"<long>", "quota_remaining"=>"<long>", "quota_renewal_rate"=>"<long>", "quota_renews"=>"<long>", "rate"=>"<double>", "session_lifetime"=>"<long>", "smoothing"=>{"delay"=>"<long>", "enabled"=>"<boolean>", "step"=>"<long>", "threshold"=>"<long>", "trigger"=>"<double>"}, "throttle_interval"=>"<double>", "throttle_retry_limit"=>"<long>"}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: OK

{&quot;tags&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;access_rights&quot;:{&quot;eu018&quot;:{&quot;allowed_urls&quot;:[{&quot;methods&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;url&quot;:&quot;\u003cstring\u003e&quot;},{&quot;methods&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;url&quot;:&quot;\u003cstring\u003e&quot;}],&quot;api_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;api_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;limit&quot;:{&quot;per&quot;:&quot;\u003cdouble\u003e&quot;,&quot;quota_max&quot;:&quot;\u003clong\u003e&quot;,&quot;quota_remaining&quot;:&quot;\u003clong\u003e&quot;,&quot;quota_renewal_rate&quot;:&quot;\u003clong\u003e&quot;,&quot;quota_renews&quot;:&quot;\u003clong\u003e&quot;,&quot;rate&quot;:&quot;\u003cdouble\u003e&quot;,&quot;set_by_policy&quot;:&quot;\u003cboolean\u003e&quot;,&quot;throttle_interval&quot;:&quot;\u003cdouble\u003e&quot;,&quot;throttle_retry_limit&quot;:&quot;\u003clong\u003e&quot;,&quot;smoothing&quot;:{&quot;delay&quot;:&quot;\u003clong\u003e&quot;,&quot;enabled&quot;:&quot;\u003cboolean\u003e&quot;,&quot;step&quot;:&quot;\u003clong\u003e&quot;,&quot;threshold&quot;:&quot;\u003clong\u003e&quot;,&quot;trigger&quot;:&quot;\u003cdouble\u003e&quot;}},&quot;versions&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;]},&quot;anim_32&quot;:{&quot;allowed_urls&quot;:[{&quot;methods&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;url&quot;:&quot;\u003cstring\u003e&quot;},{&quot;methods&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;url&quot;:&quot;\u003cstring\u003e&quot;}],&quot;api_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;api_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;limit&quot;:{&quot;per&quot;:&quot;\u003cdouble\u003e&quot;,&quot;quota_max&quot;:&quot;\u003clong\u003e&quot;,&quot;quota_remaining&quot;:&quot;\u003clong\u003e&quot;,&quot;quota_renewal_rate&quot;:&quot;\u003clong\u003e&quot;,&quot;quota_renews&quot;:&quot;\u003clong\u003e&quot;,&quot;rate&quot;:&quot;\u003cdouble\u003e&quot;,&quot;set_by_policy&quot;:&quot;\u003cboolean\u003e&quot;,&quot;throttle_interval&quot;:&quot;\u003cdouble\u003e&quot;,&quot;throttle_retry_limit&quot;:&quot;\u003clong\u003e&quot;,&quot;smoothing&quot;:{&quot;delay&quot;:&quot;\u003clong\u003e&quot;,&quot;enabled&quot;:&quot;\u003cboolean\u003e&quot;,&quot;step&quot;:&quot;\u003clong\u003e&quot;,&quot;threshold&quot;:&quot;\u003clong\u003e&quot;,&quot;trigger&quot;:&quot;\u003cdouble\u003e&quot;}},&quot;versions&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;]},&quot;consequat_9&quot;:{&quot;allowed_urls&quot;:[{&quot;methods&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;url&quot;:&quot;\u003cstring\u003e&quot;},{&quot;methods&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;url&quot;:&quot;\u003cstring\u003e&quot;}],&quot;api_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;api_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;limit&quot;:{&quot;per&quot;:&quot;\u003cdouble\u003e&quot;,&quot;quota_max&quot;:&quot;\u003clong\u003e&quot;,&quot;quota_remaining&quot;:&quot;\u003clong\u003e&quot;,&quot;quota_renewal_rate&quot;:&quot;\u003clong\u003e&quot;,&quot;quota_renews&quot;:&quot;\u003clong\u003e&quot;,&quot;rate&quot;:&quot;\u003cdouble\u003e&quot;,&quot;set_by_policy&quot;:&quot;\u003cboolean\u003e&quot;,&quot;throttle_interval&quot;:&quot;\u003cdouble\u003e&quot;,&quot;throttle_retry_limit&quot;:&quot;\u003clong\u003e&quot;,&quot;smoothing&quot;:{&quot;delay&quot;:&quot;\u003clong\u003e&quot;,&quot;enabled&quot;:&quot;\u003cboolean\u003e&quot;,&quot;step&quot;:&quot;\u003clong\u003e&quot;,&quot;threshold&quot;:&quot;\u003clong\u003e&quot;,&quot;trigger&quot;:&quot;\u003cdouble\u003e&quot;}},&quot;versions&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;]}},&quot;alias&quot;:&quot;\u003cstring\u003e&quot;,&quot;allowance&quot;:&quot;\u003cdouble\u003e&quot;,&quot;apply_policies&quot;:[&quot;\u003cstring\u003e&quot;,&quot;\u003cstring\u003e&quot;],&quot;apply_policy_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;basic_auth_data&quot;:{&quot;hash_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;password&quot;:&quot;\u003cstring\u003e&quot;},&quot;certificate&quot;:&quot;\u003cstring\u003e&quot;,&quot;data_expires&quot;:&quot;\u003clong\u003e&quot;,&quot;enable_detail_recording&quot;:&quot;\u003cboolean\u003e&quot;,&quot;expires&quot;:&quot;\u003clong\u003e&quot;,&quot;hmac_enabled&quot;:&quot;\u003cboolean\u003e&quot;,&quot;hmac_string&quot;:&quot;\u003cstring\u003e&quot;,&quot;id_extractor_deadline&quot;:&quot;\u003clong\u003e&quot;,&quot;is_inactive&quot;:&quot;\u003cboolean\u003e&quot;,&quot;jwt_data&quot;:{&quot;secret&quot;:&quot;\u003cstring\u003e&quot;},&quot;last_check&quot;:&quot;\u003clong\u003e&quot;,&quot;last_updated&quot;:&quot;\u003cstring\u003e&quot;,&quot;meta_data&quot;:{&quot;Ut5d&quot;:{},&quot;sintb0&quot;:{}},&quot;monitor&quot;:{&quot;trigger_limits&quot;:[&quot;\u003cdouble\u003e&quot;,&quot;\u003cdouble\u003e&quot;]},&quot;oauth_client_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;oauth_keys&quot;:{&quot;voluptatef7e&quot;:&quot;\u003cstring\u003e&quot;,&quot;nulla_065&quot;:&quot;\u003cstring\u003e&quot;},&quot;org_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;per&quot;:&quot;\u003cdouble\u003e&quot;,&quot;quota_max&quot;:&quot;\u003clong\u003e&quot;,&quot;quota_remaining&quot;:&quot;\u003clong\u003e&quot;,&quot;quota_renewal_rate&quot;:&quot;\u003clong\u003e&quot;,&quot;quota_renews&quot;:&quot;\u003clong\u003e&quot;,&quot;rate&quot;:&quot;\u003cdouble\u003e&quot;,&quot;session_lifetime&quot;:&quot;\u003clong\u003e&quot;,&quot;smoothing&quot;:{&quot;delay&quot;:&quot;\u003clong\u003e&quot;,&quot;enabled&quot;:&quot;\u003cboolean\u003e&quot;,&quot;step&quot;:&quot;\u003clong\u003e&quot;,&quot;threshold&quot;:&quot;\u003clong\u003e&quot;,&quot;trigger&quot;:&quot;\u003cdouble\u003e&quot;},&quot;throttle_interval&quot;:&quot;\u003cdouble\u003e&quot;,&quot;throttle_retry_limit&quot;:&quot;\u003clong\u003e&quot;}