API Keys Commands

• deleteAPIKeys
• getAPIKeys

getAPIKeys

---

Gets a list of existing API keys.

Arguments

Arguments

Argument Name	Description	Required
api_key_ids	A comma-separated list of API key IDs to retrieve.	Optional
roles	A comma-separated list of roles to retrieve API keys by.	Optional
expires_before	Filter API keys that expire before this date. For example: '1 year'. Filters only for API keys that have an expiration date.	Optional
expires_after	Filter API keys that expire after this date. For example: '1 year'. Filters only API keys that have an expiration date.	Optional

Outputs

Outputs

Core.APIKeyData.id number

The unique identifier of the API key.

Core.APIKeyData.roles string

The roles associated with the API key.

Core.APIKeyData.created_by string

The user who created the API key.

Core.APIKeyData.creation_time number

The date and time the API key was created.

Core.APIKeyData.expiration number

The date and time the API key expires.

Core.APIKeyData.comment string

A comment or note associated with the API key.

deleteAPIKeys

---

Deletes the specified API keys. Any integration or script still using a deleted key immediately loses access.

Arguments

Arguments

Argument Name	Description	Required
api_key_ids	A comma-separated list of API key IDs to delete.	Required

Outputs

There are no outputs for this command.