v1

Container Groups

Stop and delete all container instances in a container group.

Stops and deletes the container instances that run in a container group (corresponding IBM Containers command: cf ic group rm <group_name>). When you delete a container group, all floating private IP addresses are released.

delete/containers/groups/{name_or_id}

Path parameters

name_or_idstring required

The name or unique ID of the container group that you want to delete. Run cf ic group list or call the GET /containers/groups endpoint to retrieve a list of container groups in your space.

Query parameters

forcestring

If you want to force the deletion of a container group that has running container instances, use the force option. This parameter needs to be set to either true or false. If set to force=true, force=True, or force=1, running container instances are deleted. If set to force=false, force=False, or force=0, running container instances are not deleted. If you do not specify this paramater, running container instances are not deleted by default.

Headers

X-Auth-Tokenstring required

The Bluemix JSON web token that you receive when logging into Bluemix. Run cf oauth-token to retrieve your access token.

X-Auth-Project-Idstring required

The unique ID of your organization space where you want to create or work with your containers. Run cf space <space_name> --guid, where <space_name> is the name of your space, to retrieve your space ID.

Response

OK. No content. The deletion of the container group was successfully processed.