BYbymason
Command APIs

Modify Command State

This API endpoint allows for the modification of the state of a command identified by its unique command ID. It initiates a state change based on the provided 'newstate' parameter.

post/rest/manager/command/changestate/{commandId}

Request

  • Base URL
    https://masonconsole.com
  • Auth
    HTTP bearer

Path parameters

commandIdstring required

The unique identifier of the command.

Query parameters

newstate'COMMAND_STATE_ACTIVE' | 'COMMAND_STATE_STOPPED' required

The new state to set for the command.

Example:COMMAND_STATE_ACTIVE

Request body

newstatestring

The new state of thee command

Example request

{
  "newstate": "COMMAND_STATE_ACTIVE"
}

Response

Successful response

dataobject
resultstring
messagestring
@classstring required

Changes

No recorded changes to this operation across all 1 revision of this API.