v1

latestOpenAPI 3.1.02026-07-26106201349.6 KB

Gateway

Create API Key

post/v1/accounts/{account_id}/users/{user_id}/apiKeys

Path parameters

account_idstring required

The Account Id

user_idstring required

The User Id

Request body

Response

A successful response.

keyIdstring

Unique identifier (Key ID) for the API key, used primarily for deletion.

displayNamestring

Display name for the API key, defaults to "default" if not specified.

keystring

The actual API key value, only available upon creation and not stored thereafter.

createTimestring date-time

Timestamp indicating when the API key was created.

secureboolean

Indicates whether the plaintext value of the API key is unknown to Fireworks. If true, Fireworks does not know this API key's plaintext value. If false, Fireworks does know the plaintext value.

emailstring

Email of the user who owns this API key.

prefixstring

expireTimestring date-time

Timestamp indicating when the API key will expire. If not set, the key never expires.

annotationsobject

Optional key-value annotations for this API key.

lastUsedstring date-time

Timestamp indicating when the API key was last used. Not set if the key has never been used.

isFirepassboolean

True when this key is a FirePass inference key.