Get Container Group Instance

Gets a container group instance

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

Python

Python

from salad_cloud_sdk import SaladCloudSdk

sdk = SaladCloudSdk(
    api_key="YOUR_API_KEY",
    api_key_header="YOUR_API_KEY_HEADER",
    timeout=10000
)

result = sdk.container_groups.get_container_group_instance(
    organization_name="acme-corp",
    project_name="dev-env",
    container_group_name="mandlebrot",
    container_group_instance_id="db3a4591-efc3-46c0-b06a-3d820c0ec100"
)

print(result)

202

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "machine_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "state": "allocating",
  "update_time": "2023-11-07T05:31:56Z",
  "version": 1073741824,
  "ssh_ip": "192.168.1.100",
  "ssh_port": 22,
  "ssh_host_key_fingerprint": "SHA256:nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8",
  "ready": true,
  "started": true,
  "deletion_cost": 0
}

Last Updated: July 1, 2025

Authorizations

Salad-Api-Key · string · header · required

Path Parameters

organization_name · string · required

Your organization name. This identifies the billing context for the API operation and represents a security boundary for SaladCloud resources. The organization must be created before using the API, and you must be a member of the organization. The organization name.

Required string length: 2 - 63

Pattern: ^[a-z][a-z0-9-]{0,61}[a-z0-9]$

Example:

"acme-corp"

project_name · string · required

Your project name. This represents a collection of related SaladCloud resources. The project must be created before using the API. The project name.

Required string length: 2 - 63

Pattern: ^[a-z][a-z0-9-]{0,61}[a-z0-9]$

Example:

"dev-env"

container_group_name · string · required

The unique container group name The container group name.

Required string length: 2 - 63

Pattern: ^[a-z][a-z0-9-]{0,61}[a-z0-9]$

Example:

"mandlebrot"

container_group_instance_id · string<uuid> · required

The unique container group instance identifier The container group instance identifier.

Example:

"db3a4591-efc3-46c0-b06a-3d820c0ec100"

Response

202

application/json

OK

A Container Group Instance represents a running instance of a container group on a specific machine. It provides information about the execution state, readiness, and version of the deployed container group.

id · string<uuid> · required

The container group instance identifier.

Example:

"db3a4591-efc3-46c0-b06a-3d820c0ec100"

machine_id · string<uuid> · required

The container group machine identifier.

Example:

"eb3a4591-efc3-46c0-b06a-3d820c0ec100"

state · enum<string> · required

The state of the container group instance

Available options: allocating, downloading, creating, running, stopping

update_time · string<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.

version · integer<int32> · 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.

Required range: 1 <= x <= 2147483647

ssh_ip · string<ipv4>

The SSH IP address of the container group instance

Example:

"192.168.1.100"

ssh_port · integer<int32> · default: 22

The SSH port of the container group instance

Required range: 1 <= x <= 65535

ssh_host_key_fingerprint · string

The SSH host key fingerprint of the container group instance

Required string length: 1 - 256

Example:

"SHA256:nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8"

ready · boolean

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.

started · boolean

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.

deletion_cost · integer · default: 0

The cost of deleting the container group instance

Required range: 0 <= x <= 100000