Skip to main content
POST
Create a data plane API key

Authorizations

Authorization
string
header
required

A fine-grained data plane API key (values begin with hh_fgdp_). Rooted at an organization, workspace, or project, it carries the permissions chosen when it was created, and only the operations whose paths begin with /v1/projects/{project_id}/ accept it. Create one in the HoneyHive app under the project's, workspace's, or organization's Settings → API Keys, on the Data Plane tab.

Path Parameters

project_id
string
required

The unique identifier of the project the key is rooted at

Body

application/json
name
string
required

A name for the key, shown in the key list.

Required string length: 1 - 256
permissions
string[]
required

The permissions the key carries, such as project.chart.get. Each must be one the key's root scope can carry and one the organization's data plane key policy allows; the key creation screen under the project's Settings → API Keys lists them.

Minimum array length: 1
expires_at
string<date-time>
required

When the key expires, as an ISO 8601 timestamp. It must be in the future and within the maximum key lifetime; a later value is refused with the limit named.

description
string

What the key is for.

Maximum string length: 1024

Response

200 - application/json

Data plane API key created successfully

success
enum<boolean>
required
Available options:
true
data
object
required