---
title: "Update Api Key"
method: PATCH
path: "/v1/api-keys/{api_key_id}"
tags: ["api-keys"]
---

# Update Api Key

`PATCH /v1/api-keys/{api_key_id}`

## Request

- Base URL: `https://api.mentium.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.mentium.io/v1/api-keys/{api_key_id}`
- Auth: HTTP bearer

Update an API key's metadata.

## Path parameters

- `api_key_id` string, uuid, required

## Headers

- `mentium-workspace-id` string, nullable

## Request body

- ApiKeyUpdateRequest: Request schema for updating an API key.
  - `name` string, nullable
  - `description` string, nullable
  - `scopes` string[], nullable
  - `rate_limit_per_minute` integer, nullable
  - `rate_limit_per_day` integer, nullable

## Response `200`

Successful Response

- ApiKeyResponse: Response schema for an API key (without the actual key value).
  - `id` string, uuid, required
  - `name` string, required
  - `key_prefix` string, required
  - `status` 'ACTIVE' | 'REVOKED' | 'EXPIRED', required
  - `scopes` string[], required
  - `description` string, nullable, required
  - `rate_limit_per_minute` integer, required
  - `rate_limit_per_day` integer, required
  - `last_used_at` string, date-time, nullable, required
  - `usage_count` integer, required
  - `expires_at` string, date-time, nullable, required
  - `revoked_at` string, date-time, nullable, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required
  - `integration_connection_id` string, uuid, nullable, required
  - `created_by_user_id` string, uuid, required
  - `created_by_name` string, nullable
  - `integration_connection_name` string, nullable

## Other responses

- `404`: Not found
- `422`: Validation Error

---

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