v1

Container Groups

List all container groups in a space

This endpoint returns a list of all container groups in a space independent of their current state. (corresponding IBM Containers command: cf ic group list).

get/containers/groups

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. A list of container groups is returned.

Creation_timestring

Time when the container group is created.

Idstring

Unique identifier of the container group.

Namestring

Name of the container group.

Portinteger

The port number that is exposed to the public during container group creation.

Routesstring[]

The public route that is mapped to the container group. You can use this route to access your container group from the Internet.

Statusstring

Current status of the container group. The container group status is a composite of ACTION and STATUS:<br><br> ACTIONS = (CREATE, DELETE, UPDATE, ROLLBACK, SUSPEND, RESUME, ADOPT, SNAPSHOT, CHECK, RESTORE)<br><br> STATUSES = (IN_PROGRESS, FAILED, COMPLETE)

Updated_timestring

Time when the container group is changed and updated.