---
title: "Updates API key metadata. API key role may only be reduced."
method: PATCH
path: "/api/auth/api-keys/{apiKeyID}"
tags: ["API Keys"]
---

# Updates API key metadata. API key role may only be reduced.

`PATCH /api/auth/api-keys/{apiKeyID}`

## Request

- Base URL: `https://passivelogic.com` (the document declares no server; this is the origin it was published from)
- URL: `https://passivelogic.com/api/auth/api-keys/{apiKeyID}`
- Auth: one of:
  - API key in header `X-PL-AUTH`
  - API key in header `Authorization: PL-API-KEY`
  - API key in header `PL-API-KEY`
  - HTTP basic
- TypeScript: <https://skmtc.dev/passivelogic/apis/passivelogic-http-api/docs/api/auth/api-keys/:apiKeyID/patch.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `apiKeyID` string, required

## Request body

- UpdateApiKeyRequest: Mutable API key metadata. At least one field must be provided.
  - `role` string, nullable: Updated role. Roles may only be reduced. Options are `read` or `readWrite`.
  - `name` string, nullable: Updated label for the API key.

## Response `200`

OK

- ApiKeyResponse: API key metadata. The secret is never included in this representation.
  - `expiration` string, date-time, required: Expiration time.
  - `name` string, nullable: Optional API key label.
  - `role` string, required: Role assigned to the API key. Options are `read` or `readWrite`.
  - `id` string, uuid, required: Unique API key ID.

---

[API](https://skmtc.dev/passivelogic/apis/passivelogic-http-api.md) - [All operations](https://skmtc.dev/passivelogic/apis/passivelogic-http-api/llms.txt) - [OpenAPI document](https://skmtc.dev/passivelogic/apis/passivelogic-http-api/revisions/28fce63bcdbb?raw)