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
limitnumbernoMaximum number of results to return
offsetnumbernoNumber of results to skip

create-api-key

Create an API key

Arguments

ArgumentTypeRequiredDescription
namestringyesKey name for identification
projectIdstringnoOptional project ID to scope the key to. Omit or set null to create an unscoped key that spans projects.
policyIdsarray<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
apiKeyIdstringyesAPI key public ID (key_ prefix)

update-api-key

Update an API key

Arguments

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

delete-api-key

Delete an API key

Arguments

ArgumentTypeRequiredDescription
apiKeyIdstringyesAPI key public ID (key_ prefix)