Containers

Get detailed information about a specific container

Changed on
get/projects/{project_id}/environments/{environment_id}/containers/{container_id}

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/projects/{project_id}/environments/{environment_id}/containers/{container_id}
  • Auth: HTTP bearer

Path parameters

project_idinteger required

Project ID

environment_idinteger required

Environment ID

container_idstring required

Container ID

Response

Container details

container_idstring required
container_namestring required
container_portinteger required

Port inside the container

cpu_limit_coresnumber double nullable

CPU limit in whole cores (e.g. 1.0). None when no limit is configured.

created_atstring required
deployed_atstring required
deployment_idinteger required
error_messagestring nullable

Free-form error string from Docker's container state on exit.

exit_codeinteger nullable

Process exit code reported by Docker. None while still running.

exit_reasonstring nullable

Human-readable reason the container exited.

finished_atstring nullable

When the container exited (Docker's FinishedAt). None while running.

host_portinteger nullable

Port on the host machine

idinteger required
image_namestring required
oom_killedboolean nullable

True when Docker's OOM killer terminated the container.

ready_atstring nullable
restart_countinteger nullable

Container restart count from Docker

service_namestring nullable

Compose service name (e.g. "web", "redis"). None for single-container deployments.

service_urlstring nullable

Per-service URL for compose deployments. The service's first public URL when it exposes several ports.

started_atstring nullable

When the container's main process most recently started.

statusstring required

Example response

{
  "created_at": "2025-10-12T12:15:47.609192Z",
  "deployed_at": "2025-10-12T12:15:47.609192Z",
  "finished_at": "2025-10-12T12:16:47.609192Z",
  "ready_at": "2025-10-12T12:16:47.609192Z",
  "service_urls": [
    {
      "port": 3000,
      "service": "web",
      "url": "https://web--production.localho.st"
    }
  ],
  "started_at": "2025-10-12T12:15:50.000000Z"
}

Changes

  • 4b228ebed583Revision changes
    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

  • 1dc3e6788214Revision changes
    • warning

      removed the optional property from the response with the status

    • info

      removed the non-success response with the status