Remove Instances - Batch

Remove more than one instance of a container, if that container employs the manual deployment strategy.

To control instance counts on containers employing alternate deployment strategies, please use scale .

Requires the containers-update permission.

query
  • include

    Accepted Values: creatorserverslocationsproviderscontainersenvironments

Returns

Returns a Task Descriptor Object, otherwise returns an Error.

POST /v1/containers/5b9c2a77b6393d0001eb45fd/instances

Example Request
$ curl https://api.cycle.io/v1/containers/5b9c2a77b6393d0001eb45fd/instances \
-H
"Authorization: Bearer API_KEY"
\
-H
"X-Hub-Id: HUB_ID"
-H 'Content-Type: application/json' \
-d '{"instances_ids":["5f733344dc38060001c6683d","5f733325dc38060001c6d94e","5f7def233338060001c6d94f"]}' \
-X POST
Example Response
{
"data": {
"action": "container.instance.delete",
"job_id": "5d01b9b3db2ab00001508cd8"
}
}