Execute command
Executes a command string within the specified scope. The command is parsed and executed using the Brigadier command dispatcher. Permission requirements depend on the scope: - Global scope: Requires GLOBAL_COMMAND_EXECUTION permission - Instance scope: Requires INSTANCE_COMMAND_EXECUTION for the instance - Bot scope: Requires INSTANCE_COMMAND_EXECUTION for the parent instance
Executes a command string within the specified scope. The command is parsed and executed using the Brigadier command dispatcher.
Permission requirements depend on the scope:
- Global scope: Requires GLOBAL_COMMAND_EXECUTION permission
- Instance scope: Requires INSTANCE_COMMAND_EXECUTION for the instance
- Bot scope: Requires INSTANCE_COMMAND_EXECUTION for the parent instance
Preferred API authentication. Use a JWT with the api audience.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Request message for executing a server command.
The execution scope that determines which instances/bots the command can affect and what permissions are required. Must be set to one of the scope options.
The command string to execute. This follows the Brigadier command format, e.g., "help", "move 100 64 200", "say Hello world". Leading/trailing whitespace will be stripped before execution.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/commands:execute" \ -H "Content-Type: application/json" \ -d '{ "command": "" }'{ "code": 0}How is this page?
Update self username PATCH
Updates the username of the currently authenticated user. The change is persisted to the database immediately.
Complete command POST
Retrieves tab-completion suggestions for a partial command. Uses Brigadier's completion system to generate context-aware suggestions based on the command structure and current cursor position. Permission requirements depend on the scope (same as ExecuteCommand).