Own IBM? Customize your docs with AI search, analytics, and more.

Claim your docs

IBM Containers API

IBM

Powered by Specway

Own IBM? Customize your docs with AI search, analytics, and more.

Claim your docs

IBM Containers API

IBM

Powered by Specway

Endpoints

Build a Docker image from a DockerfilePOST

Bind a public IP address to a single containerPOST
Create and start a container group.POST
Create and start a single containerPOST
Inspect a container group.GET
Inspect a single containerGET
List all container groups in a spaceGET
List available public IP addresses in a spaceGET
List container sizes and quota limitsGET
List latest API versionGET
List messages for the userGET
List single containers in a space.GET
List the current state of a container.GET
Map a public route to a container group.POST
Pause a single containerPOST
Release public IP addressPOST
Remove a single containerDELETE
Rename a single containerPOST
Request a public IP address for a spacePOST
Restart a single containerPOST
Retrieve organization and space specific quotaGET
Start a single containerPOST
Stop a single containerPOST
Stop and delete all container instances in a container group.DELETE
Unbind a public IP address from a containerPOST
Unmap a public route from a container groupPOST
Unpause a single containerPOST
Update a container group.PATCH
Update space quotaPUT

Inspect a Docker image in private Bluemix registryGET
List all Docker images that are available in your private Bluemix registry.GET
Remove a Docker image.DELETE

Check the availability of a namespaceGET
Retrieve the namespace of an organization.GET
Set a namespace for your private Bluemix registry.PUT

Refresh the TLS CertificatePUT
Retrieve the TLS CertificateGET

Create a file share in a spacePOST
Create a volume in a spacePOST
Delete a file shareDELETE
Delete a volumeDELETE
Inspect a file shareGET
List all volumes for a spaceGET
List available file share sizesGET
List available file shares in a spaceGET
Retrieve detailed information about a volume. GET
Share a volume with another spacePOST

Endpoints

Build a Docker image from a DockerfilePOST

Bind a public IP address to a single containerPOST
Create and start a container group.POST
Create and start a single containerPOST
Inspect a container group.GET
Inspect a single containerGET
List all container groups in a spaceGET
List available public IP addresses in a spaceGET
List container sizes and quota limitsGET
List latest API versionGET
List messages for the userGET
List single containers in a space.GET
List the current state of a container.GET
Map a public route to a container group.POST
Pause a single containerPOST
Release public IP addressPOST
Remove a single containerDELETE
Rename a single containerPOST
Request a public IP address for a spacePOST
Restart a single containerPOST
Retrieve organization and space specific quotaGET
Start a single containerPOST
Stop a single containerPOST
Stop and delete all container instances in a container group.DELETE
Unbind a public IP address from a containerPOST
Unmap a public route from a container groupPOST
Unpause a single containerPOST
Update a container group.PATCH
Update space quotaPUT

Inspect a Docker image in private Bluemix registryGET
List all Docker images that are available in your private Bluemix registry.GET
Remove a Docker image.DELETE

Check the availability of a namespaceGET
Retrieve the namespace of an organization.GET
Set a namespace for your private Bluemix registry.PUT

Refresh the TLS CertificatePUT
Retrieve the TLS CertificateGET

Create a file share in a spacePOST
Create a volume in a spacePOST
Delete a file shareDELETE
Delete a volumeDELETE
Inspect a file shareGET
List all volumes for a spaceGET
List available file share sizesGET
List available file shares in a spaceGET
Retrieve detailed information about a volume. GET
Share a volume with another spacePOST

IBM Containers API

Containers are virtual software objects that include all the elements that an app needs to run. A container has the benefits of resource isolation and allocation but is more portable and efficient than, for example, a virtual machine. This documentation describes the IBM Containers API, which is based on the Docker Remote API. The API provides endpoints that you can use to create and manage your single containers and container groups in Bluemix. Endpoints are summarized under the following tags: - **Authentication**: Retrieve and refresh your TLS certificates. - **Private Docker images registry**: Create your own private Docker images registry in Bluemix by setting a namespace for your organization. - **Images**: View, build, and push your images to your private Bluemix registry so you can use them with IBM Containers. You can also scan your container images with the Vulnerability Advisor against standard policies set by the organization manager and a database of known Ubuntu iss

Base URL

https://containers-api.ng.bluemix.net/v3

Endpoints

47 endpoints available

Build a Docker image from a Dockerfile

Retrieve the TLS Certificate

List all Docker images that are available in your private Bluemix registry.

Remove a Docker image.

/volumes/json

List all volumes for a space

/tlskey/refresh

Refresh the TLS Certificate

/volumes/create

Create a volume in a space

/volumes/{name}

Share a volume with another space

/volumes/{name}

Delete a volume

/containers/json

List single containers in a space.

/volumes/fs/json

List available file shares in a space

/containers/quota

Retrieve organization and space specific quota

/containers/quota

Update space quota

/containers/usage

List container sizes and quota limits

/containers/create

Create and start a single container

/containers/groups

List all container groups in a space

/containers/groups

Create and start a container group.

/volumes/fs/create

Create a file share in a space

/volumes/fs/{name}

Delete a file share

/containers/version

List latest API version

/containers/messages

List messages for the user

/registry/namespaces

Retrieve the namespace of an organization.

/volumes/{name}/json

Retrieve detailed information about a volume.

/containers/{id}/status

List the current state of a container.

/volumes/fs/{name}/json

Inspect a file share

/containers/floating-ips

List available public IP addresses in a space

/containers/{name_or_id}

Remove a single container

/volumes/fs/flavors/json

List available file share sizes

/images/{name_or_id}/json

Inspect a Docker image in private Bluemix registry

/containers/{name_or_id}/json

Inspect a single container

/containers/{name_or_id}/stop

Stop a single container

/containers/{name_or_id}/pause

Pause a single container

/containers/{name_or_id}/start

Start a single container

/containers/groups/{name_or_id}

Inspect a container group.

/containers/groups/{name_or_id}

Update a container group.

/containers/groups/{name_or_id}

Stop and delete all container instances in a container group.

/containers/{name_or_id}/rename

Rename a single container

/containers/floating-ips/request

Request a public IP address for a space

/containers/{name_or_id}/restart

Restart a single container

/containers/{name_or_id}/unpause

Unpause a single container

/registry/namespaces/{namespace}

Check the availability of a namespace

/registry/namespaces/{namespace}

Set a namespace for your private Bluemix registry.

/containers/floating-ips/{ip}/release

Release public IP address

/containers/groups/{name_or_id}/maproute

Map a public route to a container group.

/containers/groups/{name_or_id}/unmaproute

Unmap a public route from a container group

/containers/{name_or_id}/floating-ips/{ip}/bind

Bind a public IP address to a single container

/containers/{name_or_id}/floating-ips/{ip}/unbind

Unbind a public IP address from a container

IBM Containers API

Containers are virtual software objects that include all the elements that an app needs to run. A container has the benefits of resource isolation and allocation but is more portable and efficient than, for example, a virtual machine. This documentation describes the IBM Containers API, which is based on the Docker Remote API. The API provides endpoints that you can use to create and manage your single containers and container groups in Bluemix. Endpoints are summarized under the following tags: - **Authentication**: Retrieve and refresh your TLS certificates. - **Private Docker images registry**: Create your own private Docker images registry in Bluemix by setting a namespace for your organization. - **Images**: View, build, and push your images to your private Bluemix registry so you can use them with IBM Containers. You can also scan your container images with the Vulnerability Advisor against standard policies set by the organization manager and a database of known Ubuntu iss

Base URL

https://containers-api.ng.bluemix.net/v3

Endpoints

47 endpoints available

Build a Docker image from a Dockerfile

Retrieve the TLS Certificate

List all Docker images that are available in your private Bluemix registry.

Remove a Docker image.

/volumes/json

List all volumes for a space

/tlskey/refresh

Refresh the TLS Certificate

/volumes/create

Create a volume in a space

/volumes/{name}

Share a volume with another space

/volumes/{name}

Delete a volume

/containers/json

List single containers in a space.

/volumes/fs/json

List available file shares in a space

/containers/quota

Retrieve organization and space specific quota

/containers/quota

Update space quota

/containers/usage

List container sizes and quota limits

/containers/create

Create and start a single container

/containers/groups

List all container groups in a space

/containers/groups

Create and start a container group.

/volumes/fs/create

Create a file share in a space

/volumes/fs/{name}

Delete a file share

/containers/version

List latest API version

/containers/messages

List messages for the user

/registry/namespaces

Retrieve the namespace of an organization.

/volumes/{name}/json

Retrieve detailed information about a volume.

/containers/{id}/status

List the current state of a container.

/volumes/fs/{name}/json

Inspect a file share

/containers/floating-ips

List available public IP addresses in a space

/containers/{name_or_id}

Remove a single container

/volumes/fs/flavors/json

List available file share sizes

/images/{name_or_id}/json

Inspect a Docker image in private Bluemix registry

/containers/{name_or_id}/json

Inspect a single container

/containers/{name_or_id}/stop

Stop a single container

/containers/{name_or_id}/pause

Pause a single container

/containers/{name_or_id}/start

Start a single container

/containers/groups/{name_or_id}

Inspect a container group.

/containers/groups/{name_or_id}

Update a container group.

/containers/groups/{name_or_id}

Stop and delete all container instances in a container group.

/containers/{name_or_id}/rename

Rename a single container

/containers/floating-ips/request

Request a public IP address for a space

/containers/{name_or_id}/restart

Restart a single container

/containers/{name_or_id}/unpause

Unpause a single container

/registry/namespaces/{namespace}

Check the availability of a namespace

/registry/namespaces/{namespace}

Set a namespace for your private Bluemix registry.

/containers/floating-ips/{ip}/release

Release public IP address

/containers/groups/{name_or_id}/maproute

Map a public route to a container group.

/containers/groups/{name_or_id}/unmaproute

Unmap a public route from a container group

/containers/{name_or_id}/floating-ips/{ip}/bind

Bind a public IP address to a single container

/containers/{name_or_id}/floating-ips/{ip}/unbind

Unbind a public IP address from a container