Skip to main content
POST
/
v1
/
key
Create a API key
curl --request POST \
  --url https://api.formizee.com/v1/key \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "My New Key",
  "expiresAt": "90-days"
}
'
{
  "id": "key_4VjHrJoEwAFC6itz8oUBW9NW2bia",
  "name": "My New Key",
  "workspaceId": "ws_4VjHrJoEwAFC6itz8oUBW9NW2bia",
  "expiresAt": "2024-07-23 12:41:45.38215",
  "lastAccess": "2024-07-23 12:41:45.38215"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
string
required

The name of the key

Required string length: 4 - 64
Example:

"My New Key"

​
expiresAt
enum<string>
required

The expiration date of the key

Available options:
1-day,
7-days,
30-days,
60-days,
90-days,
180-days,
1-year,
never
Example:

"90-days"

Response

Create a key

​
id
string
required

The id of the key

Example:

"key_4VjHrJoEwAFC6itz8oUBW9NW2bia"

​
name
string
required

The name of the key

Required string length: 4 - 64
Example:

"My New Key"

​
workspaceId
string
required

The id of the workspace

Example:

"ws_4VjHrJoEwAFC6itz8oUBW9NW2bia"

​
expiresAt
string
required

The expiration date of the key

Example:

"2024-07-23 12:41:45.38215"

​
lastAccess
string

The last time the key was used

Example:

"2024-07-23 12:41:45.38215"