Skip to content
Cloudflare API
Start here
API Reference
Containers

Applications

List Applications associated with your account
containers.applications.list(ApplicationListParams**kwargs) -> SyncPageTokenPagination[ApplicationListResponse]
GET/accounts/{account_id}/containers/applications
Create a new application
containers.applications.create(ApplicationCreateParams**kwargs) -> ApplicationCreateResponse
POST/accounts/{account_id}/containers/applications
Get a single application by id
containers.applications.get(strapplication_id, ApplicationGetParams**kwargs) -> ApplicationGetResponse
GET/accounts/{account_id}/containers/applications/{application_id}
Modify an application
containers.applications.edit(strapplication_id, ApplicationEditParams**kwargs) -> ApplicationEditResponse
PATCH/accounts/{account_id}/containers/applications/{application_id}
Delete a single application by id
containers.applications.delete(strapplication_id, ApplicationDeleteParams**kwargs) -> ApplicationDeleteResponse
DELETE/accounts/{account_id}/containers/applications/{application_id}
ModelsExpand Collapse
ApplicationListResponse

The public Containers API returns an application.

One of the following:
class CcScheduledApplication: …

Describes an application and the parameters that govern how it places its instances.

id: str

An Application ID represents an identifier of an application.

account_id: str

A unique identifier for the user’s account.

configuration: CcScheduledApplicationConfiguration

User-specified container configuration.

image: str

Image url.

authorized_keys: Optional[List[CcScheduledApplicationConfigurationAuthorizedKey]]
public_key: str

An SSH public key.

name: Optional[str]

Optional human readable name for this key.

command: Optional[List[str]]

The command that runs when the container starts, passed to the entrypoint. You can override this at run-time. If you override only the command, it gets passed to the default entrypoint specified in the image.

entrypoint: Optional[List[str]]

The entry point for the container, specifying the executable to run when the container starts. You can override this at run-time. If you do, the default command from the image is ignored. Specify both entrypoint and command at run-time to completely replace the image defaults.

environment_variables: Optional[List[CcScheduledApplicationConfigurationEnvironmentVariable]]

Container environment variables.

name: str

An environment variable name.

value: str

An environment variable value.

instance_type: Optional[Literal["lite", "basic", "standard-1", 3 more]]

The instance type configures vCPU, memory, and disk.

  • “lite”: 1/16 vCPU, 256 MiB memory, 2 GB disk
  • “basic”: 1/4 vCPU, 1 GiB memory, 4 GB disk
  • “standard-1”: 1/2 vCPU, 4 GiB memory, 8 GB disk
  • “standard-2”: 1 vCPU, 6 GiB memory, 12 GB disk
  • “standard-3”: 2 vCPU, 8 GiB memory, 16 GB disk
  • “standard-4”: 4 vCPU, 12 GiB memory, 20 GB disk
One of the following:
"lite"
"basic"
"standard-1"
"standard-2"
"standard-3"
"standard-4"
observability: Optional[CcScheduledApplicationConfigurationObservability]

Settings for deployment observability such as logging.

logs: Optional[CcScheduledApplicationConfigurationObservabilityLogs]

Observability logging settings.

enabled: Optional[bool]
created_at: str

UTC timestamp string in ISO 8601 format.

instances: int

Number of deployments to create.

name: str

The application name.

scheduling_policy: Literal["default", "durable_object"]

The scheduling policy to use for an application.

One of the following:
"default"
"durable_object"
updated_at: str

UTC timestamp string in ISO 8601 format.

version: int
active_rollout_id: Optional[str]

An identifier for a specific rollout within an application.

constraints: Optional[CcScheduledApplicationConstraints]
jurisdiction: Optional[str]

Restricts placement to datacenters in the selected jurisdiction. Choose “eu”, “fedramp”, or “us”. When combined with regions, EU supports EEUR and WEUR while FedRAMP and US support ENAM and WNAM.

regions: Optional[List[str]]
durable_objects: Optional[CcScheduledApplicationDurableObjects]

Durable object configuration stored on and returned from a Cloudchamber application.

namespace_id: str

The namespace ID of the durable object namespace to use for this application.

health: Optional[CcScheduledApplicationHealth]
errors: List[CcScheduledApplicationHealthError]
event: CcScheduledApplicationHealthErrorEvent

An event within a Placement or a Job.

id: str
details: Dict[str, object]
message: str
name: Literal["SchedulerPlaced", "NetworkingIPAssigned", "VMStarted", 14 more]

Name of the event that describes the kind event that happened.

  • SchedulerPlaced: It’s the first event that creates a container placement. It happens when the Containers runtime was able to retrieve deployment resources and start verifying everything is correct.
  • NetworkingIPAssigned: It’s sent when the Containers runtime maps the IP to the container.
  • VMStarted: It’s sent when the Containers runtime starts the VM. The container might remain unhealthy at this point.
  • ImagePulled: It’s sent when the Containers runtime pulls the image successfully.
  • ImagePullError: It’s sent when the Containers runtime is having issues pulling the image. The message and details have more information on what happened for debugging.
  • VMFailedToStart: It’s sent when the Containers runtime was unable to boot the VM.
  • VMStopping: It’s sent when the scheduler is stopping the VM.
  • VMStopped: It’s sent when the VM finally exits.
  • VMFailed: It’s sent when the scheduling of the VM failed in the current location.
  • RuntimeStartFailed: It’s sent when the runtime hits an internal error.
  • SSHStarted: It’s sent when the container gains network connectivity and opens the SSH port. Containers only send this event when SSH keys exist.
  • CheckUpdate: Sent when the status of a health or readiness check changes. This may also affect the health status of the placement.
  • DurableObjectConnected: Sent when a durable object instance connects and gains control of the deployment. This event is only sent for durable object deployments. It is sent after VMStarted.
  • ContainerStarted: It’s sent when the container starts running.
One of the following:
"SchedulerPlaced"
"NetworkingIPAssigned"
"VMStarted"
"ImagePulled"
"ImagePullError"
"VMFailedToStart"
"NetworkingIPAssignmentFailed"
"VMRunning"
"VMStopping"
"VMStopped"
"VMFailed"
"RuntimeStartFailed"
"SSHStarted"
"ServiceHealthUpdates"
"CheckUpdate"
"DurableObjectConnected"
"ContainerStarted"
status_change: Dict[str, object]
time: str

UTC timestamp string in ISO 8601 format.

type: Literal["Info", "Error", "Warn", 2 more]
One of the following:
"Info"
"Error"
"Warn"
"UserError"
"SystemError"
instance_id: str

An instance ID represents an identifier of an instance configuration that maintains an underlying placement.

instances: CcScheduledApplicationHealthInstances

Shows a count of application instance states.

active: int

Number of instances whose runtime reports the container as running (container_status = “running”). This is a subset of the placements that remain up: an instance that is already bound to a Durable Object and serving traffic is counted under “assigned” until its container_status catches up to “running”, so container_status can briefly lag Durable Object attachment under churn. To estimate running, Durable-Object-bound instances, sum “active” + “assigned” rather than reading “active” alone.

assigned: int

Number of instances bound to a Durable Object with a running placement whose container_status remains behind “running”. These count as live, serving instances; “active” + “assigned” approximates the running, Durable-Object-bound count.

summary: Optional[Literal["healthy", "degraded", "unhealthy", "pending"]]

High-level health assessment. Only populated for “new_instances” strategy. Based on a sample of target-version instances rather than a full count.

  • “pending”: Zero target-version instances exist yet.
  • “healthy”: Every sampled target-version instance reports running or active.
  • “degraded”: Some sampled instances remain starting or scheduling.
  • “unhealthy”: One or more sampled instances have failed.
One of the following:
"healthy"
"degraded"
"unhealthy"
"pending"
max_instances: Optional[int]

Maximum number of instances the application allows. This is relevant for applications that auto-scale.

observability: Optional[CcScheduledApplicationObservability]

Top-level observability settings for the application. This field is mutually exclusive with configuration.observability.

logs: Optional[CcScheduledApplicationObservabilityLogs]

Observability logging settings.

enabled: Optional[bool]
rollout_active_grace_period: Optional[int]

Grace period for active instances to stay alive before becoming eligible for shutdown signal due to a rollout, in seconds. Defaults to 0.

maximum604800
minimum0
class CcDurableObjectApplication: …

Each Durable Object creates and manages the lifecycle of its container instance.

id: str

An Application ID represents an identifier of an application.

account_id: str

A unique identifier for the user’s account.

created_at: str

UTC timestamp string in ISO 8601 format.

durable_objects: CcDurableObjectApplicationDurableObjects

Durable object configuration using a namespace ID.

namespace_id: str

The namespace ID of the durable object namespace to use for this application.

name: str

The application name.

scheduling_policy: Literal["durable_object"]

Selects a Durable Object-managed application. Each Durable Object creates and manages the lifecycle of its container instance. Configure application-wide observability settings here. Deployment configuration, scaling, placement constraints, versions, and rollouts do not apply.

updated_at: str

UTC timestamp string in ISO 8601 format.

configuration: Optional[CcDurableObjectApplicationConfiguration]

Application-wide settings for a Durable Object-managed application.

authorized_keys: Optional[List[CcDurableObjectApplicationConfigurationAuthorizedKey]]
public_key: str

An SSH public key.

name: Optional[str]

Optional human readable name for this key.

wrangler_ssh: Optional[CcDurableObjectApplicationConfigurationWranglerSSH]

Configuration properties for connecting with SSH to a container using Wrangler.

enabled: Optional[bool]
port: Optional[int]
maximum65535
minimum1
health: Optional[CcDurableObjectApplicationHealth]

Aggregate current activity for the latest observed placement of each instance. Runtime snapshots feed periodic background sweeps. Counts refresh after each complete sweep. Instance listings retain their separate three-month history for failure discovery.

instances: CcDurableObjectApplicationHealthInstances

Counts of observed non-terminal instances.

active: int

Number of instances whose runtime reports running or stopping.

minimum0
starting: int

Number of instances whose runtime reports starting.

minimum0
summary: Optional[Literal["pending"]]

Present as pending until the first activity sweep completes; omitted afterward.

observability: Optional[CcDurableObjectApplicationObservability]

Application-wide logging settings for a Durable Object-managed application. The application publishes these settings to its runtime metadata. Updating them does not create a deployment or rollout.

logs: Optional[CcDurableObjectApplicationObservabilityLogs]

Application-wide logging settings.

enabled: Optional[bool]
ApplicationCreateResponse

The public Containers API returns an application.

One of the following:
class CcScheduledApplication: …

Describes an application and the parameters that govern how it places its instances.

id: str

An Application ID represents an identifier of an application.

account_id: str

A unique identifier for the user’s account.

configuration: CcScheduledApplicationConfiguration

User-specified container configuration.

image: str

Image url.

authorized_keys: Optional[List[CcScheduledApplicationConfigurationAuthorizedKey]]
public_key: str

An SSH public key.

name: Optional[str]

Optional human readable name for this key.

command: Optional[List[str]]

The command that runs when the container starts, passed to the entrypoint. You can override this at run-time. If you override only the command, it gets passed to the default entrypoint specified in the image.

entrypoint: Optional[List[str]]

The entry point for the container, specifying the executable to run when the container starts. You can override this at run-time. If you do, the default command from the image is ignored. Specify both entrypoint and command at run-time to completely replace the image defaults.

environment_variables: Optional[List[CcScheduledApplicationConfigurationEnvironmentVariable]]

Container environment variables.

name: str

An environment variable name.

value: str

An environment variable value.

instance_type: Optional[Literal["lite", "basic", "standard-1", 3 more]]

The instance type configures vCPU, memory, and disk.

  • “lite”: 1/16 vCPU, 256 MiB memory, 2 GB disk
  • “basic”: 1/4 vCPU, 1 GiB memory, 4 GB disk
  • “standard-1”: 1/2 vCPU, 4 GiB memory, 8 GB disk
  • “standard-2”: 1 vCPU, 6 GiB memory, 12 GB disk
  • “standard-3”: 2 vCPU, 8 GiB memory, 16 GB disk
  • “standard-4”: 4 vCPU, 12 GiB memory, 20 GB disk
One of the following:
"lite"
"basic"
"standard-1"
"standard-2"
"standard-3"
"standard-4"
observability: Optional[CcScheduledApplicationConfigurationObservability]

Settings for deployment observability such as logging.

logs: Optional[CcScheduledApplicationConfigurationObservabilityLogs]

Observability logging settings.

enabled: Optional[bool]
created_at: str

UTC timestamp string in ISO 8601 format.

instances: int

Number of deployments to create.

name: str

The application name.

scheduling_policy: Literal["default", "durable_object"]

The scheduling policy to use for an application.

One of the following:
"default"
"durable_object"
updated_at: str

UTC timestamp string in ISO 8601 format.

version: int
active_rollout_id: Optional[str]

An identifier for a specific rollout within an application.

constraints: Optional[CcScheduledApplicationConstraints]
jurisdiction: Optional[str]

Restricts placement to datacenters in the selected jurisdiction. Choose “eu”, “fedramp”, or “us”. When combined with regions, EU supports EEUR and WEUR while FedRAMP and US support ENAM and WNAM.

regions: Optional[List[str]]
durable_objects: Optional[CcScheduledApplicationDurableObjects]

Durable object configuration stored on and returned from a Cloudchamber application.

namespace_id: str

The namespace ID of the durable object namespace to use for this application.

health: Optional[CcScheduledApplicationHealth]
errors: List[CcScheduledApplicationHealthError]
event: CcScheduledApplicationHealthErrorEvent

An event within a Placement or a Job.

id: str
details: Dict[str, object]
message: str
name: Literal["SchedulerPlaced", "NetworkingIPAssigned", "VMStarted", 14 more]

Name of the event that describes the kind event that happened.

  • SchedulerPlaced: It’s the first event that creates a container placement. It happens when the Containers runtime was able to retrieve deployment resources and start verifying everything is correct.
  • NetworkingIPAssigned: It’s sent when the Containers runtime maps the IP to the container.
  • VMStarted: It’s sent when the Containers runtime starts the VM. The container might remain unhealthy at this point.
  • ImagePulled: It’s sent when the Containers runtime pulls the image successfully.
  • ImagePullError: It’s sent when the Containers runtime is having issues pulling the image. The message and details have more information on what happened for debugging.
  • VMFailedToStart: It’s sent when the Containers runtime was unable to boot the VM.
  • VMStopping: It’s sent when the scheduler is stopping the VM.
  • VMStopped: It’s sent when the VM finally exits.
  • VMFailed: It’s sent when the scheduling of the VM failed in the current location.
  • RuntimeStartFailed: It’s sent when the runtime hits an internal error.
  • SSHStarted: It’s sent when the container gains network connectivity and opens the SSH port. Containers only send this event when SSH keys exist.
  • CheckUpdate: Sent when the status of a health or readiness check changes. This may also affect the health status of the placement.
  • DurableObjectConnected: Sent when a durable object instance connects and gains control of the deployment. This event is only sent for durable object deployments. It is sent after VMStarted.
  • ContainerStarted: It’s sent when the container starts running.
One of the following:
"SchedulerPlaced"
"NetworkingIPAssigned"
"VMStarted"
"ImagePulled"
"ImagePullError"
"VMFailedToStart"
"NetworkingIPAssignmentFailed"
"VMRunning"
"VMStopping"
"VMStopped"
"VMFailed"
"RuntimeStartFailed"
"SSHStarted"
"ServiceHealthUpdates"
"CheckUpdate"
"DurableObjectConnected"
"ContainerStarted"
status_change: Dict[str, object]
time: str

UTC timestamp string in ISO 8601 format.

type: Literal["Info", "Error", "Warn", 2 more]
One of the following:
"Info"
"Error"
"Warn"
"UserError"
"SystemError"
instance_id: str

An instance ID represents an identifier of an instance configuration that maintains an underlying placement.

instances: CcScheduledApplicationHealthInstances

Shows a count of application instance states.

active: int

Number of instances whose runtime reports the container as running (container_status = “running”). This is a subset of the placements that remain up: an instance that is already bound to a Durable Object and serving traffic is counted under “assigned” until its container_status catches up to “running”, so container_status can briefly lag Durable Object attachment under churn. To estimate running, Durable-Object-bound instances, sum “active” + “assigned” rather than reading “active” alone.

assigned: int

Number of instances bound to a Durable Object with a running placement whose container_status remains behind “running”. These count as live, serving instances; “active” + “assigned” approximates the running, Durable-Object-bound count.

summary: Optional[Literal["healthy", "degraded", "unhealthy", "pending"]]

High-level health assessment. Only populated for “new_instances” strategy. Based on a sample of target-version instances rather than a full count.

  • “pending”: Zero target-version instances exist yet.
  • “healthy”: Every sampled target-version instance reports running or active.
  • “degraded”: Some sampled instances remain starting or scheduling.
  • “unhealthy”: One or more sampled instances have failed.
One of the following:
"healthy"
"degraded"
"unhealthy"
"pending"
max_instances: Optional[int]

Maximum number of instances the application allows. This is relevant for applications that auto-scale.

observability: Optional[CcScheduledApplicationObservability]

Top-level observability settings for the application. This field is mutually exclusive with configuration.observability.

logs: Optional[CcScheduledApplicationObservabilityLogs]

Observability logging settings.

enabled: Optional[bool]
rollout_active_grace_period: Optional[int]

Grace period for active instances to stay alive before becoming eligible for shutdown signal due to a rollout, in seconds. Defaults to 0.

maximum604800
minimum0
class CcDurableObjectApplication: …

Each Durable Object creates and manages the lifecycle of its container instance.

id: str

An Application ID represents an identifier of an application.

account_id: str

A unique identifier for the user’s account.

created_at: str

UTC timestamp string in ISO 8601 format.

durable_objects: CcDurableObjectApplicationDurableObjects

Durable object configuration using a namespace ID.

namespace_id: str

The namespace ID of the durable object namespace to use for this application.

name: str

The application name.

scheduling_policy: Literal["durable_object"]

Selects a Durable Object-managed application. Each Durable Object creates and manages the lifecycle of its container instance. Configure application-wide observability settings here. Deployment configuration, scaling, placement constraints, versions, and rollouts do not apply.

updated_at: str

UTC timestamp string in ISO 8601 format.

configuration: Optional[CcDurableObjectApplicationConfiguration]

Application-wide settings for a Durable Object-managed application.

authorized_keys: Optional[List[CcDurableObjectApplicationConfigurationAuthorizedKey]]
public_key: str

An SSH public key.

name: Optional[str]

Optional human readable name for this key.

wrangler_ssh: Optional[CcDurableObjectApplicationConfigurationWranglerSSH]

Configuration properties for connecting with SSH to a container using Wrangler.

enabled: Optional[bool]
port: Optional[int]
maximum65535
minimum1
health: Optional[CcDurableObjectApplicationHealth]

Aggregate current activity for the latest observed placement of each instance. Runtime snapshots feed periodic background sweeps. Counts refresh after each complete sweep. Instance listings retain their separate three-month history for failure discovery.

instances: CcDurableObjectApplicationHealthInstances

Counts of observed non-terminal instances.

active: int

Number of instances whose runtime reports running or stopping.

minimum0
starting: int

Number of instances whose runtime reports starting.

minimum0
summary: Optional[Literal["pending"]]

Present as pending until the first activity sweep completes; omitted afterward.

observability: Optional[CcDurableObjectApplicationObservability]

Application-wide logging settings for a Durable Object-managed application. The application publishes these settings to its runtime metadata. Updating them does not create a deployment or rollout.

logs: Optional[CcDurableObjectApplicationObservabilityLogs]

Application-wide logging settings.

enabled: Optional[bool]
ApplicationGetResponse

The public Containers API returns an application.

One of the following:
class CcScheduledApplication: …

Describes an application and the parameters that govern how it places its instances.

id: str

An Application ID represents an identifier of an application.

account_id: str

A unique identifier for the user’s account.

configuration: CcScheduledApplicationConfiguration

User-specified container configuration.

image: str

Image url.

authorized_keys: Optional[List[CcScheduledApplicationConfigurationAuthorizedKey]]
public_key: str

An SSH public key.

name: Optional[str]

Optional human readable name for this key.

command: Optional[List[str]]

The command that runs when the container starts, passed to the entrypoint. You can override this at run-time. If you override only the command, it gets passed to the default entrypoint specified in the image.

entrypoint: Optional[List[str]]

The entry point for the container, specifying the executable to run when the container starts. You can override this at run-time. If you do, the default command from the image is ignored. Specify both entrypoint and command at run-time to completely replace the image defaults.

environment_variables: Optional[List[CcScheduledApplicationConfigurationEnvironmentVariable]]

Container environment variables.

name: str

An environment variable name.

value: str

An environment variable value.

instance_type: Optional[Literal["lite", "basic", "standard-1", 3 more]]

The instance type configures vCPU, memory, and disk.

  • “lite”: 1/16 vCPU, 256 MiB memory, 2 GB disk
  • “basic”: 1/4 vCPU, 1 GiB memory, 4 GB disk
  • “standard-1”: 1/2 vCPU, 4 GiB memory, 8 GB disk
  • “standard-2”: 1 vCPU, 6 GiB memory, 12 GB disk
  • “standard-3”: 2 vCPU, 8 GiB memory, 16 GB disk
  • “standard-4”: 4 vCPU, 12 GiB memory, 20 GB disk
One of the following:
"lite"
"basic"
"standard-1"
"standard-2"
"standard-3"
"standard-4"
observability: Optional[CcScheduledApplicationConfigurationObservability]

Settings for deployment observability such as logging.

logs: Optional[CcScheduledApplicationConfigurationObservabilityLogs]

Observability logging settings.

enabled: Optional[bool]
created_at: str

UTC timestamp string in ISO 8601 format.

instances: int

Number of deployments to create.

name: str

The application name.

scheduling_policy: Literal["default", "durable_object"]

The scheduling policy to use for an application.

One of the following:
"default"
"durable_object"
updated_at: str

UTC timestamp string in ISO 8601 format.

version: int
active_rollout_id: Optional[str]

An identifier for a specific rollout within an application.

constraints: Optional[CcScheduledApplicationConstraints]
jurisdiction: Optional[str]

Restricts placement to datacenters in the selected jurisdiction. Choose “eu”, “fedramp”, or “us”. When combined with regions, EU supports EEUR and WEUR while FedRAMP and US support ENAM and WNAM.

regions: Optional[List[str]]
durable_objects: Optional[CcScheduledApplicationDurableObjects]

Durable object configuration stored on and returned from a Cloudchamber application.

namespace_id: str

The namespace ID of the durable object namespace to use for this application.

health: Optional[CcScheduledApplicationHealth]
errors: List[CcScheduledApplicationHealthError]
event: CcScheduledApplicationHealthErrorEvent

An event within a Placement or a Job.

id: str
details: Dict[str, object]
message: str
name: Literal["SchedulerPlaced", "NetworkingIPAssigned", "VMStarted", 14 more]

Name of the event that describes the kind event that happened.

  • SchedulerPlaced: It’s the first event that creates a container placement. It happens when the Containers runtime was able to retrieve deployment resources and start verifying everything is correct.
  • NetworkingIPAssigned: It’s sent when the Containers runtime maps the IP to the container.
  • VMStarted: It’s sent when the Containers runtime starts the VM. The container might remain unhealthy at this point.
  • ImagePulled: It’s sent when the Containers runtime pulls the image successfully.
  • ImagePullError: It’s sent when the Containers runtime is having issues pulling the image. The message and details have more information on what happened for debugging.
  • VMFailedToStart: It’s sent when the Containers runtime was unable to boot the VM.
  • VMStopping: It’s sent when the scheduler is stopping the VM.
  • VMStopped: It’s sent when the VM finally exits.
  • VMFailed: It’s sent when the scheduling of the VM failed in the current location.
  • RuntimeStartFailed: It’s sent when the runtime hits an internal error.
  • SSHStarted: It’s sent when the container gains network connectivity and opens the SSH port. Containers only send this event when SSH keys exist.
  • CheckUpdate: Sent when the status of a health or readiness check changes. This may also affect the health status of the placement.
  • DurableObjectConnected: Sent when a durable object instance connects and gains control of the deployment. This event is only sent for durable object deployments. It is sent after VMStarted.
  • ContainerStarted: It’s sent when the container starts running.
One of the following:
"SchedulerPlaced"
"NetworkingIPAssigned"
"VMStarted"
"ImagePulled"
"ImagePullError"
"VMFailedToStart"
"NetworkingIPAssignmentFailed"
"VMRunning"
"VMStopping"
"VMStopped"
"VMFailed"
"RuntimeStartFailed"
"SSHStarted"
"ServiceHealthUpdates"
"CheckUpdate"
"DurableObjectConnected"
"ContainerStarted"
status_change: Dict[str, object]
time: str

UTC timestamp string in ISO 8601 format.

type: Literal["Info", "Error", "Warn", 2 more]
One of the following:
"Info"
"Error"
"Warn"
"UserError"
"SystemError"
instance_id: str

An instance ID represents an identifier of an instance configuration that maintains an underlying placement.

instances: CcScheduledApplicationHealthInstances

Shows a count of application instance states.

active: int

Number of instances whose runtime reports the container as running (container_status = “running”). This is a subset of the placements that remain up: an instance that is already bound to a Durable Object and serving traffic is counted under “assigned” until its container_status catches up to “running”, so container_status can briefly lag Durable Object attachment under churn. To estimate running, Durable-Object-bound instances, sum “active” + “assigned” rather than reading “active” alone.

assigned: int

Number of instances bound to a Durable Object with a running placement whose container_status remains behind “running”. These count as live, serving instances; “active” + “assigned” approximates the running, Durable-Object-bound count.

summary: Optional[Literal["healthy", "degraded", "unhealthy", "pending"]]

High-level health assessment. Only populated for “new_instances” strategy. Based on a sample of target-version instances rather than a full count.

  • “pending”: Zero target-version instances exist yet.
  • “healthy”: Every sampled target-version instance reports running or active.
  • “degraded”: Some sampled instances remain starting or scheduling.
  • “unhealthy”: One or more sampled instances have failed.
One of the following:
"healthy"
"degraded"
"unhealthy"
"pending"
max_instances: Optional[int]

Maximum number of instances the application allows. This is relevant for applications that auto-scale.

observability: Optional[CcScheduledApplicationObservability]

Top-level observability settings for the application. This field is mutually exclusive with configuration.observability.

logs: Optional[CcScheduledApplicationObservabilityLogs]

Observability logging settings.

enabled: Optional[bool]
rollout_active_grace_period: Optional[int]

Grace period for active instances to stay alive before becoming eligible for shutdown signal due to a rollout, in seconds. Defaults to 0.

maximum604800
minimum0
class CcDurableObjectApplication: …

Each Durable Object creates and manages the lifecycle of its container instance.

id: str

An Application ID represents an identifier of an application.

account_id: str

A unique identifier for the user’s account.

created_at: str

UTC timestamp string in ISO 8601 format.

durable_objects: CcDurableObjectApplicationDurableObjects

Durable object configuration using a namespace ID.

namespace_id: str

The namespace ID of the durable object namespace to use for this application.

name: str

The application name.

scheduling_policy: Literal["durable_object"]

Selects a Durable Object-managed application. Each Durable Object creates and manages the lifecycle of its container instance. Configure application-wide observability settings here. Deployment configuration, scaling, placement constraints, versions, and rollouts do not apply.

updated_at: str

UTC timestamp string in ISO 8601 format.

configuration: Optional[CcDurableObjectApplicationConfiguration]

Application-wide settings for a Durable Object-managed application.

authorized_keys: Optional[List[CcDurableObjectApplicationConfigurationAuthorizedKey]]
public_key: str

An SSH public key.

name: Optional[str]

Optional human readable name for this key.

wrangler_ssh: Optional[CcDurableObjectApplicationConfigurationWranglerSSH]

Configuration properties for connecting with SSH to a container using Wrangler.

enabled: Optional[bool]
port: Optional[int]
maximum65535
minimum1
health: Optional[CcDurableObjectApplicationHealth]

Aggregate current activity for the latest observed placement of each instance. Runtime snapshots feed periodic background sweeps. Counts refresh after each complete sweep. Instance listings retain their separate three-month history for failure discovery.

instances: CcDurableObjectApplicationHealthInstances

Counts of observed non-terminal instances.

active: int

Number of instances whose runtime reports running or stopping.

minimum0
starting: int

Number of instances whose runtime reports starting.

minimum0
summary: Optional[Literal["pending"]]

Present as pending until the first activity sweep completes; omitted afterward.

observability: Optional[CcDurableObjectApplicationObservability]

Application-wide logging settings for a Durable Object-managed application. The application publishes these settings to its runtime metadata. Updating them does not create a deployment or rollout.

logs: Optional[CcDurableObjectApplicationObservabilityLogs]

Application-wide logging settings.

enabled: Optional[bool]
ApplicationEditResponse

The public Containers API returns an application.

One of the following:
class CcScheduledApplication: …

Describes an application and the parameters that govern how it places its instances.

id: str

An Application ID represents an identifier of an application.

account_id: str

A unique identifier for the user’s account.

configuration: CcScheduledApplicationConfiguration

User-specified container configuration.

image: str

Image url.

authorized_keys: Optional[List[CcScheduledApplicationConfigurationAuthorizedKey]]
public_key: str

An SSH public key.

name: Optional[str]

Optional human readable name for this key.

command: Optional[List[str]]

The command that runs when the container starts, passed to the entrypoint. You can override this at run-time. If you override only the command, it gets passed to the default entrypoint specified in the image.

entrypoint: Optional[List[str]]

The entry point for the container, specifying the executable to run when the container starts. You can override this at run-time. If you do, the default command from the image is ignored. Specify both entrypoint and command at run-time to completely replace the image defaults.

environment_variables: Optional[List[CcScheduledApplicationConfigurationEnvironmentVariable]]

Container environment variables.

name: str

An environment variable name.

value: str

An environment variable value.

instance_type: Optional[Literal["lite", "basic", "standard-1", 3 more]]

The instance type configures vCPU, memory, and disk.

  • “lite”: 1/16 vCPU, 256 MiB memory, 2 GB disk
  • “basic”: 1/4 vCPU, 1 GiB memory, 4 GB disk
  • “standard-1”: 1/2 vCPU, 4 GiB memory, 8 GB disk
  • “standard-2”: 1 vCPU, 6 GiB memory, 12 GB disk
  • “standard-3”: 2 vCPU, 8 GiB memory, 16 GB disk
  • “standard-4”: 4 vCPU, 12 GiB memory, 20 GB disk
One of the following:
"lite"
"basic"
"standard-1"
"standard-2"
"standard-3"
"standard-4"
observability: Optional[CcScheduledApplicationConfigurationObservability]

Settings for deployment observability such as logging.

logs: Optional[CcScheduledApplicationConfigurationObservabilityLogs]

Observability logging settings.

enabled: Optional[bool]
created_at: str

UTC timestamp string in ISO 8601 format.

instances: int

Number of deployments to create.

name: str

The application name.

scheduling_policy: Literal["default", "durable_object"]

The scheduling policy to use for an application.

One of the following:
"default"
"durable_object"
updated_at: str

UTC timestamp string in ISO 8601 format.

version: int
active_rollout_id: Optional[str]

An identifier for a specific rollout within an application.

constraints: Optional[CcScheduledApplicationConstraints]
jurisdiction: Optional[str]

Restricts placement to datacenters in the selected jurisdiction. Choose “eu”, “fedramp”, or “us”. When combined with regions, EU supports EEUR and WEUR while FedRAMP and US support ENAM and WNAM.

regions: Optional[List[str]]
durable_objects: Optional[CcScheduledApplicationDurableObjects]

Durable object configuration stored on and returned from a Cloudchamber application.

namespace_id: str

The namespace ID of the durable object namespace to use for this application.

health: Optional[CcScheduledApplicationHealth]
errors: List[CcScheduledApplicationHealthError]
event: CcScheduledApplicationHealthErrorEvent

An event within a Placement or a Job.

id: str
details: Dict[str, object]
message: str
name: Literal["SchedulerPlaced", "NetworkingIPAssigned", "VMStarted", 14 more]

Name of the event that describes the kind event that happened.

  • SchedulerPlaced: It’s the first event that creates a container placement. It happens when the Containers runtime was able to retrieve deployment resources and start verifying everything is correct.
  • NetworkingIPAssigned: It’s sent when the Containers runtime maps the IP to the container.
  • VMStarted: It’s sent when the Containers runtime starts the VM. The container might remain unhealthy at this point.
  • ImagePulled: It’s sent when the Containers runtime pulls the image successfully.
  • ImagePullError: It’s sent when the Containers runtime is having issues pulling the image. The message and details have more information on what happened for debugging.
  • VMFailedToStart: It’s sent when the Containers runtime was unable to boot the VM.
  • VMStopping: It’s sent when the scheduler is stopping the VM.
  • VMStopped: It’s sent when the VM finally exits.
  • VMFailed: It’s sent when the scheduling of the VM failed in the current location.
  • RuntimeStartFailed: It’s sent when the runtime hits an internal error.
  • SSHStarted: It’s sent when the container gains network connectivity and opens the SSH port. Containers only send this event when SSH keys exist.
  • CheckUpdate: Sent when the status of a health or readiness check changes. This may also affect the health status of the placement.
  • DurableObjectConnected: Sent when a durable object instance connects and gains control of the deployment. This event is only sent for durable object deployments. It is sent after VMStarted.
  • ContainerStarted: It’s sent when the container starts running.
One of the following:
"SchedulerPlaced"
"NetworkingIPAssigned"
"VMStarted"
"ImagePulled"
"ImagePullError"
"VMFailedToStart"
"NetworkingIPAssignmentFailed"
"VMRunning"
"VMStopping"
"VMStopped"
"VMFailed"
"RuntimeStartFailed"
"SSHStarted"
"ServiceHealthUpdates"
"CheckUpdate"
"DurableObjectConnected"
"ContainerStarted"
status_change: Dict[str, object]
time: str

UTC timestamp string in ISO 8601 format.

type: Literal["Info", "Error", "Warn", 2 more]
One of the following:
"Info"
"Error"
"Warn"
"UserError"
"SystemError"
instance_id: str

An instance ID represents an identifier of an instance configuration that maintains an underlying placement.

instances: CcScheduledApplicationHealthInstances

Shows a count of application instance states.

active: int

Number of instances whose runtime reports the container as running (container_status = “running”). This is a subset of the placements that remain up: an instance that is already bound to a Durable Object and serving traffic is counted under “assigned” until its container_status catches up to “running”, so container_status can briefly lag Durable Object attachment under churn. To estimate running, Durable-Object-bound instances, sum “active” + “assigned” rather than reading “active” alone.

assigned: int

Number of instances bound to a Durable Object with a running placement whose container_status remains behind “running”. These count as live, serving instances; “active” + “assigned” approximates the running, Durable-Object-bound count.

summary: Optional[Literal["healthy", "degraded", "unhealthy", "pending"]]

High-level health assessment. Only populated for “new_instances” strategy. Based on a sample of target-version instances rather than a full count.

  • “pending”: Zero target-version instances exist yet.
  • “healthy”: Every sampled target-version instance reports running or active.
  • “degraded”: Some sampled instances remain starting or scheduling.
  • “unhealthy”: One or more sampled instances have failed.
One of the following:
"healthy"
"degraded"
"unhealthy"
"pending"
max_instances: Optional[int]

Maximum number of instances the application allows. This is relevant for applications that auto-scale.

observability: Optional[CcScheduledApplicationObservability]

Top-level observability settings for the application. This field is mutually exclusive with configuration.observability.

logs: Optional[CcScheduledApplicationObservabilityLogs]

Observability logging settings.

enabled: Optional[bool]
rollout_active_grace_period: Optional[int]

Grace period for active instances to stay alive before becoming eligible for shutdown signal due to a rollout, in seconds. Defaults to 0.

maximum604800
minimum0
class CcDurableObjectApplication: …

Each Durable Object creates and manages the lifecycle of its container instance.

id: str

An Application ID represents an identifier of an application.

account_id: str

A unique identifier for the user’s account.

created_at: str

UTC timestamp string in ISO 8601 format.

durable_objects: CcDurableObjectApplicationDurableObjects

Durable object configuration using a namespace ID.

namespace_id: str

The namespace ID of the durable object namespace to use for this application.

name: str

The application name.

scheduling_policy: Literal["durable_object"]

Selects a Durable Object-managed application. Each Durable Object creates and manages the lifecycle of its container instance. Configure application-wide observability settings here. Deployment configuration, scaling, placement constraints, versions, and rollouts do not apply.

updated_at: str

UTC timestamp string in ISO 8601 format.

configuration: Optional[CcDurableObjectApplicationConfiguration]

Application-wide settings for a Durable Object-managed application.

authorized_keys: Optional[List[CcDurableObjectApplicationConfigurationAuthorizedKey]]
public_key: str

An SSH public key.

name: Optional[str]

Optional human readable name for this key.

wrangler_ssh: Optional[CcDurableObjectApplicationConfigurationWranglerSSH]

Configuration properties for connecting with SSH to a container using Wrangler.

enabled: Optional[bool]
port: Optional[int]
maximum65535
minimum1
health: Optional[CcDurableObjectApplicationHealth]

Aggregate current activity for the latest observed placement of each instance. Runtime snapshots feed periodic background sweeps. Counts refresh after each complete sweep. Instance listings retain their separate three-month history for failure discovery.

instances: CcDurableObjectApplicationHealthInstances

Counts of observed non-terminal instances.

active: int

Number of instances whose runtime reports running or stopping.

minimum0
starting: int

Number of instances whose runtime reports starting.

minimum0
summary: Optional[Literal["pending"]]

Present as pending until the first activity sweep completes; omitted afterward.

observability: Optional[CcDurableObjectApplicationObservability]

Application-wide logging settings for a Durable Object-managed application. The application publishes these settings to its runtime metadata. Updating them does not create a deployment or rollout.

logs: Optional[CcDurableObjectApplicationObservabilityLogs]

Application-wide logging settings.

enabled: Optional[bool]
class ApplicationDeleteResponse: …

Result of starting asynchronous deletion for a Containers application.

message: str

ApplicationsInstances

List container instances (deprecated)
Deprecated
containers.applications.instances.list_v1(strapplication_id, InstanceListV1Params**kwargs) -> SyncContainersInstancesV1Pagination[InstanceListV1Response]
GET/accounts/{account_id}/containers/applications/{application_id}/instances
List container instances
containers.applications.instances.list(strapplication_id, InstanceListParams**kwargs) -> SyncPageTokenPagination[InstanceListResponse]
GET/accounts/{account_id}/containers/applications/{application_id}/instances-v2
Get a container instance
containers.applications.instances.get(strinstance_id, InstanceGetParams**kwargs) -> InstanceGetResponse
GET/accounts/{account_id}/containers/applications/{application_id}/instances/{instance_id}
ModelsExpand Collapse
class InstanceListV1Response: …

The last-reported state of a logical container instance.

id: str

A container instance ID (64-character hex Durable Object actor ID).

maxLength64
minLength64
application_id: str

An Application ID represents an identifier of an application.

image: str

The image for the current container placement, when one is available.

status: Status

The latest known status of a container instance.

state: Literal["provisioning", "running", "failed", 5 more]

The current lifecycle state of a container instance.

One of the following:
"provisioning"
"running"
"failed"
"stopping"
"stopped"
"unhealthy"
"inactive"
"unknown"
updated_at: str

UTC timestamp string in ISO 8601 format.

exit_code: Optional[int]

The process exit code, when the runtime reports one.

configuration: Optional[Configuration]

The resources allocated to the container instance.

disk: int

Disk allocated to the container instance, in decimal MB.

minimum1
memory: int

Memory allocated to the container instance, in MiB.

minimum1
vcpu: float

Number of virtual CPUs allocated to the container instance.

exclusiveMinimum
minimum0
location: Optional[Location]

The location of the instance’s current container placement.

name: str

Unique location code used to identify locations on a logical level.

region: str

Represents a group of datacenters. Choose one of “AFR”, “APAC”, “EEUR”, “ENAM”, “WNAM”, “ME”, “OC”, “SAM”, or “WEUR”.

name: Optional[str]

The customer-provided instance name, when available. Its UTF-8 encoding uses at most 1,024 bytes.

started_at: Optional[str]

The time at which the current container placement started, when one exists.

class InstanceListResponse: …

The last-reported state of a logical container instance.

id: str

A container instance ID (64-character hex Durable Object actor ID).

maxLength64
minLength64
application_id: str

An Application ID represents an identifier of an application.

image: str

The image for the current container placement, when one is available.

status: Status

The latest known status of a container instance.

state: Literal["provisioning", "running", "failed", 5 more]

The current lifecycle state of a container instance.

One of the following:
"provisioning"
"running"
"failed"
"stopping"
"stopped"
"unhealthy"
"inactive"
"unknown"
updated_at: str

UTC timestamp string in ISO 8601 format.

exit_code: Optional[int]

The process exit code, when the runtime reports one.

configuration: Optional[Configuration]

The resources allocated to the container instance.

disk: int

Disk allocated to the container instance, in decimal MB.

minimum1
memory: int

Memory allocated to the container instance, in MiB.

minimum1
vcpu: float

Number of virtual CPUs allocated to the container instance.

exclusiveMinimum
minimum0
location: Optional[Location]

The location of the instance’s current container placement.

name: str

Unique location code used to identify locations on a logical level.

region: str

Represents a group of datacenters. Choose one of “AFR”, “APAC”, “EEUR”, “ENAM”, “WNAM”, “ME”, “OC”, “SAM”, or “WEUR”.

name: Optional[str]

The customer-provided instance name, when available. Its UTF-8 encoding uses at most 1,024 bytes.

started_at: Optional[str]

The time at which the current container placement started, when one exists.

class InstanceGetResponse: …

The last-reported state of a logical container instance.

id: str

A container instance ID (64-character hex Durable Object actor ID).

maxLength64
minLength64
application_id: str

An Application ID represents an identifier of an application.

image: str

The image for the current container placement, when one is available.

status: Status

The latest known status of a container instance.

state: Literal["provisioning", "running", "failed", 5 more]

The current lifecycle state of a container instance.

One of the following:
"provisioning"
"running"
"failed"
"stopping"
"stopped"
"unhealthy"
"inactive"
"unknown"
updated_at: str

UTC timestamp string in ISO 8601 format.

exit_code: Optional[int]

The process exit code, when the runtime reports one.

configuration: Optional[Configuration]

The resources allocated to the container instance.

disk: int

Disk allocated to the container instance, in decimal MB.

minimum1
memory: int

Memory allocated to the container instance, in MiB.

minimum1
vcpu: float

Number of virtual CPUs allocated to the container instance.

exclusiveMinimum
minimum0
location: Optional[Location]

The location of the instance’s current container placement.

name: str

Unique location code used to identify locations on a logical level.

region: str

Represents a group of datacenters. Choose one of “AFR”, “APAC”, “EEUR”, “ENAM”, “WNAM”, “ME”, “OC”, “SAM”, or “WEUR”.

name: Optional[str]

The customer-provided instance name, when available. Its UTF-8 encoding uses at most 1,024 bytes.

started_at: Optional[str]

The time at which the current container placement started, when one exists.

ApplicationsRollouts

Create a new rollout for an application
containers.applications.rollouts.create(strapplication_id, RolloutCreateParams**kwargs) -> RolloutCreateResponse
POST/accounts/{account_id}/containers/applications/{application_id}/rollouts
ModelsExpand Collapse
class RolloutCreateResponse: …

Represents the status and metadata of a rollout process for an application. For “rolling” strategy: includes steps and progress with instance counts. For “new_instances” strategy: the response omits steps and progress. Use percentage, version_distribution, and health.summary for status.

id: str

An identifier for a specific rollout within an application.

created_at: str

UTC timestamp string in ISO 8601 format.

current_configuration: CurrentConfiguration

User-specified container configuration changes.

authorized_keys: Optional[List[CurrentConfigurationAuthorizedKey]]
public_key: str

An SSH public key.

name: Optional[str]

Optional human readable name for this key.

command: Optional[List[str]]

The command that runs when the container starts, passed to the entrypoint. You can override this at run-time. If you override only the command, it gets passed to the default entrypoint specified in the image.

entrypoint: Optional[List[str]]

The entry point for the container, specifying the executable to run when the container starts. You can override this at run-time. If you do, the default command from the image is ignored. Specify both entrypoint and command at run-time to completely replace the image defaults.

environment_variables: Optional[List[CurrentConfigurationEnvironmentVariable]]

Container environment variables.

name: str

An environment variable name.

value: str

An environment variable value.

image: Optional[str]

Image url.

instance_type: Optional[Literal["lite", "basic", "standard-1", 3 more]]

The instance type configures vCPU, memory, and disk.

  • “lite”: 1/16 vCPU, 256 MiB memory, 2 GB disk
  • “basic”: 1/4 vCPU, 1 GiB memory, 4 GB disk
  • “standard-1”: 1/2 vCPU, 4 GiB memory, 8 GB disk
  • “standard-2”: 1 vCPU, 6 GiB memory, 12 GB disk
  • “standard-3”: 2 vCPU, 8 GiB memory, 16 GB disk
  • “standard-4”: 4 vCPU, 12 GiB memory, 20 GB disk
One of the following:
"lite"
"basic"
"standard-1"
"standard-2"
"standard-3"
"standard-4"
observability: Optional[CurrentConfigurationObservability]

Settings for deployment observability such as logging.

logs: Optional[CurrentConfigurationObservabilityLogs]

Observability logging settings.

enabled: Optional[bool]
current_version: int

Current application version before the rollout.

description: str
health: Health
errors: List[HealthError]
event: HealthErrorEvent

An event within a Placement or a Job.

id: str
details: Dict[str, object]
message: str
name: Literal["SchedulerPlaced", "NetworkingIPAssigned", "VMStarted", 14 more]

Name of the event that describes the kind event that happened.

  • SchedulerPlaced: It’s the first event that creates a container placement. It happens when the Containers runtime was able to retrieve deployment resources and start verifying everything is correct.
  • NetworkingIPAssigned: It’s sent when the Containers runtime maps the IP to the container.
  • VMStarted: It’s sent when the Containers runtime starts the VM. The container might remain unhealthy at this point.
  • ImagePulled: It’s sent when the Containers runtime pulls the image successfully.
  • ImagePullError: It’s sent when the Containers runtime is having issues pulling the image. The message and details have more information on what happened for debugging.
  • VMFailedToStart: It’s sent when the Containers runtime was unable to boot the VM.
  • VMStopping: It’s sent when the scheduler is stopping the VM.
  • VMStopped: It’s sent when the VM finally exits.
  • VMFailed: It’s sent when the scheduling of the VM failed in the current location.
  • RuntimeStartFailed: It’s sent when the runtime hits an internal error.
  • SSHStarted: It’s sent when the container gains network connectivity and opens the SSH port. Containers only send this event when SSH keys exist.
  • CheckUpdate: Sent when the status of a health or readiness check changes. This may also affect the health status of the placement.
  • DurableObjectConnected: Sent when a durable object instance connects and gains control of the deployment. This event is only sent for durable object deployments. It is sent after VMStarted.
  • ContainerStarted: It’s sent when the container starts running.
One of the following:
"SchedulerPlaced"
"NetworkingIPAssigned"
"VMStarted"
"ImagePulled"
"ImagePullError"
"VMFailedToStart"
"NetworkingIPAssignmentFailed"
"VMRunning"
"VMStopping"
"VMStopped"
"VMFailed"
"RuntimeStartFailed"
"SSHStarted"
"ServiceHealthUpdates"
"CheckUpdate"
"DurableObjectConnected"
"ContainerStarted"
status_change: Dict[str, object]
time: str

UTC timestamp string in ISO 8601 format.

type: Literal["Info", "Error", "Warn", 2 more]
One of the following:
"Info"
"Error"
"Warn"
"UserError"
"SystemError"
instance_id: str

An instance ID represents an identifier of an instance configuration that maintains an underlying placement.

instances: HealthInstances

Shows a count of application instance states.

active: int

Number of instances whose runtime reports the container as running (container_status = “running”). This is a subset of the placements that remain up: an instance that is already bound to a Durable Object and serving traffic is counted under “assigned” until its container_status catches up to “running”, so container_status can briefly lag Durable Object attachment under churn. To estimate running, Durable-Object-bound instances, sum “active” + “assigned” rather than reading “active” alone.

assigned: int

Number of instances bound to a Durable Object with a running placement whose container_status remains behind “running”. These count as live, serving instances; “active” + “assigned” approximates the running, Durable-Object-bound count.

summary: Optional[Literal["healthy", "degraded", "unhealthy", "pending"]]

High-level health assessment. Only populated for “new_instances” strategy. Based on a sample of target-version instances rather than a full count.

  • “pending”: Zero target-version instances exist yet.
  • “healthy”: Every sampled target-version instance reports running or active.
  • “degraded”: Some sampled instances remain starting or scheduling.
  • “unhealthy”: One or more sampled instances have failed.
One of the following:
"healthy"
"degraded"
"unhealthy"
"pending"
kind: Literal["full_auto", "full_manual", "durable_objects_auto"]

Kind of the rollout process.

  • “full_auto”: For rolling rollouts, starts progressing steps upon rollout creation. For new_instances rollouts, advances percentage targets automatically after target-version health is observed.
  • “full_manual”: Requires manually progressing each step in the rollout using the UpdateRollout’s action paramater.
  • “durable_objects_auto”: Default when the application is a DO application.
One of the following:
"full_auto"
"full_manual"
"durable_objects_auto"
last_updated_at: str

Timestamp of the most recent update to status, health, or progress.

status: Literal["pending", "progressing", "completed", 2 more]

Current status of the rollout.

One of the following:
"pending"
"progressing"
"completed"
"reverted"
"replaced"
strategy: Literal["rolling", "new_instances"]

The rollout strategy.

  • “rolling”: Step-based rollout with health gates. Actively replaces instances to reach each step’s target percentage. Response includes steps and progress.
  • “new_instances”: Percentage control over version distribution. Version sync actively replaces instances to match the configured percentage. “full_auto” ramps through fixed percentage targets after target-version health is observed. Response includes percentage, version_distribution, and health.summary.
One of the following:
"rolling"
"new_instances"
target_configuration: TargetConfiguration

User-specified container configuration changes.

authorized_keys: Optional[List[TargetConfigurationAuthorizedKey]]
public_key: str

An SSH public key.

name: Optional[str]

Optional human readable name for this key.

command: Optional[List[str]]

The command that runs when the container starts, passed to the entrypoint. You can override this at run-time. If you override only the command, it gets passed to the default entrypoint specified in the image.

entrypoint: Optional[List[str]]

The entry point for the container, specifying the executable to run when the container starts. You can override this at run-time. If you do, the default command from the image is ignored. Specify both entrypoint and command at run-time to completely replace the image defaults.

environment_variables: Optional[List[TargetConfigurationEnvironmentVariable]]

Container environment variables.

name: str

An environment variable name.

value: str

An environment variable value.

image: Optional[str]

Image url.

instance_type: Optional[Literal["lite", "basic", "standard-1", 3 more]]

The instance type configures vCPU, memory, and disk.

  • “lite”: 1/16 vCPU, 256 MiB memory, 2 GB disk
  • “basic”: 1/4 vCPU, 1 GiB memory, 4 GB disk
  • “standard-1”: 1/2 vCPU, 4 GiB memory, 8 GB disk
  • “standard-2”: 1 vCPU, 6 GiB memory, 12 GB disk
  • “standard-3”: 2 vCPU, 8 GiB memory, 16 GB disk
  • “standard-4”: 4 vCPU, 12 GiB memory, 20 GB disk
One of the following:
"lite"
"basic"
"standard-1"
"standard-2"
"standard-3"
"standard-4"
observability: Optional[TargetConfigurationObservability]

Settings for deployment observability such as logging.

logs: Optional[TargetConfigurationObservabilityLogs]

Observability logging settings.

enabled: Optional[bool]
target_version: int

Target application version after the rollout is complete and applied to all current instances.

percentage: Optional[int]

Current target version percentage (0-100). Only present for “new_instances” strategy.

progress: Optional[Progress]

Progress details of an application rollout.

current_step: int

Current step being executed in the rollout process. Initialized to 0.

total_instances: int

Total number of instances the rollout affects.

total_steps: int

Total number of steps in the rollout.

updated_instances: int

Number of instances updated in the rollout process.

version_distribution: Optional[ProgressVersionDistribution]

Expected distribution of instances per version, based on the current percentage split. Populated during active rollouts. Values derive from the version percentage weights rather than actual running instance counts.

current_version_instances: Optional[int]

Expected number of instances remaining on the current (old) version based on the current percentage split. Only populated for “rolling” strategy.

current_version_percentage: Optional[int]

The percentage of new instances being scheduled on the current version (100 - target_version_percentage). Only populated for “new_instances” strategy.

target_version_instances: Optional[int]

Expected number of instances scheduled for the target (new) version based on the current percentage split. Only populated for “rolling” strategy.

target_version_percentage: Optional[int]

The active percentage of new instances being scheduled on the target version. For “rolling”, this reflects the step_size.percentage of the current active step. For “new_instances”, this reflects the user-set percentage.

started_at: Optional[datetime]

Timestamp when the rollout started.

formatdate-time
steps: Optional[List[Step]]
id: int

The sequential order of the rollout step, automatically assigned starting from 1, based on the total number of steps in the rollout process.

description: str

Description of the rollout step.

status: Literal["pending", "progressing", "reverting", 2 more]

Status of the rollout step.

One of the following:
"pending"
"progressing"
"reverting"
"completed"
"reverted"
step_size: StepStepSize
percentage: int

Percentage of instances affected in this step. Min 10% and Max 100%.

completed_at: Optional[str]

UTC timestamp string in ISO 8601 format.

reason: Optional[str]

Reason for the step’s current status.

started_at: Optional[str]

UTC timestamp string in ISO 8601 format.

version_distribution: Optional[VersionDistribution]

Version percentage distribution. Only present for “new_instances” strategy. For “rolling” strategy, see progress.version_distribution instead.

current_version_percentage: int

Percentage of instances on the current (old) version.

target_version_percentage: int

Percentage of instances on the target (new) version.

ApplicationsVersions

List all application versions
containers.applications.versions.list(strapplication_id, VersionListParams**kwargs) -> SyncSinglePage[VersionListResponse]
GET/accounts/{account_id}/containers/applications/{application_id}/versions
ModelsExpand Collapse
class VersionListResponse: …

An application with the configuration of its version.

configuration: Configuration

User-specified container configuration changes.

authorized_keys: Optional[List[ConfigurationAuthorizedKey]]
public_key: str

An SSH public key.

name: Optional[str]

Optional human readable name for this key.

command: Optional[List[str]]

The command that runs when the container starts, passed to the entrypoint. You can override this at run-time. If you override only the command, it gets passed to the default entrypoint specified in the image.

entrypoint: Optional[List[str]]

The entry point for the container, specifying the executable to run when the container starts. You can override this at run-time. If you do, the default command from the image is ignored. Specify both entrypoint and command at run-time to completely replace the image defaults.

environment_variables: Optional[List[ConfigurationEnvironmentVariable]]

Container environment variables.

name: str

An environment variable name.

value: str

An environment variable value.

image: Optional[str]

Image url.

instance_type: Optional[Literal["lite", "basic", "standard-1", 3 more]]

The instance type configures vCPU, memory, and disk.

  • “lite”: 1/16 vCPU, 256 MiB memory, 2 GB disk
  • “basic”: 1/4 vCPU, 1 GiB memory, 4 GB disk
  • “standard-1”: 1/2 vCPU, 4 GiB memory, 8 GB disk
  • “standard-2”: 1 vCPU, 6 GiB memory, 12 GB disk
  • “standard-3”: 2 vCPU, 8 GiB memory, 16 GB disk
  • “standard-4”: 4 vCPU, 12 GiB memory, 20 GB disk
One of the following:
"lite"
"basic"
"standard-1"
"standard-2"
"standard-3"
"standard-4"
observability: Optional[ConfigurationObservability]

Settings for deployment observability such as logging.

logs: Optional[ConfigurationObservabilityLogs]

Observability logging settings.

enabled: Optional[bool]
percentage: int
version: int