Create an API key · BeaconBox docs

Request

curl -X POST https://api.beaconbox.eu/api/v1/keys \
  -H "Authorization: Bearer $BEACONBOX_API_KEY" \
  -H "Content-Type: application/json"
  -d '{}'

curl -X POST https://api.beaconbox.eu/api/v1/keys \
  -H "Authorization: Bearer $BEACONBOX_API_KEY" \
  -H "Content-Type: application/json"
  -d '{}'

client.keys.create("orders service")

client.keys.create("orders service")

$client->keys->create("orders service")

$client->keys->create("orders service")

Body

Field	Type	Description
`name` optional	`string \| null`
`detach` optional	`boolean`	Create the key with no parent, so revoking the key that created it leaves this one working. Use it to rotate: create a detached key, move your systems to it, then revoke the old key. Without it, the new key is revoked along with the key that created it.

Response

Returns 201.

Field	Type	Description
`id`	`string`
`name`	`string`
`key`	`string`
`masked`	`string`
`created`	`date-time`

Errors

Failures are { "error_code": "..." } with a stable dotted code. See Errors for the codes worth branching on and the three outcomes that look like failures and are not.