Update an API key

Replaces a secret key's project permissions, keeping its secret; null gives it full access.

The editor must hold every permission the key has before and after the change. Only a person signed in to the Voidhash dashboard can do this; a secret key, a CLI key or an MCP client cannot.

Guide: API keys

Errors

Status	`type`	`code`	When
400	`invalid_request`	`publishable_key_not_editable`	For a publishable key.

It can also fail with the errors every operation shares, such as unauthenticated; see Errors.

More in API keys

Something wrong or missing on this page? Tell us by email or on Discord.

Path parameters

projectId*string

The project's id, proj_.... A secret key works only in the project it belongs to.

apiKeyId*string

The key's id: api_sk_... for a secret key, api_pk_... for a publishable key.

Request body

application/json

TypeScript definitions

Use the request body type in TypeScript.

scopes?array<>|

The project permissions the key is limited to from now on; null gives it full access. You must hold every permission the key has before and after the change.

Examples

curl -X PATCH "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/api-keys/api_sk_r6t9y2u5i8o1p4a7s0d3f6g9" \  -H "Authorization: Bearer vh_sk_..." \  -H "Content-Type: application/json" \  -d '{    "scopes": [      "project:read",      "project:persons:write",      "project:entitlements:read",      "project:webhooks:read"    ]  }'

{  "id": "api_sk_r6t9y2u5i8o1p4a7s0d3f6g9",  "projectId": "proj_tz4a98xxat96iws9zmbrgj3a",  "name": "Production backend",  "type": "secret",  "environment": "production",  "prefix": "vh_sk_",  "end": "f3Qa",  "rawKey": null,  "scopes": [    "project:read",    "project:persons:write",    "project:entitlements:read",    "project:webhooks:read"  ],  "expiresAt": null,  "lastUsedAt": "2026-03-14T09:26:00.000Z",  "previousKeyExpiresAt": null,  "createdAt": "2026-02-01T08:00:00.000Z"}

{  "error": {    "type": "invalid_request",    "code": "publishable_key_not_editable",    "message": "A publishable key cannot be edited, rotated or deleted: your apps ship with it. Only secret keys can.",    "param": "apiKeyId"  }}

{  "error": {    "type": "unauthenticated",    "code": "invalid_api_key",    "message": "This secret key is not valid."  }}

{  "error": {    "type": "permission_denied",    "code": "permission_denied",    "message": "Insufficient permissions."  }}

{  "error": {    "type": "not_found",    "code": "project_not_found",    "message": "There is no project proj_tz4a98xxat96iws9zmbrgj3a, or this credential cannot use it.",    "param": "projectId"  }}

{  "error": {    "type": "internal",    "code": "internal_error",    "message": "Something went wrong on our side. Try again, and contact support with the Request-Id header if it keeps failing."  }}

Update an API key

Errors

More in API keys

Update an API key

Errors

More in API keys

Authorization

Path parameters

Request body

Examples

Response body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Update an API key

Update an API key

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`