Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-2654137287.8 KB
container_groups

Get Container Group

Gets a container group

get/organizations/{organization_name}/projects/{project_name}/containers/{container_group_name}

Response

OK

autostart_policyboolean required

Defines whether containers in this group should automatically start when deployed (true) or require manual starting (false)

country_codesCountryCode[] required

List of country codes where container instances are permitted to run. When not specified or empty, containers may run in any available region.

create_timestring date-time required

ISO 8601 timestamp when this container group was initially created

display_namestring required

The display-friendly name of the resource.

idstring uuid required

The container group identifier.

namestring required

The container group name.

organization_namestring required

The organization name.

pending_changeboolean required

Indicates whether a configuration change has been requested but not yet applied to all containers in the group

priority'high' | 'medium' | 'low' | 'batch' nullable required

Specifies the priority level for container group execution, which determines resource allocation and scheduling precedence.

project_namestring required

The project name.

readmestring
replicasinteger required

The container group replicas.

restart_policy'always' | 'on_failure' | 'never' required

Specifies the policy for restarting containers when they exit or fail.

scheduled-scaling-enabledboolean required

Indicates if scheduled scaling is enabled

update_timestring date-time required

ISO 8601 timestamp when this container group was last updated

versioninteger required

Incremental version number that increases with each configuration change to the container group

Example response

{
  "container": {
    "image": "acme/:latest",
    "image_caching": true
  },
  "country_codes": [
    "us"
  ],
  "display_name": "Name",
  "id": "ab3a4591-efc3-46c0-b06a-3d820c0ec100",
  "name": "mandlebrot",
  "networking": {
    "client_request_timeout": 100000,
    "port": 60000,
    "server_response_timeout": 100000
  },
  "organization_name": "acme-corp",
  "project_name": "dev-env",
  "replicas": 50
}