HThtmlcsstoimage
API Keys

Create an API key

Changed on

Creates a key with explicit permissions no broader than the calling key's current grants. Save api_key securely: only this response includes the secret.

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

post/v1/api-keys

Request

  • Base URL
    https://hcti.io
  • URL
    https://hcti.io/v1/api-keys
  • Auth
    HTTP basic

Request body

namestring nullable

Display name for the key, up to 255 characters. Omitted, null, or blank names use Key created YYYY-MM-DD HH:mm:ss, based on the key's original creation time in UTC.

descriptionstring nullable

Optional description of the key's purpose, up to 2000 characters. Omitted, null, or blank clears the description.

disabledboolean

Whether the key is disabled. Disabled keys cannot authenticate requests. Defaults to false.

all_future_permissionsboolean

Grant all current and future permissions. Only callers with this authority can enable it. Defaults to false.

permissionsstring[] required

Complete list of current permissions to grant, for example images:create or templates:read. Ignored when all_future_permissions is true; supply an empty array in that case. Otherwise, an empty array grants no product permissions. Permissions cannot exceed the caller's authority.

Response

OK

api_keystring required

Secret API key used as the password when authenticating API requests. Store it securely; subsequent API responses do not include it.

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

    • info

      added the new webhooks:create_update enum value to the request property /

    • info

      added the new webhooks:delete enum value to the request property /

    • info

      added the new webhooks:read enum value to the request property /

  • 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

    • info

      added the new debugs:create enum value to the request property /

    • info

      added the new debugs:read enum value to the request property /