API Keys

The api_keys table contains data about API keys for the organization. This table contains sensitive data! API keys allow read and write access to data and should be secured at all times.

This table can be used to determine past and current API keys active for the organization, as well as metadata such as when an API key was created.

Columns

Column Name Description Type Nullable
id The numerical identifier of the object. INT8 No
target The type of API key. Always rest. VARCHAR No
api_key The API key, for authorizing API calls. VARCHAR No
created_by_id The numerical identifier of the user that created this API key on the user interface. Relates to the id column in the users table. INT8 No
revoked_by_id The numerical identifier of the user that revoked this API key on the user interface, if it is revoked. Relates to the id column in the users table. INT8 Yes
revoked_at The UTC timestamp when this API key was revoked, if it is revoked. TIMESTAMP Yes
created_at The UTC timestamp when this object was created. TIMESTAMP No
updated_at The UTC timestamp when this object was last updated. TIMESTAMP No