# Update an API key

Source: https://provod.ai/en/docs/keys-update

**`PATCH /v1/keys/{hash}`**

Change a key’s name, access state, expiration or spending limit. Omitted fields keep their current values.

## Authentication

`Authorization: Bearer <MANAGEMENT_API_KEY>`: a management key bound to the workspace. The key owner must retain the live permission `apiKeys.create`.

The credential determines the workspace. `X-Org-Id` is unsupported.

## Path parameters


| Field  | Type              | Description                                                                              |
| ------ | ----------------- | ---------------------------------------------------------------------------------------- |
| `hash` | string · required | SHA-256 digest from data.hash on creation or listing. Not the secret or internal key ID. |


## Request body

`Content-Type: application/json`


| Field                   | Type           | Description                                                                                              |
| ----------------------- | -------------- | -------------------------------------------------------------------------------------------------------- |
| `name`                  | string         | 1–80 characters after trimming. Required on creation; optional on update.                                |
| `limit`                 | number \| null | 0–9999999999.99, up to 8 decimal places. null removes the cap; zero blocks new paid admissions.          |
| `limit_reset`           | string \| null | daily, weekly, monthly, or null (lifetime). Calendar windows use UTC. A non-null reset requires a limit. |
| `disabled`              | boolean        | Default false on creation. true blocks new requests, false re-enables the key.                           |
| `expires_at`            | string \| null | ISO UTC date-time, for example 2030-01-01T00:00:00Z. null removes expiration.                            |
| `workspace_id`          | string         | Optional nonempty assertion of the current workspace; cannot switch workspaces.                          |
| `include_byok_in_limit` | false          | Only false is accepted. BYOK is unavailable.                                                             |


Unknown fields are rejected. On creation, omitted limit means no cap, omitted `limit_reset` means `lifetime`, and omitted `expires_at` means no expiration.

Send at least one field. Keys with multiple cabinet limits must have limit or `limit_reset` changed in the cabinet. New limits include historical spending in the window. Disabling does not cancel accepted requests or their settlement.

## Response · 200


| Field  | Type   | Description |
| ------ | ------ | ----------- |
| `data` | object | Key object. |


Each key includes the [current-key fields](/en/docs/key-current) plus:


| Field                      | Type               | Description                                 |
| -------------------------- | ------------------ | ------------------------------------------- |
| `hash`                     | string             | SHA-256 locator used in the path.           |
| `name`                     | string             | Key name.                                   |
| `disabled`                 | boolean            | Whether new inference requests are blocked. |
| `created_at`               | string (date-time) | Creation timestamp.                         |
| `updated_at, last_used_at` | string \| null     | ISO timestamps or null when unavailable.    |


With multiple limits, limit, `limit_reset` and `limit_remaining` are `null`; read spend\_limits. `is_management_key` is always false.

### Response example

Identifiers and amounts in these examples are illustrative.


**Response JSON**


```json
{
  "data": {
    "label": "sk_example",
    "currency": "RUB",
    "time_zone": "UTC",
    "checked_at": "2026-11-10T12:00:00Z",
    "spend_limits": [],
    "limit": null,
    "limit_reset": null,
    "limit_remaining": null,
    "usage": 0,
    "usage_daily": 0,
    "usage_weekly": 0,
    "usage_monthly": 0,
    "byok_usage": 0,
    "byok_usage_daily": 0,
    "byok_usage_weekly": 0,
    "byok_usage_monthly": 0,
    "include_byok_in_limit": false,
    "is_free_tier": false,
    "is_management_key": false,
    "is_provisioning_key": false,
    "creator_user_id": "user_example",
    "organization_id": null,
    "workspace_id": "workspace_example",
    "expires_at": null,
    "allowed_data_regions": null,
    "free_model_daily_requests": {
      "used": 0,
      "limit": 0,
      "remaining": 0
    },
    "rate_limit": null,
    "hash": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    "name": "Application worker",
    "disabled": true,
    "created_at": "2026-11-10T12:00:00Z",
    "updated_at": "2026-11-10T12:00:00Z",
    "last_used_at": null
  }
}
```



## Request example

Load the key into a server environment variable. TypeScript uses Node.js fetch; Python uses only the standard library.

Replace the example hash with your key’s data.hash.




TypeScript



Python



cURL




```typescript
const response = await fetch("https://api.provod.ai/v1/keys/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.MANAGEMENT_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "disabled": true
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
console.log(await response.json());
```



```python
import json
import os
from urllib.request import Request, urlopen

payload = {
    "disabled": True
}
request = Request(
    "https://api.provod.ai/v1/keys/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
    method="PATCH",
    headers={
        "Authorization": f"Bearer {os.environ['MANAGEMENT_API_KEY']}",
        "Content-Type": "application/json",
    },
    data=json.dumps(payload).encode(),
)
with urlopen(request) as response:
    print(json.load(response))
```



```bash
curl --fail-with-body --silent --show-error -X PATCH \
  "https://api.provod.ai/v1/keys/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" \
  -H "Authorization: Bearer ${MANAGEMENT_API_KEY}" \
  -H "Content-Type: application/json" \
  --data '{
  "disabled": true
}'
```



## Errors


| HTTP  | Error        | Cause                                                                                       |
| ----- | ------------ | ------------------------------------------------------------------------------------------- |
| `401` | Unauthorized | Missing, invalid, disabled, revoked or expired key. The `X-Org-Id` header is also rejected. |
| `403` | Forbidden    | Wrong key kind or insufficient workspace access.                                            |
| `400` | Bad Request  | Invalid or unknown parameters.                                                              |
| `404` | Not Found    | Key not found, revoked or outside the workspace.                                            |


Authentication error example:

```json
{
  "error": {
    "code": "invalid_api_key",
    "message": "Invalid API key",
    "metadata": {}
  }
}
```

Operation error example:

```json
{
  "message": "API key not found",
  "error": "Not Found",
  "statusCode": 404
}
```

## Next steps

* [Management keys](/en/docs/management-keys)
* [Generation charges](/en/docs/generation-metadata)
