Update Organisation Key
PUT {{baseUrl}}/tyk/org/keys/:keyID?reset_quota=1
This work similar to Keys API except that Key ID is always equals Organisation ID
For Gateway v2.6.0 onwards, you can now set rate limits at the organisation level by using the following fields - allowance and rate. These are the number of allowed requests for the specified per value, and need to be set to the same value. If you don't want to have organisation level rate limiting, set rate
or per
to zero, or don't add them to your request.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
reset_quota | number | Adding the reset_quota parameter and setting it to 1, will cause Tyk reset the organisations quota in the live quota manager, it is recommended to use this mechanism to reset organisation-level access if a monthly subscription is in place. |
Request Body
{"tags"=>["<string>", "<string>"], "access_rights"=>{"id_b9b"=>{"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>"}, "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"=>{"consequat95b"=>"<string>", "incididunt_3"=>"<string>"}, "org_id"=>"<string>", "per"=>"<double>", "quota_max"=>"<long>", "quota_remaining"=>"<long>", "quota_renewal_rate"=>"<long>", "quota_renews"=>"<long>", "rate"=>"<double>", "session_lifetime"=>"<long>", "throttle_interval"=>"<double>", "throttle_retry_limit"=>"<long>"}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"action":"\u003cstring\u003e","key":"\u003cstring\u003e","key_hash":"\u003cstring\u003e","status":"\u003cstring\u003e"}