Add key permissions

Add permissions to a key without affecting existing permissions.

Use this for privilege upgrades, enabling new features, or plan changes that grant additional capabilities. Permissions granted through roles remain unchanged.

Important: Changes take effect immediately with up to 30-second edge propagation.

Required Permissions

Your root key must have one of the following permissions:

api.*.update_key (to update keys in any API)
api.<api_id>.update_key (to update keys in a specific API)

Side Effects

Invalidates the key cache for immediate effect, and makes permissions available for verification within 30 seconds across all regions.

1 min read

post/v2/keys.addPermissions

Request example

package main

import(
	"context"
	"os"
	unkey "github.com/unkeyed/sdks/api/go/v2"
	"github.com/unkeyed/sdks/api/go/v2/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := unkey.New(
        unkey.WithSecurity(os.Getenv("UNKEY_ROOT_KEY")),
    )

    res, err := s.Keys.AddPermissions(ctx, components.V2KeysAddPermissionsRequestBody{
        KeyID: "key_2cGKbMxRyIzhCxo1Idjz8q",
        Permissions: []string{
            "<value 1>",
        },
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.V2KeysAddPermissionsResponseBody != nil {
        // handle response
    }
}

Response

{
  "meta": {
    "requestId": "req_123"
  },
  "data": [
    {
      "id": "perm_1234567890abcdef",
      "name": "users.read",
      "slug": "users-read",
      "description": "Allows reading user profile information and account details"
    }
  ]
}

post/v2/keys.addPermissions

Authorization

Authorizationstringheaderrequired#

Unkey uses bearer tokens for authentication. Public integrations use root keys, while the dashboard proxy uses short-lived JWTs.
To authenticate, include the token in the Authorization header of each request:

Authorization: Bearer unkey_123

Root keys have specific permissions attached to them, controlling what operations they can perform. Legacy permissions use tuple strings like api.*.create_key; resource permissions use Unkey Resource Names plus actions, like unkey:v1:ws_123:keyspaces/*#create_key.
Security best practices:

Keep root keys secure and never expose them in client-side code
Use different root keys for different environments
Rotate keys periodically, especially after team member departures
Create keys with minimal necessary permissions following least privilege principle
Monitor key usage with audit logs.

Body

application/json

keyIdstringrequired#

Specifies which key receives the additional permissions using the database identifier returned from keys.createKey.
Do not confuse this with the actual API key string that users include in requests.

Length: 3–255Pattern: ^[a-zA-Z0-9_]+$

permissionsstring[]required#

Grants additional permissions to the key through direct assignment or automatic creation.
Duplicate permissions are ignored automatically, making this operation idempotent.

Adding permissions never removes existing permissions or role-based permissions.

Any permissions that do not exist will be auto created if the root key has permissions, otherwise this operation will fail with a 403 error.

Items: 1–1000

Responses

application/json

Permissions added successfully. Returns all permissions currently assigned to the key.

metaobjectrequired#

Metadata object included in every API response. This provides context about the request and is essential for debugging, audit trails, and support inquiries. The requestId is particularly important when troubleshooting issues with the Unkey support team.

Show child attributes

requestIdstringrequired#

A unique id for this request. Always include this ID when contacting support about a specific API request. This identifier allows Unkey's support team to trace the exact request through logs and diagnostic systems to provide faster assistance.

dataobject[]required#

Complete list of all permissions directly assigned to the key (including both newly added permissions and those that were already assigned).

This response includes:

All direct permissions assigned to the key (both pre-existing and newly added)
Both the permission ID and name for each permission

Important notes:

This list does NOT include permissions granted through roles
For a complete permission picture, use /v2/keys.getKey instead
An empty array indicates the key has no direct permissions assigned

Show child attributes

idstringrequired#

The unique identifier for this permission within Unkey's system.
Generated automatically when the permission is created and used to reference this permission in API operations.
Always begins with 'perm_' followed by alphanumeric characters and underscores.

Length: 3–255Pattern: ^[a-zA-Z0-9_]+$

namestringrequired#

The human-readable name for this permission that describes its purpose.
Should be descriptive enough for developers to understand what access it grants.
Use clear, semantic names that reflect the resources or actions being permitted.
Names must be unique within your workspace to avoid confusion and conflicts.

Length: 1–512

slugstringrequired#

The unique URL-safe identifier for this permission.

Length: 1–512Pattern: ^[a-zA-Z0-9_:\-\.\*]+$

descriptionstring#

Optional detailed explanation of what this permission grants access to.
Helps team members understand the scope and implications of granting this permission.
Include information about what resources can be accessed and what actions can be performed.
Not visible to end users - this is for internal documentation and team clarity.

Length: max 512

metaobjectrequired#

Show child attributes

requestIdstringrequired#

errorobjectrequired#

Base error structure following Problem Details for HTTP APIs (RFC 7807). This provides a standardized way to carry machine-readable details of errors in HTTP response content.

Show child attributes

detailstringrequired#

A human-readable explanation specific to this occurrence of the problem. This provides detailed information about what went wrong and potential remediation steps. The message is intended to be helpful for developers troubleshooting the issue.

statusintegerrequired#

HTTP status code that corresponds to this error. This will match the status code in the HTTP response. Common codes include 400 (Bad Request), 401 (Unauthorized), 403 (Forbidden), 404 (Not Found), 409 (Conflict), and 500 (Internal Server Error).

titlestringrequired#

A short, human-readable summary of the problem type. This remains constant from occurrence to occurrence of the same problem and should be used for programmatic handling.

typestringrequired#

A URI reference that identifies the problem type. This provides a stable identifier for the error that can be used for documentation lookups and programmatic error handling. When followed, this URI should provide human-readable documentation for the problem type.

errorsobject[]required#

List of individual validation errors that occurred in the request. Each error provides specific details about what failed validation, where the error occurred in the request, and suggestions for fixing it. This granular information helps developers quickly identify and resolve multiple issues in a single request without having to make repeated API calls.

Show child attributes

locationstringrequired#

JSON path indicating exactly where in the request the error occurred. This helps pinpoint the problematic field or parameter. Examples include:

'body.name' (field in request body)
'body.items[3].tags' (nested array element)
'path.apiId' (path parameter)
'query.limit' (query parameter)
Use this location to identify exactly which part of your request needs correction.

messagestringrequired#

Detailed error message explaining what validation rule was violated. This provides specific information about why the field or parameter was rejected, such as format errors, invalid values, or constraint violations.

fixstring#

A human-readable suggestion describing how to fix the error. This provides practical guidance on what changes would satisfy the validation requirements. Not all validation errors include fix suggestions, but when present, they offer specific remediation advice.

Update Identity Add key roles