Create an API key

POST

/keys

const url = 'https://example.com/api/keys';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"default"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "default" }'

Creates a new API key. The full plaintext key is returned only once in the response.

Authorizations

bearerApiKey
cookieAuth

Request Body

application/json

object

name

Friendly name for the key

string

default: default

Example

my-ci-key

Responses

200

Newly created key (plaintext returned only once)

application/json

object

required

string format: uuid

key

required

Full plaintext API key (only returned on creation)

string

Example

ah_k_abc123def456

prefix

required

string

Example

ah_k_abc1

name

required

string

Example

my-ci-key

401

Not authenticated

application/json

object

error

required

Human-readable error message

string

code

Stable machine-readable error code for client branching

string

fieldErrors

First validation message per field path

object

key

additional properties

string

issues

Structured validation issues (Zod)

Array<object>

object

path

required

string

message

required

string

retryAfter

Seconds until rate limit resets (429 responses)

number

reconnect

True if re-linking GitHub may fix the issue

boolean

500

Server error

application/json

object

error

required

Human-readable error message

string

code

Stable machine-readable error code for client branching

string

fieldErrors

First validation message per field path

object

key

additional properties

string

issues

Structured validation issues (Zod)

Array<object>

object

path

required

string

message

required

string

retryAfter

Seconds until rate limit resets (429 responses)

number