Skip to main content

API Keys

MCP tools for the API Keys module. See the API Keys module docs for permissions and data model.

list-api-keys​

List API keys

Arguments​

ArgumentTypeRequiredDescription
limitnumbernoResults per page. Above the maximum it is clamped; below 1 or not an integer it is 400 VALIDATION_FAILED.
cursorstringnoThe previous page's next_cursor; omit it for the first page. Send it with the same filters as the request that returned it: a malformed cursor, or one sent with other filters, is 400 INVALID_CURSOR.

create-api-key​

Create an API key

Arguments​

ArgumentTypeRequiredDescription
namestringyesKey name for identification
project_idstring | nullnoOptional project ID to scope the key to. Omit or set null to create an unscoped key that spans projects.
policy_idsarray<string>noOptional list of policy IDs to attach. Key permissions become the intersection of user policies and these policies.

get-api-key​

Get an API key

Arguments​

ArgumentTypeRequiredDescription
api_key_idstringyesAPI key public ID (key_ prefix)

update-api-key​

Update an API key

Arguments​

ArgumentTypeRequiredDescription
api_key_idstringyesAPI key public ID (key_ prefix)
namestringno—
project_idstring | nullnoRe-scope the key to a different project, or set null to clear the scope (unscoped key). Omit to leave the scope unchanged.
policy_idsarray<string>noReplace the key's policy list (empty array removes all)

delete-api-key​

Delete an API key

Arguments​

ArgumentTypeRequiredDescription
api_key_idstringyesAPI key public ID (key_ prefix)