Skip to main content
POST
Create a new API key

Authorizations

X-Api-Key
string
header
required

Path Parameters

projectIdOrName
string
required

The Ampersand project ID or project name.

Body

application/json
label
string
required

A short name for the API key.

Example:

"MailMonkey API Key"

scopes
string[]

The scopes for the API key.

Response

Created

key
string
required

The API key.

Example:

"api-key-123"

label
string
required

A short name for the API key.

Example:

"MailMonkey API Key"

scopes
string[]
required

The scopes for the API key.

projectId
string
required

The project ID.

Example:

"my-project"

active
boolean

Whether the API key is active.

Example:

true