v1

latestOpenAPI 3.1.0MIT2026-07-1799111346.8 KB

Run backend command

Invokes a backend-specific management command against an optional remote.

post/backend/command

Query parameters

commandstring

Backend-specific command to invoke.

fsstring

Remote name or path the backend command should target.

argstring[]

Optional positional arguments for the backend command.

optstring

Backend command options encoded as a JSON string.

_groupstring

Assign the request to a custom stats group.

_asyncboolean

Run the command asynchronously. Returns a job id immediately.

Headers

Prefer'respond-async'

Set to "respond-async" with _async=true to receive HTTP 202 instead of 200.

Request body

commandstring

Backend-specific command to invoke.

fsstring

Remote name or path the backend command should target.

argstring[]

Optional positional arguments for the backend command.

optstring

Backend command options encoded as a JSON string.

_groupstring

Assign the request to a custom stats group.

_asyncboolean

Run the command asynchronously. Returns a job id immediately.

Response

Backend command output and any additional returned fields.

{"stackTrail":"components:responses:BackendCommandResponse:content:application/json:schema:properties:result","oasType":"schema","type":"unknown","description":"Backend command result payload"}