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 b
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://containers-api.ng.bluemix.net/v3
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
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
| method | path | what the vendor says it does |
|---|---|---|
POST | /build | Build a Docker image from a Dockerfile This API builds a new container image from a Dockerfile that is stored |
POST | /containers/create | Create and start a single container This endpoint creates and starts a single container in your space based on |
GET | /containers/floating-ips | List available public IP addresses in a space This endpoint returns a list of all public IP addresses that are |
POST | /containers/floating-ips/request | Request a public IP address for a space This endpoint requests a new public IP address for a space (correspond |
POST | /containers/floating-ips/{ip}/release | Release public IP address This endpoint releases a public IP address from a space (corresponding IBM Container |
GET | /containers/groups | List all container groups in a space This endpoint returns a list of all container groups in a space independe |
POST | /containers/groups | Create and start a container group. This endpoint creates and starts a new container group in your space. A co |
GET | /containers/groups/{name_or_id} | Inspect a container group. This endpoint retrieves detailed information about a container group with a given n |
PATCH | /containers/groups/{name_or_id} | Update a container group. Update the number of container instances that run in a container group (correspondin |
DELETE | /containers/groups/{name_or_id} | Stop and delete all container instances in a container group. Stops and deletes the container instances that r |
POST | /containers/groups/{name_or_id}/maproute | Map a public route to a container group. If you want your container group to be accessible from the Internet, |
POST | /containers/groups/{name_or_id}/unmaproute | Unmap a public route from a container group This endpoint unmaps a public route from a container group (corres |
GET | /containers/json | List single containers in a space. This endpoint returns a list of all single containers in a space that are c |
GET | /containers/messages | List messages for the user This endpoint retrieves all IBM Containers system messages for the user. API info |
GET | /containers/quota | Retrieve organization and space specific quota Retrieve the quota that is assigned to the organization and spa |
PUT | /containers/quota | Update space quota This endpoint updates the quota that is allocated to a Bluemix space. **Note**: Only pai |
GET | /containers/usage | List container sizes and quota limits This endpoint returns a list of available container sizes and the quota |
GET | /containers/version | List latest API version This endpoint retrieves a list of all microservices that are used in the IBM Container |
GET | /containers/{id}/status | List the current state of a container. This endpoint returns the current state of a container. This state can |
DELETE | /containers/{name_or_id} | Remove a single container Remove a single container that is identified by container ID or name from a space (c |
POST | /containers/{name_or_id}/floating-ips/{ip}/bind | Bind a public IP address to a single container This endpoint binds an available public IP address to a single |
POST | /containers/{name_or_id}/floating-ips/{ip}/unbind | Unbind a public IP address from a container This endpoint unbinds a public IP address from a container (corres |
GET | /containers/{name_or_id}/json | Inspect a single container This endpoint retrieves detailed information about a single container (correspondin |
POST | /containers/{name_or_id}/pause | Pause a single container Pause all processes in a running single container with a given container ID or name ( |
POST | /containers/{name_or_id}/rename | Rename a single container Change the current name of an existing single container that is identified by the co |
POST | /containers/{name_or_id}/restart | Restart a single container Restart a container with a given container ID or name (corresponding IBM Containers |
POST | /containers/{name_or_id}/start | Start a single container Start a single container with a given container name or ID (corresponding IBM Contain |
POST | /containers/{name_or_id}/stop | Stop a single container Stop a single container with a given container name or ID (corresponding IBM Container |
POST | /containers/{name_or_id}/unpause | Unpause a single container Unpause all processes that are currently stopped inside a single containers with a |
GET | /images/json | List all Docker images that are available in your private Bluemix registry. This endpoint returns a list of al |
DELETE | /images/{id} | Remove a Docker image. Remove a Docker image from the private Bluemix registry that is identified by the image |
GET | /images/{name_or_id}/json | Inspect a Docker image in private Bluemix registry This endpoint returns detailed information about a Docker i |
GET | /registry/namespaces | Retrieve the namespace of an organization. This endpoint retrieves the namespace that was set for the organiza |
GET | /registry/namespaces/{namespace} | Check the availability of a namespace This endpoint checks whether a namespace is available in Bluemix and can |
PUT | /registry/namespaces/{namespace} | Set a namespace for your private Bluemix registry. Set up your own Docker images registry in Bluemix by defini |
GET | /tlskey | Retrieve the TLS Certificate This endpoint returns the TLS (Transport Layer Security) certificate to the user |
PUT | /tlskey/refresh | Refresh the TLS Certificate This endpoint requests to generate a new TLS (Transport Layer Security) certificat |
POST | /volumes/create | Create a volume in a space This endpoints creates a new volume in your space (corresponding IBM Containers com |
POST | /volumes/fs/create | Create a file share in a space This endpoint creates a new file share in a space (corresponding IBM Containers |
GET | /volumes/fs/flavors/json | List available file share sizes This endpoint returns a list of available file shares in gigabyte (correspondi |
and 7 more operation(s) in this specification, all searchable.
specification origin: http://ccsapi-doc.mybluemix.net/swagger.json
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.