Skip to content

PATCH   /apikeys/{id}/permissions

Update API key permissions

Updates the permissions assigned to an API key. Only account administrators can update API key permissions, and API keys cannot update permissions.

Authentication Required

Authorization: Bearer {token}   header string

This header is required to access this endpoint

Required Parameters

id   path string

The ID of the API key to update permissions for

Optional Parameters

Click here to view an exhaustive list of all available parameters
x-account-id   header string

The account ID for the request

Request Body

{
"flatPermissionsList": [
"string"
]
}

Try it out

Loading...

Output:

Responses

Description

API key permissions updated successfully

{
"message": "ApiKey permissions updated"
}

References

#/components/parameters/xAccountIdHeader

in: header
name: x-account-id
schema:
type: string
description: The account ID for the request
required: false

Route Source Code

Check out the source code for this route entrypoint here: /apikeys/[id]/permissions/route.ts

Or the swagger.yaml spec this documentation was generated from: /apikeys/swagger.yaml