Create API Key

POST 
/organizations/:organizationId/api-keys

Generate a new API key for external API access. The full key secret is ONLY returned in this response - store it securely! API access is only available for Professional and Enterprise plans.

Request

Path Parameters

organizationId stringrequired

Organization ID

application/json

Body

required

name stringrequired

User-friendly name for the API key

permissions string[]

Optional array of permission scopes

Responses

200

application/json

Schema

Schema

data objectrequired
Response data
id stringrequired
name stringrequired
keyPrefix stringrequired
secret stringrequired
status stringrequired
permissions string[]
createdAt numberrequired

Example (from schema)

{
  "data": {
    "id": "string",
    "name": "string",
    "keyPrefix": "string",
    "secret": "string",
    "status": "string",
    "permissions": [
      "string"
    ],
    "createdAt": 0
  }
}

Example

{}

401

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Unauthenticated",
  "message": "Authentication is required and has failed or has not yet been provided."
}

403

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Forbidden",
  "message": "Access to the requested resource is forbidden."
}

422

The input data has invalid.

application/json

Schema

Schema

error stringrequired

The input data has invalid.

message stringrequired

The input data has invalid message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "ValidationError",
  "message": "Input data validation failed."
}

Loading...