BreezeDocs
Get API key
PATCHhttps://api.breeze.blue/v1/api-keys/{key_id}

Rename an API key

Rename an API key.

Authentication

Browser session: Browser session required. API keys are not accepted on this endpoint.

Headers

FieldTypeDescription
cookierequiredstringAuthenticated browser session cookie (for example breeze_blue_session=...). API keys are not accepted on this endpoint.
content-typerequiredstringapplication/json

Path parameters

FieldTypeDescription
key_idrequiredstringPublic API key identifier returned by GET /v1/api-keys.

Request body

FieldTypeDescription
namerequiredstringUpdated display name for the API key.

Example request

python import os import requests response = requests.patch( "https://api.breeze.blue/v1/api-keys/key_01hprod", headers={ "cookie": "breeze_blue_session=$BREEZE_SESSION" }, json={ "name": "Renamed Production" }, ) response.raise_for_status() print(response.json()) typescript const response = await fetch("https://api.breeze.blue/v1/api-keys/key_01hprod", { method: "PATCH", headers: { cookie: "breeze_blue_session=$BREEZE_SESSION", "content-type": "application/json", }, body: JSON.stringify({ "name": "Renamed Production" }), }); if (!response.ok) { throw new Error("Request failed: " + response.status); } console.log(await response.json()); curl curl -X PATCH "https://api.breeze.blue/v1/api-keys/key_01hprod" \ -H "cookie: breeze_blue_session=$BREEZE_SESSION" \ -H "content-type: application/json" \ --data '{ "name": "Renamed Production" }'
import os
import requests

response = requests.patch(
    "https://api.breeze.blue/v1/api-keys/key_01hprod",
    headers={ "cookie": "breeze_blue_session=$BREEZE_SESSION" },
    json={
        "name": "Renamed Production"
    },
)
response.raise_for_status()

print(response.json())

Response

Updated API key.

Content types: application/json

{
  "key_id": "key_01hprod",
  "name": "Example",
  "status": "active",
  "api_key": "string",
  "prefix": "string",
  "created_at": "2026-04-02T10:15:30Z",
  "last_used_at": "string",
  "disabled_at": "string",
  "expires_at": "string",
  "rotated_from_key_id": "rotated_from_key_id_01h",
  "rotated_at": "string"
}