API Key

Disable an API Key

Disables an API key. Subsequent requests using the disabled key will fail authentication. Self-disabling is permitted: a key may disable itself, but requests after that will be rejected. Requires a readwrite API key. The request is idempotent — disabling an already-disabled key succeeds without modifying the key.

post/v1/api_keys/{id}/disable

Request

  • Base URL: https://api.instrumentl.com
  • URL: https://api.instrumentl.com/v1/api_keys/{id}/disable
  • Auth: HTTP basic

Path parameters

idstring api_id required

Response

idempotent when already disabled

idstring api_id required
labelstring required
mode'is_readonly' | 'is_readwrite' required
disabled_atstring date-time nullable required
last_used_atstring date-time nullable required
created_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.