HThtmlcsstoimage
API Keys

List API keys

Changed on

Returns keys in descending creation order. Disabled keys are excluded unless include_disabled=true. with_permission filters use all-of matching. Follow pagination.next_page_start until null. Secrets are never returned.

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

Request

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

Query parameters

integer
OR
string int32

Maximum number of keys to return, from 1 to 100. Defaults to 10.

page_startstring

pagination.next_page_start from the previous response. Omit for the first page.

include_disabledboolean

Include disabled keys. Defaults to false.

with_permissionstring[]

Return keys allowing every specified permission, including wildcard grants. Repeat this query parameter for multiple permissions; do not separate names with spaces or commas.

Response

OK

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 enum value webhooks:create_update to the property items/ of the query request parameter with_permission

    • info

      added the enum value webhooks:delete to the property items/ of the query request parameter with_permission

    • info

      added the enum value webhooks:read to the property items/ of the query request parameter with_permission

  • 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 enum value debugs:create to the property items/ of the query request parameter with_permission

    • info

      added the enum value debugs:read to the property items/ of the query request parameter with_permission