Skip to main content

Get Container Details

Retrieves detailed information about a specific container, including its configuration, state, and network settings.

Path Parameters

string
required
The container ID or name

Query Parameters

string
required
The environment ID where the container is located

Response

Returns a detailed container inspection object from the Docker API.
string
Full container ID
string
Container name (includes leading slash)
string
ISO 8601 timestamp of when the container was created
string
Command executable being run
array
Command arguments
object
Container state information
string
Current status (e.g., “running”, “exited”, “paused”)
boolean
Whether the container is running
boolean
Whether the container is paused
boolean
Whether the container is restarting
number
Exit code if the container has stopped
string
ISO 8601 timestamp of when the container started
string
ISO 8601 timestamp of when the container finished
string
Image ID
object
Container configuration
string
Container hostname
array
Environment variables as strings in “KEY=value” format
array
Command to run
string
Image name and tag
object
Container labels
object
Network configuration
string
Primary IP address
object
Port mappings
object
Network attachments
array
Volume mounts and bind mounts

Error Responses

string
Error message if the request fails
Status Codes:
  • 200 - Success
  • 403 - Permission denied
  • 500 - Failed to inspect container

Example

Response Example

Inspect Container (Dedicated Endpoint)

Alternative endpoint that provides the same inspection functionality. Returns identical data to the main container details endpoint.

Path Parameters

string
required
The container ID or name

Query Parameters

string
required
The environment ID where the container is located

Response

Same response format as the main container details endpoint.

Example

Delete Container

Removes a container from the specified environment. Also cleans up any associated auto-update schedules and pending updates.

Path Parameters

string
required
The container ID or name to delete

Query Parameters

string
required
The environment ID where the container is located
boolean
default:"false"
Force removal of a running container (using SIGKILL)

Response

boolean
Whether the container was successfully removed

Error Responses

string
Error message if the request fails
Status Codes:
  • 200 - Container deleted successfully
  • 403 - Permission denied
  • 500 - Failed to remove container

Example

Response Example