Skip to content
HalvorAI mark HalvorAI mark HalvorAI

Create an API key

POST
/v1/api-keys

Signed-in users only. The full key is returned once and never stored.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
object
name
required
string
>= 1 characters <= 100 characters
env
required
string
Allowed values: test live
scopes
Array<string>
default: events:write >= 1 items
Allowed values: events:write events:read agents:read alerts:read alerts:write cases:read cases:write packs:write screening:write

Responses

Section titled “ Responses ”

201

Section titled “201 ”

The new key, shown once

object
id
required
string
name
required
string
env
required
string
Allowed values: test live
scopes
required
Array<string>
prefix
required

First 12 characters, to recognise the key.

string
created_at
required
string
last_used_at
required
string | null
revoked_at
required
string | null
created_by
required
string | null
key
required
string

400

Section titled “400 ”

The request is not valid

object
error
required
object
code
required
string
Example
invalid_request
message
required
string
details
Array
request_id
required
string
Example
req_01J9ZK6V3S4Q8Y2M7N5P0R1T2W

401

Section titled “401 ”

Not signed in, or the API key is not valid

object
error
required
object
code
required
string
Example
invalid_request
message
required
string
details
Array
request_id
required
string
Example
req_01J9ZK6V3S4Q8Y2M7N5P0R1T2W

403

Section titled “403 ”

Not allowed for this role or key

object
error
required
object
code
required
string
Example
invalid_request
message
required
string
details
Array
request_id
required
string
Example
req_01J9ZK6V3S4Q8Y2M7N5P0R1T2W