v1

latestOpenAPI 3.1.0MIT2026-07-2654137287.8 KB

container_groups

Update Container Group Instance

Updates a container group instance

patch/organizations/{organization_name}/projects/{project_name}/containers/{container_group_name}/instances/{container_group_instance_id}

Response

cpu_percentnumber float

The percentage of CPU used by this container group instance. This is updated every minute.

cpu_usageinteger

The total CPU usage in seconds for this container group instance. This is updated every minute.

cpu_usage_totalinteger

The total CPU usage in seconds for this container group instance since it was started. This is updated every minute.

deletion_costinteger

The cost of deleting the container group instance

idstring uuid required

The container group instance identifier.

machine_idstring uuid required

The container group machine identifier.

memory_usage_mbnumber float

The memory usage in MB for this container group instance. This is updated every minute.

memory_usage_percentnumber float

The percentage of memory used by this container group instance. This is updated every minute.

pulling_progressnumber float

The progress percentage of pulling the container image. This is only relevant when the instance state is 'downloading'.

readyboolean

Indicates whether the container group instance is currently passing its readiness checks and is able to receive traffic or perform its intended function. If no readiness probe is defined, this will be true once the instance is fully started.

ssh_host_key_fingerprintstring

The SSH host key fingerprint of the container group instance

ssh_ipstring ipv4

The SSH IP address of the container group instance

ssh_portinteger

The SSH port of the container group instance

startedboolean

Indicates whether the container group instance has successfully completed its startup sequence and passed any configured startup probes. This will always be true when no startup probe is defined for the container group.

state'allocating' | 'downloading' | 'creating' | 'running' | 'stopping' required

The state of the container group instance

update_timestring date-time required

The UTC timestamp when the container group instance last changed its state. This helps track the lifecycle and state transitions of the instance.

versioninteger required

The version of the container group definition currently running on this instance. Used to track deployment and update progress across the container group fleet.

Example response

{
  "id": "db3a4591-efc3-46c0-b06a-3d820c0ec100",
  "machine_id": "eb3a4591-efc3-46c0-b06a-3d820c0ec100",
  "ssh_host_key_fingerprint": "SHA256:nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8",
  "ssh_ip": "192.168.1.100"
}