The docker-compose command is used to up, down, start, stop a Docker Compose file on an instance.

JSON Input Data Format
{
    "id": string,
    "composefile": string,
    "action": string
}
id * Specifies the ID of the instance where the Docker Compose will be executed.
composefile * Specifies the path and filename of the Docker Compose file. Please note that the path must start with /, indicating the root of the instance.
action * Specifies the compose action to be executed, which can be one of the following:
  • up
    Is used for deploying and starting the solution.
  • down
    Is used for stopping and removing the solution.
  • start
    Is used for starting the solution.
  • stop
    Is used for stopping the solution.
* Indicates a mandatory field.

Code Snippets
Here are several code snippets provided for your direct use. Simply select your preferred tool/language by clicking on it.


Successful Response
{
    "result": "OK",
    "payload": "...the outpur of the command..."
}

Failed Response
{
    "result": "ERR",
    "message": "Error message ..."
}