HThtmlcsstoimage
API Keys

Get an API key

Changed on

Returns the key's metadata and permissions, including for disabled keys. Does not return the secret. Use id, not api_id.

Rate limit: 100 requests per minute per organization, shared across all operations in the api-key:read group and all API keys belonging to that organization.

get/v1/api-keys/{id}

Request

  • Base URL
    https://hcti.io
  • Auth
    HTTP basic

Path parameters

idstring required

Response

OK

idstring required

ID used to retrieve, update, or delete this API key.

api_idstring required

API ID used as the username when authenticating API requests.

namestring required

Display name for the key.

descriptionstring nullable

Description of the key's purpose, if provided.

enabledboolean

Whether the key is enabled.

all_future_permissionsboolean

Whether the key automatically receives all current and future permissions.

permissionsstring[] required
created_atstring date-time

When the key was created, in UTC.

updated_atstring date-time

When the key was last updated, in UTC.

Changes

  • 146fbf859b2dRevision changes
    • warning

      added the new webhooks:create_update enum value to the / response property for the response status

    • warning

      added the new webhooks:delete enum value to the / response property for the response status

    • warning

      added the new webhooks:read enum value to the / response property for the response status

  • b686893a3e5fRevision changes
    • warning

      added the new debugs:create enum value to the / response property for the response status

    • warning

      added the new debugs:read enum value to the / response property for the response status