--- title: Containers --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Containers #### ContainersApplications ##### [List Applications associated with your account](https://developers.cloudflare.com/api/typescript/resources/containers/subresources/applications/methods/list) client.containers.applications.list(ApplicationListParams {account\_id, image, name, 2 more } params, RequestOptionsoptions?): PageTokenPagination< [ApplicationListResponse]()> GET/accounts/{account\_id}/containers/applications ##### [Create a new application](https://developers.cloudflare.com/api/typescript/resources/containers/subresources/applications/methods/create) client.containers.applications.create(ApplicationCreateParamsparams, RequestOptionsoptions?): [ApplicationCreateResponse]() POST/accounts/{account\_id}/containers/applications ##### [Get a single application by id](https://developers.cloudflare.com/api/typescript/resources/containers/subresources/applications/methods/get) client.containers.applications.get(stringapplicationID, ApplicationGetParams {account\_id } params, RequestOptionsoptions?): [ApplicationGetResponse]() GET/accounts/{account\_id}/containers/applications/{application\_id} ##### [Modify an application](https://developers.cloudflare.com/api/typescript/resources/containers/subresources/applications/methods/edit) client.containers.applications.edit(stringapplicationID, ApplicationEditParams {account\_id, configuration, constraints, 3 more } params, RequestOptionsoptions?): [ApplicationEditResponse]() PATCH/accounts/{account\_id}/containers/applications/{application\_id} ##### [Delete a single application by id](https://developers.cloudflare.com/api/typescript/resources/containers/subresources/applications/methods/delete) client.containers.applications.delete(stringapplicationID, ApplicationDeleteParams {account\_id } params, RequestOptionsoptions?): [ApplicationDeleteResponse]() {message } DELETE/accounts/{account\_id}/containers/applications/{application\_id} ##### ModelsExpand Collapse

ApplicationListResponse = CcScheduledApplication {id, account\_id, configuration, 13 more } | CcDurableObjectApplication {id, account\_id, created\_at, 7 more } The public Containers API returns an application.

One of the following:

CcScheduledApplication {id, account\_id, configuration, 13 more } Describes an application and the parameters that govern how it places its instances.

id: string An Application ID represents an identifier of an application. Link to this property account\_id: string A unique identifier for the user’s account. Link to this property

configuration: Configuration {image, authorized\_keys, command, 4 more } User-specified container configuration.

image: string Image url. Link to this property

authorized\_keys?: Array<AuthorizedKey>

public\_key: string An SSH public key. Link to this property name?: string Optional human readable name for this key. Link to this property

Link to this property command?: Array<string> 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. Link to this property entrypoint?: Array<string> 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. Link to this property

environment\_variables?: Array<EnvironmentVariable> Container environment variables.

name: string An environment variable name. Link to this property value: string An environment variable value. Link to this property

Link to this property

instance\_type?: "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" Link to this property "basic" Link to this property "standard-1" Link to this property "standard-2" Link to this property "standard-3" Link to this property "standard-4" Link to this property

Link to this property

observability?: Observability {logs } Settings for deployment observability such as logging.

logs?: Logs {enabled } Observability logging settings.

enabled?: boolean Link to this property

Link to this property

Link to this property created\_at: string UTC timestamp string in ISO 8601 format. Link to this property instances: number Number of deployments to create. Link to this property name: string The application name. Link to this property

scheduling\_policy: "default"| "durable\_object" The scheduling policy to use for an application.

One of the following: "default" Link to this property "durable\_object" Link to this property

Link to this property updated\_at: string UTC timestamp string in ISO 8601 format. Link to this property version: number Link to this property active\_rollout\_id?: string An identifier for a specific rollout within an application. Link to this property

constraints?: Constraints {jurisdiction, regions }

jurisdiction?: string 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. Link to this property regions?: Array<string> Link to this property

Link to this property

durable\_objects?: DurableObjects {namespace\_id } Durable object configuration stored on and returned from a Cloudchamber application.

namespace\_id: string The namespace ID of the durable object namespace to use for this application. Link to this property

Link to this property

health?: Health {errors, instances, summary }

errors: Array<Error>

event: Event {id, details, message, 4 more } An event within a Placement or a Job.

id: string Link to this property details: Record<string, unknown> Link to this property message: string Link to this property

name: "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" Link to this property "NetworkingIPAssigned" Link to this property "VMStarted" Link to this property "ImagePulled" Link to this property "ImagePullError" Link to this property "VMFailedToStart" Link to this property "NetworkingIPAssignmentFailed" Link to this property "VMRunning" Link to this property "VMStopping" Link to this property "VMStopped" Link to this property "VMFailed" Link to this property "RuntimeStartFailed" Link to this property "SSHStarted" Link to this property "ServiceHealthUpdates" Link to this property "CheckUpdate" Link to this property "DurableObjectConnected" Link to this property "ContainerStarted" Link to this property

Link to this property statusChange: Record<string, unknown> Link to this property time: string UTC timestamp string in ISO 8601 format. Link to this property

type: "Info"| "Error"| "Warn"| 2 more

One of the following: "Info" Link to this property "Error" Link to this property "Warn" Link to this property "UserError" Link to this property "SystemError" Link to this property

Link to this property

Link to this property instance\_id: string An instance ID represents an identifier of an instance configuration that maintains an underlying placement. Link to this property

Link to this property

instances: Instances {active, assigned } Shows a count of application instance states.

active: number 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. Link to this property assigned: number 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. Link to this property

Link to this property

summary?: "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" Link to this property "degraded" Link to this property "unhealthy" Link to this property "pending" Link to this property

Link to this property

Link to this property max\_instances?: number Maximum number of instances the application allows. This is relevant for applications that auto-scale. Link to this property

observability?: Observability {logs } Top-level observability settings for the application. This field is mutually exclusive with configuration.observability.

logs?: Logs {enabled } Observability logging settings.

enabled?: boolean Link to this property

Link to this property

Link to this property rollout\_active\_grace\_period?: number 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 Link to this property

Link to this property

CcDurableObjectApplication {id, account\_id, created\_at, 7 more } Each Durable Object creates and manages the lifecycle of its container instance.

id: string An Application ID represents an identifier of an application. Link to this property account\_id: string A unique identifier for the user’s account. Link to this property created\_at: string UTC timestamp string in ISO 8601 format. Link to this property

durable\_objects: DurableObjects {namespace\_id } Durable object configuration using a namespace ID.

namespace\_id: string The namespace ID of the durable object namespace to use for this application. Link to this property

Link to this property name: string The application name. Link to this property scheduling\_policy: "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. Link to this property updated\_at: string UTC timestamp string in ISO 8601 format. Link to this property

configuration?: Configuration {authorized\_keys, wrangler\_ssh } Application-wide settings for a Durable Object-managed application.

authorized\_keys?: Array<AuthorizedKey>

public\_key: string An SSH public key. Link to this property name?: string Optional human readable name for this key. Link to this property

Link to this property

wrangler\_ssh?: WranglerSSH {enabled, port } Configuration properties for connecting with SSH to a container using Wrangler.

enabled?: boolean Link to this property port?: number maximum65535 minimum1 Link to this property

Link to this property

health?: Health {instances, summary } 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: Instances {active, starting } Counts of observed non-terminal instances.

active: number Number of instances whose runtime reports running or stopping. minimum0 Link to this property starting: number Number of instances whose runtime reports starting. minimum0 Link to this property

Link to this property summary?: "pending" Present as pending until the first activity sweep completes; omitted afterward. Link to this property

Link to this property

observability?: Observability {logs } 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?: Logs {enabled } Application-wide logging settings.

enabled?: boolean Link to this property

Link to this property

[Link to this property](<#(resource)%20containers.applications%20%3E%20(model)%20application_list_response%20%3E%20(schema)>)

ApplicationCreateResponse = CcScheduledApplication {id, account\_id, configuration, 13 more } | CcDurableObjectApplication {id, account\_id, created\_at, 7 more } The public Containers API returns an application.

One of the following:

CcScheduledApplication {id, account\_id, configuration, 13 more } Describes an application and the parameters that govern how it places its instances.

id: string An Application ID represents an identifier of an application. Link to this property account\_id: string A unique identifier for the user’s account. Link to this property

configuration: Configuration {image, authorized\_keys, command, 4 more } User-specified container configuration.

image: string Image url. Link to this property

authorized\_keys?: Array<AuthorizedKey>

public\_key: string An SSH public key. Link to this property name?: string Optional human readable name for this key. Link to this property

environment\_variables?: Array<EnvironmentVariable> Container environment variables.

name: string An environment variable name. Link to this property value: string An environment variable value. Link to this property

Link to this property

observability?: Observability {logs } Settings for deployment observability such as logging.

logs?: Logs {enabled } Observability logging settings.

enabled?: boolean Link to this property

Link to this property

scheduling\_policy: "default"| "durable\_object" The scheduling policy to use for an application.

One of the following: "default" Link to this property "durable\_object" Link to this property

constraints?: Constraints {jurisdiction, regions }

Link to this property

durable\_objects?: DurableObjects {namespace\_id } Durable object configuration stored on and returned from a Cloudchamber application.

namespace\_id: string The namespace ID of the durable object namespace to use for this application. Link to this property

Link to this property

health?: Health {errors, instances, summary }

errors: Array<Error>

event: Event {id, details, message, 4 more } An event within a Placement or a Job.

id: string Link to this property details: Record<string, unknown> Link to this property message: string Link to this property

Link to this property statusChange: Record<string, unknown> Link to this property time: string UTC timestamp string in ISO 8601 format. Link to this property

type: "Info"| "Error"| "Warn"| 2 more

One of the following: "Info" Link to this property "Error" Link to this property "Warn" Link to this property "UserError" Link to this property "SystemError" Link to this property

Link to this property

Link to this property instance\_id: string An instance ID represents an identifier of an instance configuration that maintains an underlying placement. Link to this property

Link to this property

instances: Instances {active, assigned } Shows a count of application instance states.

Link to this property

One of the following: "healthy" Link to this property "degraded" Link to this property "unhealthy" Link to this property "pending" Link to this property

Link to this property

Link to this property max\_instances?: number Maximum number of instances the application allows. This is relevant for applications that auto-scale. Link to this property

observability?: Observability {logs } Top-level observability settings for the application. This field is mutually exclusive with configuration.observability.

logs?: Logs {enabled } Observability logging settings.

enabled?: boolean Link to this property

Link to this property

CcDurableObjectApplication {id, account\_id, created\_at, 7 more } Each Durable Object creates and manages the lifecycle of its container instance.

durable\_objects: DurableObjects {namespace\_id } Durable object configuration using a namespace ID.

namespace\_id: string The namespace ID of the durable object namespace to use for this application. Link to this property

configuration?: Configuration {authorized\_keys, wrangler\_ssh } Application-wide settings for a Durable Object-managed application.

authorized\_keys?: Array<AuthorizedKey>

public\_key: string An SSH public key. Link to this property name?: string Optional human readable name for this key. Link to this property

Link to this property

wrangler\_ssh?: WranglerSSH {enabled, port } Configuration properties for connecting with SSH to a container using Wrangler.

enabled?: boolean Link to this property port?: number maximum65535 minimum1 Link to this property

Link to this property

instances: Instances {active, starting } Counts of observed non-terminal instances.

Link to this property summary?: "pending" Present as pending until the first activity sweep completes; omitted afterward. Link to this property

Link to this property

logs?: Logs {enabled } Application-wide logging settings.

enabled?: boolean Link to this property

Link to this property

[Link to this property](<#(resource)%20containers.applications%20%3E%20(model)%20application_create_response%20%3E%20(schema)>)

ApplicationGetResponse = CcScheduledApplication {id, account\_id, configuration, 13 more } | CcDurableObjectApplication {id, account\_id, created\_at, 7 more } The public Containers API returns an application.

One of the following:

CcScheduledApplication {id, account\_id, configuration, 13 more } Describes an application and the parameters that govern how it places its instances.

id: string An Application ID represents an identifier of an application. Link to this property account\_id: string A unique identifier for the user’s account. Link to this property

configuration: Configuration {image, authorized\_keys, command, 4 more } User-specified container configuration.

image: string Image url. Link to this property

authorized\_keys?: Array<AuthorizedKey>

public\_key: string An SSH public key. Link to this property name?: string Optional human readable name for this key. Link to this property

environment\_variables?: Array<EnvironmentVariable> Container environment variables.

name: string An environment variable name. Link to this property value: string An environment variable value. Link to this property

Link to this property

observability?: Observability {logs } Settings for deployment observability such as logging.

logs?: Logs {enabled } Observability logging settings.

enabled?: boolean Link to this property

Link to this property

scheduling\_policy: "default"| "durable\_object" The scheduling policy to use for an application.

One of the following: "default" Link to this property "durable\_object" Link to this property

constraints?: Constraints {jurisdiction, regions }

Link to this property

durable\_objects?: DurableObjects {namespace\_id } Durable object configuration stored on and returned from a Cloudchamber application.

namespace\_id: string The namespace ID of the durable object namespace to use for this application. Link to this property

Link to this property

health?: Health {errors, instances, summary }

errors: Array<Error>

event: Event {id, details, message, 4 more } An event within a Placement or a Job.

id: string Link to this property details: Record<string, unknown> Link to this property message: string Link to this property

Link to this property statusChange: Record<string, unknown> Link to this property time: string UTC timestamp string in ISO 8601 format. Link to this property

type: "Info"| "Error"| "Warn"| 2 more

One of the following: "Info" Link to this property "Error" Link to this property "Warn" Link to this property "UserError" Link to this property "SystemError" Link to this property

Link to this property

Link to this property instance\_id: string An instance ID represents an identifier of an instance configuration that maintains an underlying placement. Link to this property

Link to this property

instances: Instances {active, assigned } Shows a count of application instance states.

Link to this property

One of the following: "healthy" Link to this property "degraded" Link to this property "unhealthy" Link to this property "pending" Link to this property

Link to this property

Link to this property max\_instances?: number Maximum number of instances the application allows. This is relevant for applications that auto-scale. Link to this property

observability?: Observability {logs } Top-level observability settings for the application. This field is mutually exclusive with configuration.observability.

logs?: Logs {enabled } Observability logging settings.

enabled?: boolean Link to this property

Link to this property

CcDurableObjectApplication {id, account\_id, created\_at, 7 more } Each Durable Object creates and manages the lifecycle of its container instance.

durable\_objects: DurableObjects {namespace\_id } Durable object configuration using a namespace ID.

namespace\_id: string The namespace ID of the durable object namespace to use for this application. Link to this property

configuration?: Configuration {authorized\_keys, wrangler\_ssh } Application-wide settings for a Durable Object-managed application.

authorized\_keys?: Array<AuthorizedKey>

public\_key: string An SSH public key. Link to this property name?: string Optional human readable name for this key. Link to this property

Link to this property

wrangler\_ssh?: WranglerSSH {enabled, port } Configuration properties for connecting with SSH to a container using Wrangler.

enabled?: boolean Link to this property port?: number maximum65535 minimum1 Link to this property

Link to this property

instances: Instances {active, starting } Counts of observed non-terminal instances.

Link to this property summary?: "pending" Present as pending until the first activity sweep completes; omitted afterward. Link to this property

Link to this property

logs?: Logs {enabled } Application-wide logging settings.

enabled?: boolean Link to this property

Link to this property

[Link to this property](<#(resource)%20containers.applications%20%3E%20(model)%20application_get_response%20%3E%20(schema)>)

ApplicationEditResponse = CcScheduledApplication {id, account\_id, configuration, 13 more } | CcDurableObjectApplication {id, account\_id, created\_at, 7 more } The public Containers API returns an application.

One of the following:

CcScheduledApplication {id, account\_id, configuration, 13 more } Describes an application and the parameters that govern how it places its instances.

id: string An Application ID represents an identifier of an application. Link to this property account\_id: string A unique identifier for the user’s account. Link to this property

configuration: Configuration {image, authorized\_keys, command, 4 more } User-specified container configuration.

image: string Image url. Link to this property

authorized\_keys?: Array<AuthorizedKey>

public\_key: string An SSH public key. Link to this property name?: string Optional human readable name for this key. Link to this property

environment\_variables?: Array<EnvironmentVariable> Container environment variables.

name: string An environment variable name. Link to this property value: string An environment variable value. Link to this property

Link to this property

observability?: Observability {logs } Settings for deployment observability such as logging.

logs?: Logs {enabled } Observability logging settings.

enabled?: boolean Link to this property

Link to this property

scheduling\_policy: "default"| "durable\_object" The scheduling policy to use for an application.

One of the following: "default" Link to this property "durable\_object" Link to this property

constraints?: Constraints {jurisdiction, regions }

Link to this property

durable\_objects?: DurableObjects {namespace\_id } Durable object configuration stored on and returned from a Cloudchamber application.

namespace\_id: string The namespace ID of the durable object namespace to use for this application. Link to this property

Link to this property

health?: Health {errors, instances, summary }

errors: Array<Error>

event: Event {id, details, message, 4 more } An event within a Placement or a Job.

id: string Link to this property details: Record<string, unknown> Link to this property message: string Link to this property

Link to this property statusChange: Record<string, unknown> Link to this property time: string UTC timestamp string in ISO 8601 format. Link to this property

type: "Info"| "Error"| "Warn"| 2 more

One of the following: "Info" Link to this property "Error" Link to this property "Warn" Link to this property "UserError" Link to this property "SystemError" Link to this property

Link to this property

Link to this property instance\_id: string An instance ID represents an identifier of an instance configuration that maintains an underlying placement. Link to this property

Link to this property

instances: Instances {active, assigned } Shows a count of application instance states.

Link to this property

One of the following: "healthy" Link to this property "degraded" Link to this property "unhealthy" Link to this property "pending" Link to this property

Link to this property

Link to this property max\_instances?: number Maximum number of instances the application allows. This is relevant for applications that auto-scale. Link to this property

observability?: Observability {logs } Top-level observability settings for the application. This field is mutually exclusive with configuration.observability.

logs?: Logs {enabled } Observability logging settings.

enabled?: boolean Link to this property

Link to this property

CcDurableObjectApplication {id, account\_id, created\_at, 7 more } Each Durable Object creates and manages the lifecycle of its container instance.

durable\_objects: DurableObjects {namespace\_id } Durable object configuration using a namespace ID.

namespace\_id: string The namespace ID of the durable object namespace to use for this application. Link to this property

configuration?: Configuration {authorized\_keys, wrangler\_ssh } Application-wide settings for a Durable Object-managed application.

authorized\_keys?: Array<AuthorizedKey>

public\_key: string An SSH public key. Link to this property name?: string Optional human readable name for this key. Link to this property

Link to this property

wrangler\_ssh?: WranglerSSH {enabled, port } Configuration properties for connecting with SSH to a container using Wrangler.

enabled?: boolean Link to this property port?: number maximum65535 minimum1 Link to this property

Link to this property

instances: Instances {active, starting } Counts of observed non-terminal instances.

Link to this property summary?: "pending" Present as pending until the first activity sweep completes; omitted afterward. Link to this property

Link to this property

logs?: Logs {enabled } Application-wide logging settings.

enabled?: boolean Link to this property

Link to this property

[Link to this property](<#(resource)%20containers.applications%20%3E%20(model)%20application_edit_response%20%3E%20(schema)>)

ApplicationDeleteResponse {message } Result of starting asynchronous deletion for a Containers application.

message: string Link to this property

[Link to this property](<#(resource)%20containers.applications%20%3E%20(model)%20application_delete_response%20%3E%20(schema)>) #### ContainersApplicationsInstances ##### [List container instances (deprecated)](https://developers.cloudflare.com/api/typescript/resources/containers/subresources/applications/subresources/instances/methods/list_v1) Deprecated client.containers.applications.instances.listV1(stringapplicationID, InstanceListV1Params {account\_id, name\_prefix, page\_token, 2 more } params, RequestOptionsoptions?): ContainersInstancesV1Pagination< [InstanceListV1Response]() {id, application\_id, image, 5 more } > GET/accounts/{account\_id}/containers/applications/{application\_id}/instances ##### [List container instances](https://developers.cloudflare.com/api/typescript/resources/containers/subresources/applications/subresources/instances/methods/list) client.containers.applications.instances.list(stringapplicationID, InstanceListParams {account\_id, name\_prefix, page\_token, 2 more } params, RequestOptionsoptions?): PageTokenPagination< [InstanceListResponse]() {id, application\_id, image, 5 more } > GET/accounts/{account\_id}/containers/applications/{application\_id}/instances-v2 ##### [Get a container instance](https://developers.cloudflare.com/api/typescript/resources/containers/subresources/applications/subresources/instances/methods/get) client.containers.applications.instances.get(stringinstanceID, InstanceGetParams {account\_id, application\_id } params, RequestOptionsoptions?): [InstanceGetResponse]() {id, application\_id, image, 5 more } GET/accounts/{account\_id}/containers/applications/{application\_id}/instances/{instance\_id} ##### ModelsExpand Collapse

InstanceListV1Response {id, application\_id, image, 5 more } The last-reported state of a logical container instance.

id: string A container instance ID (64-character hex Durable Object actor ID). maxLength64 minLength64 Link to this property application\_id: string An Application ID represents an identifier of an application. Link to this property image: string The image for the current container placement, when one is available. Link to this property

status: Status {state, updated\_at, exit\_code } The latest known status of a container instance.

state: "provisioning"| "running"| "failed"| 5 more The current lifecycle state of a container instance.

One of the following: "provisioning" Link to this property "running" Link to this property "failed" Link to this property "stopping" Link to this property "stopped" Link to this property "unhealthy" Link to this property "inactive" Link to this property "unknown" Link to this property

Link to this property updated\_at: string UTC timestamp string in ISO 8601 format. Link to this property exit\_code?: number The process exit code, when the runtime reports one. Link to this property

Link to this property

configuration?: Configuration {disk, memory, vcpu } The resources allocated to the container instance.

disk: number Disk allocated to the container instance, in decimal MB. minimum1 Link to this property memory: number Memory allocated to the container instance, in MiB. minimum1 Link to this property vcpu: number Number of virtual CPUs allocated to the container instance. exclusiveMinimum minimum0 Link to this property

Link to this property

location?: Location {name, region } The location of the instance’s current container placement.

name: string Unique location code used to identify locations on a logical level. Link to this property region: string Represents a group of datacenters. Choose one of “AFR”, “APAC”, “EEUR”, “ENAM”, “WNAM”, “ME”, “OC”, “SAM”, or “WEUR”. Link to this property

Link to this property name?: string The customer-provided instance name, when available. Its UTF-8 encoding uses at most 1,024 bytes. Link to this property started\_at?: string The time at which the current container placement started, when one exists. Link to this property

[Link to this property](<#(resource)%20containers.applications.instances%20%3E%20(model)%20instance_list_v1_response%20%3E%20(schema)>)

InstanceListResponse {id, application\_id, image, 5 more } The last-reported state of a logical container instance.

status: Status {state, updated\_at, exit\_code } The latest known status of a container instance.

state: "provisioning"| "running"| "failed"| 5 more The current lifecycle state of a container instance.

Link to this property updated\_at: string UTC timestamp string in ISO 8601 format. Link to this property exit\_code?: number The process exit code, when the runtime reports one. Link to this property

Link to this property

configuration?: Configuration {disk, memory, vcpu } The resources allocated to the container instance.

Link to this property

location?: Location {name, region } The location of the instance’s current container placement.

[Link to this property](<#(resource)%20containers.applications.instances%20%3E%20(model)%20instance_list_response%20%3E%20(schema)>)

InstanceGetResponse {id, application\_id, image, 5 more } The last-reported state of a logical container instance.

status: Status {state, updated\_at, exit\_code } The latest known status of a container instance.

state: "provisioning"| "running"| "failed"| 5 more The current lifecycle state of a container instance.

Link to this property updated\_at: string UTC timestamp string in ISO 8601 format. Link to this property exit\_code?: number The process exit code, when the runtime reports one. Link to this property

Link to this property

configuration?: Configuration {disk, memory, vcpu } The resources allocated to the container instance.

Link to this property

location?: Location {name, region } The location of the instance’s current container placement.

[Link to this property](<#(resource)%20containers.applications.instances%20%3E%20(model)%20instance_get_response%20%3E%20(schema)>) #### ContainersApplicationsRollouts ##### [Create a new rollout for an application](https://developers.cloudflare.com/api/typescript/resources/containers/subresources/applications/subresources/rollouts/methods/create) client.containers.applications.rollouts.create(stringapplicationID, RolloutCreateParams {account\_id, description, strategy, 5 more } params, RequestOptionsoptions?): [RolloutCreateResponse]() {id, created\_at, current\_configuration, 14 more } POST/accounts/{account\_id}/containers/applications/{application\_id}/rollouts ##### ModelsExpand Collapse

RolloutCreateResponse {id, created\_at, current\_configuration, 14 more } 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: string An identifier for a specific rollout within an application. Link to this property created\_at: string UTC timestamp string in ISO 8601 format. Link to this property

current\_configuration: CurrentConfiguration {authorized\_keys, command, entrypoint, 4 more } User-specified container configuration changes.

authorized\_keys?: Array<AuthorizedKey>

public\_key: string An SSH public key. Link to this property name?: string Optional human readable name for this key. Link to this property

environment\_variables?: Array<EnvironmentVariable> Container environment variables.

name: string An environment variable name. Link to this property value: string An environment variable value. Link to this property

Link to this property image?: string Image url. Link to this property

Link to this property

observability?: Observability {logs } Settings for deployment observability such as logging.

logs?: Logs {enabled } Observability logging settings.

enabled?: boolean Link to this property

Link to this property

Link to this property current\_version: number Current application version before the rollout. Link to this property description: string Link to this property

health: Health {errors, instances, summary }

errors: Array<Error>

event: Event {id, details, message, 4 more } An event within a Placement or a Job.

id: string Link to this property details: Record<string, unknown> Link to this property message: string Link to this property

Link to this property statusChange: Record<string, unknown> Link to this property time: string UTC timestamp string in ISO 8601 format. Link to this property

type: "Info"| "Error"| "Warn"| 2 more

One of the following: "Info" Link to this property "Error" Link to this property "Warn" Link to this property "UserError" Link to this property "SystemError" Link to this property

Link to this property

Link to this property instance\_id: string An instance ID represents an identifier of an instance configuration that maintains an underlying placement. Link to this property

Link to this property

instances: Instances {active, assigned } Shows a count of application instance states.

Link to this property

One of the following: "healthy" Link to this property "degraded" Link to this property "unhealthy" Link to this property "pending" Link to this property

Link to this property

kind: "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" Link to this property "full\_manual" Link to this property "durable\_objects\_auto" Link to this property

Link to this property last\_updated\_at: string Timestamp of the most recent update to status, health, or progress. Link to this property

status: "pending"| "progressing"| "completed"| 2 more Current status of the rollout.

One of the following: "pending" Link to this property "progressing" Link to this property "completed" Link to this property "reverted" Link to this property "replaced" Link to this property

Link to this property

strategy: "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" Link to this property "new\_instances" Link to this property

Link to this property

target\_configuration: TargetConfiguration {authorized\_keys, command, entrypoint, 4 more } User-specified container configuration changes.

authorized\_keys?: Array<AuthorizedKey>

public\_key: string An SSH public key. Link to this property name?: string Optional human readable name for this key. Link to this property

environment\_variables?: Array<EnvironmentVariable> Container environment variables.

name: string An environment variable name. Link to this property value: string An environment variable value. Link to this property

Link to this property image?: string Image url. Link to this property

Link to this property

observability?: Observability {logs } Settings for deployment observability such as logging.

logs?: Logs {enabled } Observability logging settings.

enabled?: boolean Link to this property

Link to this property

Link to this property target\_version: number Target application version after the rollout is complete and applied to all current instances. Link to this property percentage?: number Current target version percentage (0-100). Only present for “new\_instances” strategy. Link to this property

progress?: Progress {current\_step, total\_instances, total\_steps, 2 more } Progress details of an application rollout.

current\_step: number Current step being executed in the rollout process. Initialized to 0. Link to this property total\_instances: number Total number of instances the rollout affects. Link to this property total\_steps: number Total number of steps in the rollout. Link to this property updated\_instances: number Number of instances updated in the rollout process. Link to this property

version\_distribution?: VersionDistribution {current\_version\_instances, current\_version\_percentage, target\_version\_instances, target\_version\_percentage } 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?: number Expected number of instances remaining on the current (old) version based on the current percentage split. Only populated for “rolling” strategy. Link to this property current\_version\_percentage?: number The percentage of new instances being scheduled on the current version (100 - target\_version\_percentage). Only populated for “new\_instances” strategy. Link to this property target\_version\_instances?: number Expected number of instances scheduled for the target (new) version based on the current percentage split. Only populated for “rolling” strategy. Link to this property target\_version\_percentage?: number 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. Link to this property

Link to this property

Link to this property started\_at?: string Timestamp when the rollout started. formatdate-time Link to this property

steps?: Array<Step>

id: number The sequential order of the rollout step, automatically assigned starting from 1, based on the total number of steps in the rollout process. Link to this property description: string Description of the rollout step. Link to this property

status: "pending"| "progressing"| "reverting"| 2 more Status of the rollout step.

One of the following: "pending" Link to this property "progressing" Link to this property "reverting" Link to this property "completed" Link to this property "reverted" Link to this property

Link to this property

step\_size: StepSize {percentage }

percentage: number Percentage of instances affected in this step. Min 10% and Max 100%. Link to this property

Link to this property completed\_at?: string UTC timestamp string in ISO 8601 format. Link to this property reason?: string Reason for the step’s current status. Link to this property started\_at?: string UTC timestamp string in ISO 8601 format. Link to this property

Link to this property

version\_distribution?: VersionDistribution {current\_version\_percentage, target\_version\_percentage } Version percentage distribution. Only present for “new\_instances” strategy. For “rolling” strategy, see progress.version\_distribution instead.

current\_version\_percentage: number Percentage of instances on the current (old) version. Link to this property target\_version\_percentage: number Percentage of instances on the target (new) version. Link to this property

Link to this property

[Link to this property](<#(resource)%20containers.applications.rollouts%20%3E%20(model)%20rollout_create_response%20%3E%20(schema)>) #### ContainersApplicationsVersions ##### [List all application versions](https://developers.cloudflare.com/api/typescript/resources/containers/subresources/applications/subresources/versions/methods/list) client.containers.applications.versions.list(stringapplicationID, VersionListParams {account\_id } params, RequestOptionsoptions?): SinglePage< [VersionListResponse]() {configuration, percentage, version } > GET/accounts/{account\_id}/containers/applications/{application\_id}/versions ##### ModelsExpand Collapse

VersionListResponse {configuration, percentage, version } An application with the configuration of its version.

configuration: Configuration {authorized\_keys, command, entrypoint, 4 more } User-specified container configuration changes.

authorized\_keys?: Array<AuthorizedKey>

public\_key: string An SSH public key. Link to this property name?: string Optional human readable name for this key. Link to this property

environment\_variables?: Array<EnvironmentVariable> Container environment variables.

name: string An environment variable name. Link to this property value: string An environment variable value. Link to this property

Link to this property image?: string Image url. Link to this property

Link to this property

observability?: Observability {logs } Settings for deployment observability such as logging.

logs?: Logs {enabled } Observability logging settings.

enabled?: boolean Link to this property

Link to this property

Link to this property percentage: number Link to this property version: number Link to this property

[Link to this property](<#(resource)%20containers.applications.versions%20%3E%20(model)%20version_list_response%20%3E%20(schema)>) #### ContainersImages ##### [Prepare a container image](https://developers.cloudflare.com/api/typescript/resources/containers/subresources/images/methods/prepare) client.containers.images.prepare(ImagePrepareParams {account\_id, image } params, RequestOptionsoptions?): [ImagePrepareResponse]() {image, status, artifact\_digest, reason } POST/accounts/{account\_id}/containers/image-preparations ##### ModelsExpand Collapse

ImagePrepareResponse {image, status, artifact\_digest, reason } Durable preparation state for a container image.

image: string Image url. Link to this property

status: "pending"| "ready"| "error" Current durable preparation state for a container image.

One of the following: "pending" Link to this property "ready" Link to this property "error" Link to this property

Link to this property artifact\_digest?: string Digest of the prepared runtime artifact when status is ready. Link to this property reason?: string Human-readable pending or terminal error detail. Link to this property

[Link to this property](<#(resource)%20containers.images%20%3E%20(model)%20image_prepare_response%20%3E%20(schema)>) #### ContainersRegistries ##### [Get the list of configured registries in the account](https://developers.cloudflare.com/api/typescript/resources/containers/subresources/registries/methods/list) client.containers.registries.list(RegistryListParams {account\_id } params, RequestOptionsoptions?): SinglePage< [RegistryListResponse]() {created\_at, domain, kind, public\_key } > GET/accounts/{account\_id}/containers/registries ##### [Configure a private external image registry](https://developers.cloudflare.com/api/typescript/resources/containers/subresources/registries/methods/create) client.containers.registries.create(RegistryCreateParams {account\_id, auth, domain, 2 more } params, RequestOptionsoptions?): [RegistryCreateResponse]() {created\_at, domain, kind, public\_key } POST/accounts/{account\_id}/containers/registries ##### [Delete a registry from the account](https://developers.cloudflare.com/api/typescript/resources/containers/subresources/registries/methods/delete) client.containers.registries.delete(stringdomain, RegistryDeleteParams {account\_id } params, RequestOptionsoptions?): [RegistryDeleteResponse]() {domain } DELETE/accounts/{account\_id}/containers/registries/{domain} ##### ModelsExpand Collapse

RegistryListResponse {created\_at, domain, kind, public\_key } An image registry added in a customer account.

created\_at: string UTC timestamp string in ISO 8601 format. Link to this property domain: string A string representation of a domain name. See RFC-1034 (https://www.ietf.org/rfc/rfc1034.txt). Consider that the limit of a domain name is min 3 and max 253 ASCII characters. Link to this property

kind?: "ECR"| "DockerHub"| "GAR"| "default" The type of registry that is being configured.

One of the following: "ECR" Link to this property "DockerHub" Link to this property "GAR" Link to this property "default" Link to this property

Link to this property public\_key?: string Public component of the registry credentials. For managed registries this is a base64-encoded public key; for external registries the format depends on the registry provider. Link to this property

[Link to this property](<#(resource)%20containers.registries%20%3E%20(model)%20registry_list_response%20%3E%20(schema)>)

RegistryCreateResponse {created\_at, domain, kind, public\_key } An image registry added in a customer account.

kind?: "ECR"| "DockerHub"| "GAR"| "default" The type of registry that is being configured.

One of the following: "ECR" Link to this property "DockerHub" Link to this property "GAR" Link to this property "default" Link to this property

[Link to this property](<#(resource)%20containers.registries%20%3E%20(model)%20registry_create_response%20%3E%20(schema)>)

RegistryDeleteResponse {domain } Result of deleting an image registry from a Containers account.

domain: string A string representation of a domain name. See RFC-1034 (https://www.ietf.org/rfc/rfc1034.txt). Consider that the limit of a domain name is min 3 and max 253 ASCII characters. Link to this property

[Link to this property](<#(resource)%20containers.registries%20%3E%20(model)%20registry_delete_response%20%3E%20(schema)>) #### ContainersRegistriesCredentials ##### [Generate a JWT to interact with the specified image registry.](https://developers.cloudflare.com/api/typescript/resources/containers/subresources/registries/subresources/credentials/methods/generate) client.containers.registries.credentials.generate(stringdomain, CredentialGenerateParams {account\_id, expiration\_minutes, permissions } params, RequestOptionsoptions?): [CredentialGenerateResponse]() {account\_id, password, registry\_host, username } POST/accounts/{account\_id}/containers/registries/{domain}/credentials ##### ModelsExpand Collapse

CredentialGenerateResponse {account\_id, password, registry\_host, username } Credentials returned for an authenticated registry configured on a Containers account.

account\_id: string A unique identifier for the user’s account. Link to this property password: string The password to use when authenticating to the image registry. Link to this property registry\_host: string The domain of the image registry these credentials target. Link to this property username: string The username to use when authenticating to the image registry. Link to this property

[Link to this property](<#(resource)%20containers.registries.credentials%20%3E%20(model)%20credential_generate_response%20%3E%20(schema)>)