v1

Single containers

Inspect a single container

This endpoint retrieves detailed information about a single container (corresponding IBM Containers command: cf ic inspect <container>).

get/containers/{name_or_id}/json

Path parameters

name_or_idstring required

The name or ID of the container that you want to inspect. Run the cf ic ps command or call the GET /containers/json endpoint to retrieve a list of containers in your space.

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 with detailed information about the container is returned.

BluemixAppstring

The name of the Cloud Foundry app that was bound to the container during creation.

BluemixServicesstring

The name of the Bluemix service instance that was bound to the container during creation.

ContainerStatestring

The current status of the container. This state can either be transient, such as BUILDING or NETWORKING, or non-transient, such as RUNNING, SHUTDOWN, CRASHED, or SUSPENDED.

Createdstring date-time

The date and time the container was created.

HostIdstring

The ID representing the physical compute host.

Human_Idstring

The name of the container.

Idstring

Unique identifier representing a container.

Imagestring

Unique identifier representing a container image.

Mountsstring[]

A list of volumes that are mounted to the container.

Namestring

The name of the container.

Pathstring

The environment variable indicating the binary location.

ResolveConfPathstring

Path to the resolve.conf file inside the container. The resolve.conf file is used to resolve the DNS servers.

VolumesRWstring[]

LIst of volumes that is mounted to the container.