Roll an API key

POST

/v1/keys/{id}/roll

const url = 'http://127.0.0.1:8080/v1/keys/example/roll';
const options = {
  method: 'POST',
  headers: {
    'Deedglass-Version': '2026-10-01',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: '{"expires_in":86400}'
};

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

curl --request POST \
  --url http://127.0.0.1:8080/v1/keys/example/roll \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Deedglass-Version: 2026-10-01' \
  --data '{ "expires_in": 86400 }'

Creates a new key with the same agent, name, mode and scopes; its secret is shown once, and previous says when the old key stops working (expires_in seconds from now, 0–604800, default 86400). Rolling a revoked or expired key is 409 conflict. Admin keys can’t roll admin keys (403 insufficient_role), because that creates one. Replaying the same Idempotency-Key returns "secret": null. Seals api_key.rolled. An admin+ Console session (with the Deedglass-CSRF header) or an org admin key; agent keys get 403 insufficient_scope.

Authorizations

bearerAuth
sessionCookie

Parameters

Path Parameters

required

string

The API key id (key_…).

Header Parameters

Deedglass-Version

string

/^[0-9]{4}-[0-9]{2}-[0-9]{2}$/

The API version (YYYY-MM-DD). Leave it out to use your org’s pinned version (public routes use the latest). An unknown version is 400 api_version_invalid.

Deedglass-CSRF

string

Needed when the request uses a Console session (it changes state); without it the answer is 403 csrf_failed. Not sent with an API key.

Idempotency-Key

string

>= 1 characters <= 255 characters

1 to 255 printable ASCII characters. A retry with the same key and body returns the stored response with Deedglass-Idempotent-Replayed: true for 24 hours.

Request Body

application/json

object

expires_in

Seconds the old key keeps working.

integer

default: 86400 <= 604800

Example

{
  "expires_in": 86400
}

Responses

201

The new key, with its secret and the old key’s expiry.

application/json

object

object

required

string

Allowed value: api_key

required

string

/^key_[0-7][0-9a-hjkmnp-tv-z]{25}$/

agent

required

The agent (agt_…); null for an org admin key.

string | null

name

required

string

<= 64 characters

mode

required

string

Allowed values: live test

prefix

required

How the key is displayed: dg_live_jJbEEMWk_••••.

string

/^dg_(live|test)_[0-9A-Za-z]{8}$/

scopes

required

Array<string>

Allowed values: actions:execute actions:read deeds:read actions:undo admin

expires_at

required

Set when the key was rolled.

string | null format: date-time

last_used_at

required

string | null format: date-time

revoked_at

required

string | null format: date-time

rolled_from

required

The key this one replaced (key_…).

string | null

created_at

required

string format: date-time

secret

The full key, on create and roll only, shown once. Null in an Idempotency-Key replay: Deedglass never stores it.

string | null

/^dg_(live|test)_[0-9A-Za-z]{8}_[0-9A-Za-z]{32}$/

deed

required

The admin deed this change sealed; null when nothing changed.

string | null

previous

On roll only. The old key and when it stops working.

object

required

string

expires_at

required

string | null format: date-time

Example

{
  "object": "api_key",
  "id": "key_01k6jt6tgx72gjr876976xak5e",
  "agent": "agt_01k633rrmh3bcz2p39gg4vp46q",
  "name": "prod runner",
  "mode": "live",
  "prefix": "dg_live_0IDw6L5O",
  "scopes": [
    "actions:execute",
    "actions:read",
    "deeds:read"
  ],
  "secret": "dg_live_0IDw6L5O_9hxevwY7nqdKIZZi5A2xlI2O2qn8znik",
  "expires_at": null,
  "last_used_at": null,
  "revoked_at": null,
  "rolled_from": "key_01k6jz12ptrvg2zn5vts5xc1ay",
  "created_at": "2026-10-03T10:03:40.000Z",
  "deed": "deed_01k6vrddq2atgb2023qvhhct3g",
  "previous": {
    "id": "key_01k6jz12ptrvg2zn5vts5xc1ay",
    "expires_at": "2026-10-04T10:03:40.000Z"
  }
}

Headers

Deedglass-Request-Id

string

/^req_[0-7][0-9a-hjkmnp-tv-z]{25}$/

This request’s id. Quote it to support; it matches error.request_id.

Deedglass-Idempotent-Replayed

string

Allowed values: true

Present, and true, when the response is a stored one replayed for an Idempotency-Key.

default

An error. Every error has this envelope; doc_url explains the code.

application/json

object

error

required

object

type

required

string

Allowed values: invalid_request_error authentication_error permission_error policy_error rate_limit_error api_error

code

required

string

Allowed values: invalid_api_key api_key_revoked api_key_expired agent_suspended agent_stopped org_stopped insufficient_scope policy_denied approval_required approval_expired budget_exceeded intent_required intent_invalid intent_replay tool_unknown connector_unavailable upstream_error timeout rate_limited idempotency_conflict validation_failed not_found conflict internal_error authentication_required method_not_allowed request_too_large unsupported_media_type invalid_json api_version_invalid idempotency_key_invalid idempotency_key_in_use service_unavailable session_expired csrf_failed insufficient_role login_link_invalid login_code_invalid last_owner policy_unavailable policy_invalid credentials_missing destination_blocked vault_unavailable upstream_auth_failed upstream_not_found upstream_rate_limited response_too_large statement_refused row_limit_exceeded database_role_unsafe database_not_ready witness_not_configured approval_decided already_countersigned approver_not_eligible self_approval approval_needs_person context_changed approval_unsatisfiable approval_link_invalid approval_link_review_only approver_unmapped stripe_live_key_refused stripe_livemode_detected upstream_approval_pending schedule_needs_approval action_executing from_denied undo_unavailable undo_plan_stale already_undone undo_conflict replay_too_large replay_window_invalid suggestion_stale shadow_slot_taken suggestion_decided observe_not_enabled pro_required

message

required

One or more calm sentences with the next step.

string

param

required

The request field, query parameter or header the error is about.

string | null

request_id

required

string

/^req_[0-7][0-9a-hjkmnp-tv-z]{25}$/

doc_url

required

string format: uri

diagnostics

On policy_invalid only. Each problem with its line, code and hint.

Array<object>

One finding about a policy file, with its position and the next step. Codes are stable and listed in docs/POLICY_ERRORS.md. In the policy_invalid error envelope each diagnostic also carries object: policy_diagnostic. The full PolicyDiagnostic schema is in openapi.yaml.

object

action

One agent action. Its sections mirror the deed’s. status is the one field an agent needs; state is the exact lifecycle state (docs/GATE.md). The Gate’s own responses (POST /v1/actions and its result report) add execution.result and witness.reasons; lists leave both out. The full Action schema is in openapi.yaml.

object

checks

On undo_unavailable only. Every check of the undo, each with its fix. Additive (S23).

Array<object>

One of the twelve safety checks (S23 §3.3). Available means no check failed. The full UndoCheck schema is in openapi.yaml.

object

Example

{
  "error": {
    "type": "invalid_request_error",
    "code": "not_found",
    "message": "There's no endpoint at GET /v1/helth. Did you mean /v1/health?",
    "param": null,
    "request_id": "req_01j9zr3m5k8q2w7x4t6v0b1c9d",
    "doc_url": "https://docs.deedglass.com/errors/not_found"
  }
}

Headers

Deedglass-Request-Id

string

/^req_[0-7][0-9a-hjkmnp-tv-z]{25}$/

This request’s id. Quote it to support; it matches error.request_id.

Deedglass-Version

string

The API version this response follows.