Update key.

Update a key with it’s id.

PUT /admin/org/keys/{keyId}

Try it

Update key.

cURL

curl --request PUT \
  --url https://{tenant}/admin/org/keys/{keyId} \
  --header 'Admin-Auth: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "access_rights": {},
  "alias": "<string>",
  "allowance": 123,
  "apply_policies": [
    "<string>"
  ],
  "apply_policy_id": "<string>",
  "basic_auth_data": {
    "hash_type": "<string>",
    "password": "<string>",
    "user": "<string>"
  },
  "certificate": "<string>",
  "data_expires": 123,
  "date_created": "2023-11-07T05:31:56Z",
  "enable_detailed_recording": true,
  "expires": 123,
  "hmac_enabled": true,
  "hmac_string": "<string>",
  "id_extractor_deadline": 123,
  "is_inactive": true,
  "jwt_data": {
    "secret": "<string>"
  },
  "key_id": "<string>",
  "last_check": 123,
  "last_updated": "<string>",
  "max_query_depth": 123,
  "meta_data": "<unknown>",
  "monitor": {
    "trigger_limits": [
      123
    ]
  },
  "oauth_client_id": "<string>",
  "oauth_keys": {},
  "org_id": "<string>",
  "per": 123,
  "quota_max": 123,
  "quota_remaining": 123,
  "quota_renewal_rate": 123,
  "quota_renews": 123,
  "rate": 123,
  "session_lifetime": 123,
  "smoothing": {
    "delay": 123,
    "enabled": true,
    "step": 123,
    "threshold": 123,
    "trigger": 123
  },
  "tags": [
    "<string>"
  ],
  "throttle_interval": 123,
  "throttle_retry_limit": 123
}
'

200

{
  "ID": "<string>",
  "Message": "<string>",
  "Meta": "<unknown>",
  "Status": "<string>"
}

Authorizations

Admin-Auth · string · header · required

Api key

Path Parameters

keyId · string · required

The ID of the key.

Body

application/json

access_rights · object

Show child attributes

access_rights. {key} · object

Show child attributes

access_rights.{key}. allowance_scope · string

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

Show child attributes

access_rights.{key}.allowed_types. fields · string[] | null

access_rights.{key}.allowed_types. name · string

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}. disable_introspection · boolean

access_rights.{key}. endpoints · object[]

Show child attributes

access_rights.{key}.endpoints. methods · object[]

Show child attributes

access_rights.{key}.endpoints.methods. limit · object

Show child attributes

access_rights.{key}.endpoints.methods.limit. per · integer<int64>

access_rights.{key}.endpoints.methods.limit. rate · integer<int64>

access_rights.{key}.endpoints.methods. name · string

access_rights.{key}.endpoints. path · string

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

Show child attributes

access_rights.{key}.field_access_rights. field_name · string

access_rights.{key}.field_access_rights. limits · object

Show child attributes

access_rights.{key}.field_access_rights.limits. max_query_depth · integer

access_rights.{key}.field_access_rights. type_name · string

access_rights.{key}. limit · object

Show child attributes

access_rights.{key}.limit. max_query_depth · integer

access_rights.{key}.limit. per · number<double>

access_rights.{key}.limit. quota_max · integer<int64>

access_rights.{key}.limit. quota_remaining · integer<int64>

access_rights.{key}.limit. quota_renewal_rate · integer<int64>

access_rights.{key}.limit. quota_renews · integer<int64>

access_rights.{key}.limit. rate · number<double>

access_rights.{key}.limit. set_by_policy · boolean

access_rights.{key}.limit. smoothing · object

Show child attributes

access_rights.{key}.limit.smoothing. delay · integer<int64>

access_rights.{key}.limit.smoothing. enabled · boolean

access_rights.{key}.limit.smoothing. step · integer<int64>

access_rights.{key}.limit.smoothing. threshold · integer<int64>

access_rights.{key}.limit.smoothing. trigger · number<double>

access_rights.{key}.limit. throttle_interval · number<double>

access_rights.{key}.limit. throttle_retry_limit · integer

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

Show child attributes

access_rights.{key}.restricted_types. fields · string[] | null

access_rights.{key}.restricted_types. name · string

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

alias · string

allowance · number<double>

apply_policies · string[] | null

apply_policy_id · string

basic_auth_data · object

Show child attributes

basic_auth_data. hash_type · string

basic_auth_data. password · string

basic_auth_data. user · string

certificate · string

data_expires · integer<int64>

date_created · string<date-time>

enable_detailed_recording · boolean

expires · integer<int64>

hmac_enabled · boolean

hmac_string · string

id_extractor_deadline · integer<int64>

is_inactive · boolean

jwt_data · object

Show child attributes

jwt_data. secret · string

key_id · string

last_check · integer<int64>

last_updated · string

max_query_depth · integer

meta_data · any

monitor · object

Show child attributes

monitor. trigger_limits · number<double>[] | null

oauth_client_id · string

oauth_keys · object

Show child attributes

oauth_keys. {key} · string

org_id · string

per · number<double>

quota_max · integer<int64>

quota_remaining · integer<int64>

quota_renewal_rate · integer<int64>

quota_renews · integer<int64>

rate · number<double>

session_lifetime · integer<int64>

smoothing · object

Show child attributes

smoothing. delay · integer<int64>

smoothing. enabled · boolean

smoothing. step · integer<int64>

smoothing. threshold · integer<int64>

smoothing. trigger · number<double>

tags · string[] | null

throttle_interval · number<double>

throttle_retry_limit · integer

Response

200

application/json

Key updated

ID · string

Message · string

Meta · any

Status · string