API Keys

Update an API key

Changed on

Updates an API key's metadata (currently only the label).

patch/v1/api-keys/{label}

Request

  • Base URL: https://api.monid.ai
  • URL: https://api.monid.ai/v1/api-keys/{label}
  • Auth: HTTP bearer

Path parameters

labelstring required

Current label of the API key.

Example:ci-runner

Headers

X-Monid-Agent-Modelstring

Model driving the calling agent. Optional; a value that is empty, longer than 256 characters or not printable ASCII is ignored (never an error).

X-Monid-Agent-Harnessstring

Agent harness or client making the call (e.g. a coding agent, an agent framework). Optional; a value that is empty, longer than 256 characters or not printable ASCII is ignored (never an error).

X-Monid-Agent-Session-Idstring

Caller-side session identifier, so the calls of one agent session (discover → inspect → run → polling) can be correlated. Optional; a value that is empty, longer than 256 characters or not printable ASCII is ignored (never an error).

Request body

labelstring

New label for the key.

Example request

{
  "label": "ci-runner-renamed"
}

Response

Updated API key metadata (never the full key)

labelstring required

Human-readable label. Unique per workspace.

keyPrefixstring required

Display prefix of the key (e.g. "monid_test_a1b2c3d4...").

ownerstring required

User id the key belongs to (bills to, listed under). Always a user; a child key inherits its parent's owner.

createdBystring required

Who minted the key — USER#<id> (dashboard), API_KEY#<fingerprint> (another key), AEP#<did> (AEP grant) — an actor id: USER#<userId> (dashboard), API_KEY#<fingerprint> (another key), AEP#<did> (an enrolled agent), CLERK, SYSTEM.

scopesstring[] required

Scope grants: {resource}:{action} over runs, resources, wallet, topups, controls and api_keys with read/create/update/delete, plus {resource}:* and *. Catalog reads need no scope. Fixed at creation.

status'ACTIVE' | 'EXPIRED' | 'REVOKED' required

ACTIVE, EXPIRED (derived from expiresAt) or REVOKED. Only ACTIVE keys authenticate.

origin'DASHBOARD' | 'API' | 'AEP' | 'SYSTEM' required

Channel the key was minted through — derived from createdBy: DASHBOARD, API, AEP or SYSTEM.

expiresAtstring date-time

Expiry (ISO 8601). Absent ⇒ never expires.

revokedAtstring date-time

When the key was revoked. Present only when REVOKED.

revokedBystring

Who revoked the key (present only when REVOKED) — an actor id: USER#<userId> (dashboard), API_KEY#<fingerprint> (another key), AEP#<did> (an enrolled agent), CLERK, SYSTEM.

createdAtstring date-time required

Creation time (ISO 8601).

lastUsedAtstring date-time

Last time the key authenticated a request. Absent if never used.

Example response

{
  "label": "ci-runner",
  "keyPrefix": "monid_test_a1b2c3d4",
  "createdBy": "USER#user_2abc",
  "scopes": [
    "runs:create",
    "runs:read",
    "wallet:read"
  ],
  "revokedBy": "USER#user_2abc"
}

Changes

  • 631143e91790Revision changes
    • info

      added the new optional header request parameter X-Monid-Agent-Harness

    • info

      added the new optional header request parameter X-Monid-Agent-Model

    • info

      added the new optional header request parameter X-Monid-Agent-Session-Id

    • info

      removed the PROMO_REDEEM_DISABLED enum value from the response property for the response status

    • info

      removed the PROMO_REDEEM_DISABLED enum value from the response property for the response status

    • info

      removed the PROMO_REDEEM_DISABLED enum value from the response property for the response status

    • info

      removed the PROMO_REDEEM_DISABLED enum value from the response property for the response status

    • info

      removed the PROMO_REDEEM_DISABLED enum value from the response property for the response status

    • info

      removed the PROMO_REDEEM_DISABLED enum value from the response property for the response status

  • b944bb23906cRevision changes
    • warning

      added the new PROMO_REDEEM_DISABLED enum value to the response property for the response status

    • warning

      added the new PROMO_REDEEM_DISABLED enum value to the response property for the response status

    • warning

      added the new PROMO_REDEEM_DISABLED enum value to the response property for the response status

    • warning

      added the new PROMO_REDEEM_DISABLED enum value to the response property for the response status

    • warning

      added the new PROMO_REDEEM_DISABLED enum value to the response property for the response status

    • warning

      added the new RATE_LIMITED enum value to the response property for the response status

    • warning

      added the new RATE_LIMITED enum value to the response property for the response status

    • warning

      added the new RATE_LIMITED enum value to the response property for the response status

    • warning

      added the new RATE_LIMITED enum value to the response property for the response status

    • warning

      added the new RATE_LIMITED enum value to the response property for the response status

    • info

      added the non-success response with the status