Sign in
Toolkit Keys

Update toolkit key

Update a key's label, IP allowlist, or revoked flag.

patch/toolkits/{toolkit_id}/keys/{key_id}

Path parameters

toolkit_idstring required
key_idstring required

Request body

allowed_ipsstring[] nullable
labelstring nullable
revokedboolean nullable

Response

Successful Response

allowed_ipsstring[] nullable
created_atstring date-time required
key_idstring required
key_previewstring required
labelstring nullable
last_used_atstring date-time nullable
revokedboolean required
toolkit_idstring required

Changes

Changed in 2 of the 88 revisions of this API.131143

  • d65fcba0d25a3228See the full diff
    • ▲

      response property created_at list-of-types was widened by adding types string to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      the detail response's property type/format changed from array/ to string/ for status 422

      response-property-type-changed

    • ▲

      removed the required property id from the response with the 200 status

      response-required-property-removed

    • ●

      removed the optional property name from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property prefix from the response with the 200 status

      response-optional-property-removed

    • ○

      api operation id patch_toolkit_key_toolkits__toolkit_id__keys__key_id__patch removed and replaced with updateKey

      api-operation-id-removed

    • ○

      the endpoint scheme security BearerAuth was added to the API

      api-security-added

    • ○

      the endpoint scheme security HumanLogin was removed from the API

      api-security-removed

    • ○

      api tag Toolkit Keys added

      api-tag-added

    • ○

      api tag toolkits removed

      api-tag-removed

    • ○

      added the new optional request property revoked

      new-optional-request-property

    • ○

      media type application/json was changed to a more specific media type application/problem+json for the response status 422

      response-media-type-name-specialized

    • ○

      added the non-success response with the status 400

      response-non-success-status-added

    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      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 non-success response with the status 500

      response-non-success-status-added

    • ○

      added the non-success response with the status 503

      response-non-success-status-added

    • ○

      added the optional property code to the response with the 422 status

      response-optional-property-added

    • ○

      added the optional property errors to the response with the 422 status

      response-optional-property-added

    • ○

      added the optional property instance to the response with the 422 status

      response-optional-property-added

    • ○

      added the optional property label to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property last_used_at to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property status to the response with the 422 status

      response-optional-property-added

    • ○

      added the optional property title to the response with the 422 status

      response-optional-property-added

    • ○

      added the optional property type to the response with the 422 status

      response-optional-property-added

    • ○

      the response property created_at became required for the status 200

      response-property-became-required

    • ○

      the response property detail became required for the status 422

      response-property-became-required

    • ○

      the response property revoked became required for the status 200

      response-property-became-required

    • ○

      the revoked response's property default value false was removed for the status 200

      response-property-default-value-removed

    • ○

      added the required property key_id to the response with the 200 status

      response-required-property-added

    • ○

      added the required property key_preview to the response with the 200 status

      response-required-property-added

    • ○

      added the required property toolkit_id to the response with the 200 status

      response-required-property-added

    This revision also has 61 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 76e8f606372810915See the full diff
    • ▲

      media type application/problem+json was changed to a more general media type application/json for the response status 422

      response-media-type-name-generalized

    • ▲

      the response property created_at became optional for the status 200

      response-property-became-optional

    • ▲

      the response property detail became optional for the status 422

      response-property-became-optional

    • ▲

      the response property revoked became optional for the status 200

      response-property-became-optional

    • ▲

      response property created_at list-of-types was widened by adding types null and number to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      the detail response property's maxLength was unset from 4096 for the response status 422

      response-property-max-length-unset

    • ▲

      the detail response's property type/format changed from string/ to array/ for status 422

      response-property-type-changed

    • ▲

      removed the required property key_id from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property key_preview from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property toolkit_id from the response with the 200 status

      response-required-property-removed

    • ●

      removed the request property revoked

      request-property-removed

    • ●

      removed the optional property code from the response with the 422 status

      response-optional-property-removed

    • ●

      removed the optional property errors from the response with the 422 status

      response-optional-property-removed

    • ●

      removed the optional property instance from the response with the 422 status

      response-optional-property-removed

    • ●

      removed the optional property label from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property last_used_at from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property status from the response with the 422 status

      response-optional-property-removed

    • ●

      removed the optional property title from the response with the 422 status

      response-optional-property-removed

    • ●

      removed the optional property type from the response with the 422 status

      response-optional-property-removed

    • ○

      api operation id updateKey removed and replaced with patch_toolkit_key_toolkits__toolkit_id__keys__key_id__patch

      api-operation-id-removed

    • ○

      the endpoint scheme security HumanLogin was added to the API

      api-security-added

    • ○

      the endpoint scheme security BearerAuth was removed from the API

      api-security-removed

    • ○

      api tag toolkits added

      api-tag-added

    • ○

      api tag Toolkit Keys removed

      api-tag-removed

    • ○

      removed the non-success response with the status 400

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 401

      response-non-success-status-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

    • ○

      removed the non-success response with the status 500

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 503

      response-non-success-status-removed

    • ○

      added the optional property name to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property prefix to the response with the 200 status

      response-optional-property-added

    • ○

      the revoked response's property default value false was added for the status 200

      response-property-default-value-added

    • ○

      added the required property id to the response with the 200 status

      response-required-property-added

    This revision also has 179 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog