Start a Container

Creates a job that starts the specified container.

Requires the containers-state permission.

Arguments
  • action
    string

    Set to start to start the container.

Returns

Returns a Task Descriptor Object, otherwise returns an Error.

POST /v1/containers/{ID}/tasks

Example Request
$ curl https://api.cycle.io/v1/containers/5b9c2a77b6393d0001eb45fd/tasks \
  -H 
"Authorization: Bearer API_KEY"
 \
  -H 
"X-Hub-Id: HUB_ID"
 \
  -H 'Content-Type: application/json' \
  -d '{"action":"start"}' \
  -X POST
Example Response
{
  "data": {
    "action": "start",
    "job_id": "5d01b9b3db2ab00001508cd8"
  }
}