API Key

Create an API Key

Creates a new API key on the authenticated account. The plaintext secret is returned in the api_key field of the response body and cannot be retrieved again — callers must capture it from this response. Requires a readwrite API key.

post/v1/api_keys

Request

  • Base URL: https://api.instrumentl.com
  • URL: https://api.instrumentl.com/v1/api_keys
  • Auth: HTTP basic

Request body

Response

defaults to readonly when mode is omitted

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
api_keystring required

The plaintext API key secret. This value is only returned on creation and cannot be retrieved again.

Changes

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