Skip to content

List the commands a key can run

List customer management commands or read a named command's full definition. The response shows which commands this credential can grant to an API key.

Parameters

#
commandstring
Command to describe, such as pool create. Omit to list commands.
fullboolean
Include full definitions in the list. False returns names, summaries, routes and field names. Defaults to true. MCP defaults to false. A named command always gets its full definition.

Returns

#
dataobjectAlways present
Available commands and their inputs.
Show 1 attributeHide attributes
commandsobject[] | nullAlways present
Commands with their routes and fields. Full results also include terminal syntax and permission metadata.
Show 1 attributeHide attributes
itemsobject
A command's inputs, route and credential requirements.
Show 18 attributesHide attributes
aliasesstring[]
Alternative terminal command names. May be omitted.
annotationsmap<string, JSON value>
Tool behavior hints. May be omitted.
chargesstring
How the command can spend money. May be omitted.
confirmboolean
Whether terminal use previews the change unless confirmed. May be omitted.
confirm_lossesboolean
Whether only changes causing loss require terminal confirmation. May be omitted.
confirm_unlessstring[]
Inputs exempting a terminal invocation from confirmation. May be omitted.
descriptionstring
Command's full help text. May be omitted.
field_helpobject[]
Descriptions of the command's fields. May be omitted.
Show 1 attributeHide attributes
itemsobject
Help for one command input.
Show 2 attributesHide attributes
fieldstringAlways present
Input name.
helpstringAlways present
Input's meaning and applicable conditions.
fieldsstring[] | nullAlways present
API field names accepted by the command.
flagsobject[]
Flags in terminal syntax. May be omitted.
Show 1 attributeHide attributes
itemsobject
A command input.
Show 17 attributesHide attributes
apistringAlways present
Corresponding API field name.
helpstring
Input's meaning and usage conditions. May be omitted.
maximuminteger
Largest accepted numeric value. May be omitted.
minimuminteger
Smallest accepted numeric value. May be omitted.
namestringAlways present
Terminal input name.
objectstring[]
Nested object members accepted by structured requests. May be omitted.
one_ofboolean
Whether structured requests require exactly one declared member. May be omitted.
optionalboolean
Whether this input can be omitted in terminal syntax. May be omitted.
repeatedboolean
Whether terminal syntax accepts repeated values. May be omitted.
restboolean
Whether this positional consumes the remaining words. May be omitted.
sensitiveboolean
Whether the value contains a secret. May be omitted.
stdinboolean
Whether terminal input can be read from standard input. May be omitted.
text_onlyboolean
Whether the input applies only to terminal syntax. May be omitted.
tool_defaultJSON value
Default applied specifically by the tool interface. May be omitted.
typestringAlways present
Input value's declared kind.
valuesstring[]
Accepted fixed values. May be omitted.
withinstring
Enclosing structured field. May be omitted.
grantablebooleanAlways present
Whether you can create a key permitting this command.
namestringAlways present
Command's catalog name.
positionalsobject[]
Positional arguments in terminal syntax. May be omitted.
Show 1 attributeHide attributes
itemsobject
A command input.
Show 17 attributesHide attributes
apistringAlways present
Corresponding API field name.
helpstring
Input's meaning and usage conditions. May be omitted.
maximuminteger
Largest accepted numeric value. May be omitted.
minimuminteger
Smallest accepted numeric value. May be omitted.
namestringAlways present
Terminal input name.
objectstring[]
Nested object members accepted by structured requests. May be omitted.
one_ofboolean
Whether structured requests require exactly one declared member. May be omitted.
optionalboolean
Whether this input can be omitted in terminal syntax. May be omitted.
repeatedboolean
Whether terminal syntax accepts repeated values. May be omitted.
restboolean
Whether this positional consumes the remaining words. May be omitted.
sensitiveboolean
Whether the value contains a secret. May be omitted.
stdinboolean
Whether terminal input can be read from standard input. May be omitted.
text_onlyboolean
Whether the input applies only to terminal syntax. May be omitted.
tool_defaultJSON value
Default applied specifically by the tool interface. May be omitted.
typestringAlways present
Input value's declared kind.
valuesstring[]
Accepted fixed values. May be omitted.
withinstring
Enclosing structured field. May be omitted.
restrictedbooleanAlways present
True if an API key limited to a command list cannot run this command.
retrystring
Retry behavior: read, request-id for changes identified across retries, or reconcile for settings that can be read and reapplied. May be omitted.
routeobject
HTTP method, path and selector for this command. May be omitted.
Show 4 attributesHide attributes
actionstring
Action selector for a shared modify endpoint. May be omitted.
methodstringAlways present
HTTP method to use.
pathstringAlways present
Endpoint path.
viewstring
View selector for a shared read endpoint. May be omitted.
summaryobjectAlways present
Short description used in command listings.
Show 2 attributesHide attributes
commandstringAlways present
Command name.
summarystringAlways present
What the command does.
usagestring
Terminal invocation pattern. May be omitted.

Errors

#
CodeStatusWhat happened
invalid400An input is missing or invalid.
unauthenticated401The credential is missing, invalid, expired or revoked.
denied403The caller lacks permission for this action.
not_found404The resource is absent or inaccessible to this caller.
conflict409The request conflicts with the current resource state or an earlier request.
over_capacity409The request exceeds a resource or credential allowance.
access_list_full409The change would exceed the access-list allowance.
rate_limited429The caller's request rate exceeds its limit.
busy429Too much work is in progress to accept this request.
unknown503The outcome is unconfirmed; a change may have happened.
unavailable503The service or requested feature is unavailable.

Notes

#
  • Accepts any API key.