Skip to main content
GET
/
organizations
/
{organization_name}
/
projects
/
{project_name}
/
containers
/
{container_group_name}
/
instances
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.list_container_group_instances(
    organization_name="acme-corp",
    project_name="dev-env",
    container_group_name="mandlebrot"
)

print(result)
{
  "instances": [
    {
      "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"

Response

OK

A collection of container group instances returned as part of a paginated response or batch operation result.

​
instances
object[]
required

An array of container group instances, each representing a deployed container group with its current state and configuration information.

Maximum array length: 1000