List Applications associated with your account

client.Containers.Applications.List(ctx, params) (*PageTokenPagination[ApplicationListResponse], error)

GET/accounts/{account_id}/containers/applications

Lists all the applications that are associated with your account.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

ParametersExpand Collapse

params ApplicationListParams

AccountID param.Field[string]

Path param: Account identifier.

Image param.Field[string]Optional

Query param: Filter applications by image.

Name param.Field[string]Optional

Query param: Filter applications by name.

PageToken param.Field[string]Optional

Query param: Opaque token from a previous response to retrieve the next page.

PerPage param.Field[int64]Optional

Query param: Maximum number of applications to return per page. Defaults to all, or 100 when page_token is set.

maximum500

minimum1

ReturnsExpand Collapse

type ApplicationListResponse interface{…}

The public Containers API returns an application.

One of the following:

type ApplicationListResponseCcScheduledApplication struct{…}

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

ID string

An Application ID represents an identifier of an application.

AccountID string

A unique identifier for the user’s account.

Configuration ApplicationListResponseCcScheduledApplicationConfiguration

User-specified container configuration.

Image string

Image url.

AuthorizedKeys []ApplicationListResponseCcScheduledApplicationConfigurationAuthorizedKeyOptional

PublicKey string

An SSH public key.

Name stringOptional

Optional human readable name for this key.

Command []stringOptional

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 []stringOptional

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.

EnvironmentVariables []ApplicationListResponseCcScheduledApplicationConfigurationEnvironmentVariableOptional

Container environment variables.

Name string

An environment variable name.

Value string

An environment variable value.

InstanceType ApplicationListResponseCcScheduledApplicationConfigurationInstanceTypeOptional

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:

const ApplicationListResponseCcScheduledApplicationConfigurationInstanceTypeLite ApplicationListResponseCcScheduledApplicationConfigurationInstanceType = "lite"

const ApplicationListResponseCcScheduledApplicationConfigurationInstanceTypeBasic ApplicationListResponseCcScheduledApplicationConfigurationInstanceType = "basic"

const ApplicationListResponseCcScheduledApplicationConfigurationInstanceTypeStandard1 ApplicationListResponseCcScheduledApplicationConfigurationInstanceType = "standard-1"

const ApplicationListResponseCcScheduledApplicationConfigurationInstanceTypeStandard2 ApplicationListResponseCcScheduledApplicationConfigurationInstanceType = "standard-2"

const ApplicationListResponseCcScheduledApplicationConfigurationInstanceTypeStandard3 ApplicationListResponseCcScheduledApplicationConfigurationInstanceType = "standard-3"

const ApplicationListResponseCcScheduledApplicationConfigurationInstanceTypeStandard4 ApplicationListResponseCcScheduledApplicationConfigurationInstanceType = "standard-4"

Observability ApplicationListResponseCcScheduledApplicationConfigurationObservabilityOptional

Settings for deployment observability such as logging.

Logs ApplicationListResponseCcScheduledApplicationConfigurationObservabilityLogsOptional

Observability logging settings.

Enabled boolOptional

CreatedAt string

UTC timestamp string in ISO 8601 format.

Instances int64

Number of deployments to create.

Name string

The application name.

SchedulingPolicy ApplicationListResponseCcScheduledApplicationSchedulingPolicy

The scheduling policy to use for an application.

One of the following:

const ApplicationListResponseCcScheduledApplicationSchedulingPolicyDefault ApplicationListResponseCcScheduledApplicationSchedulingPolicy = "default"

const ApplicationListResponseCcScheduledApplicationSchedulingPolicyDurableObject ApplicationListResponseCcScheduledApplicationSchedulingPolicy = "durable_object"

UpdatedAt string

UTC timestamp string in ISO 8601 format.

Version int64

ActiveRolloutID stringOptional

An identifier for a specific rollout within an application.

Constraints ApplicationListResponseCcScheduledApplicationConstraintsOptional

Jurisdiction stringOptional

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 []stringOptional

DurableObjects ApplicationListResponseCcScheduledApplicationDurableObjectsOptional

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

NamespaceID string

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

Health ApplicationListResponseCcScheduledApplicationHealthOptional

Errors []ApplicationListResponseCcScheduledApplicationHealthError

Event ApplicationListResponseCcScheduledApplicationHealthErrorsEvent

An event within a Placement or a Job.

ID string

Details map[string, unknown]

Message string

Name ApplicationListResponseCcScheduledApplicationHealthErrorsEventName

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:

const ApplicationListResponseCcScheduledApplicationHealthErrorsEventNameSchedulerPlaced ApplicationListResponseCcScheduledApplicationHealthErrorsEventName = "SchedulerPlaced"

const ApplicationListResponseCcScheduledApplicationHealthErrorsEventNameNetworkingIPAssigned ApplicationListResponseCcScheduledApplicationHealthErrorsEventName = "NetworkingIPAssigned"

const ApplicationListResponseCcScheduledApplicationHealthErrorsEventNameVmStarted ApplicationListResponseCcScheduledApplicationHealthErrorsEventName = "VMStarted"

const ApplicationListResponseCcScheduledApplicationHealthErrorsEventNameImagePulled ApplicationListResponseCcScheduledApplicationHealthErrorsEventName = "ImagePulled"

const ApplicationListResponseCcScheduledApplicationHealthErrorsEventNameImagePullError ApplicationListResponseCcScheduledApplicationHealthErrorsEventName = "ImagePullError"

const ApplicationListResponseCcScheduledApplicationHealthErrorsEventNameVmFailedToStart ApplicationListResponseCcScheduledApplicationHealthErrorsEventName = "VMFailedToStart"

const ApplicationListResponseCcScheduledApplicationHealthErrorsEventNameNetworkingIPAssignmentFailed ApplicationListResponseCcScheduledApplicationHealthErrorsEventName = "NetworkingIPAssignmentFailed"

const ApplicationListResponseCcScheduledApplicationHealthErrorsEventNameVmRunning ApplicationListResponseCcScheduledApplicationHealthErrorsEventName = "VMRunning"

const ApplicationListResponseCcScheduledApplicationHealthErrorsEventNameVmStopping ApplicationListResponseCcScheduledApplicationHealthErrorsEventName = "VMStopping"

const ApplicationListResponseCcScheduledApplicationHealthErrorsEventNameVmStopped ApplicationListResponseCcScheduledApplicationHealthErrorsEventName = "VMStopped"

const ApplicationListResponseCcScheduledApplicationHealthErrorsEventNameVmFailed ApplicationListResponseCcScheduledApplicationHealthErrorsEventName = "VMFailed"

const ApplicationListResponseCcScheduledApplicationHealthErrorsEventNameRuntimeStartFailed ApplicationListResponseCcScheduledApplicationHealthErrorsEventName = "RuntimeStartFailed"

const ApplicationListResponseCcScheduledApplicationHealthErrorsEventNameSSHStarted ApplicationListResponseCcScheduledApplicationHealthErrorsEventName = "SSHStarted"

const ApplicationListResponseCcScheduledApplicationHealthErrorsEventNameServiceHealthUpdates ApplicationListResponseCcScheduledApplicationHealthErrorsEventName = "ServiceHealthUpdates"

const ApplicationListResponseCcScheduledApplicationHealthErrorsEventNameCheckUpdate ApplicationListResponseCcScheduledApplicationHealthErrorsEventName = "CheckUpdate"

const ApplicationListResponseCcScheduledApplicationHealthErrorsEventNameDurableObjectConnected ApplicationListResponseCcScheduledApplicationHealthErrorsEventName = "DurableObjectConnected"

const ApplicationListResponseCcScheduledApplicationHealthErrorsEventNameContainerStarted ApplicationListResponseCcScheduledApplicationHealthErrorsEventName = "ContainerStarted"

StatusChange map[string, unknown]

Time string

UTC timestamp string in ISO 8601 format.

Type ApplicationListResponseCcScheduledApplicationHealthErrorsEventType

One of the following:

const ApplicationListResponseCcScheduledApplicationHealthErrorsEventTypeInfo ApplicationListResponseCcScheduledApplicationHealthErrorsEventType = "Info"

const ApplicationListResponseCcScheduledApplicationHealthErrorsEventTypeError ApplicationListResponseCcScheduledApplicationHealthErrorsEventType = "Error"

const ApplicationListResponseCcScheduledApplicationHealthErrorsEventTypeWarn ApplicationListResponseCcScheduledApplicationHealthErrorsEventType = "Warn"

const ApplicationListResponseCcScheduledApplicationHealthErrorsEventTypeUserError ApplicationListResponseCcScheduledApplicationHealthErrorsEventType = "UserError"

const ApplicationListResponseCcScheduledApplicationHealthErrorsEventTypeSystemError ApplicationListResponseCcScheduledApplicationHealthErrorsEventType = "SystemError"

InstanceID string

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

Instances ApplicationListResponseCcScheduledApplicationHealthInstances

Shows a count of application instance states.

Active int64

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 int64

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 ApplicationListResponseCcScheduledApplicationHealthSummaryOptional

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:

const ApplicationListResponseCcScheduledApplicationHealthSummaryHealthy ApplicationListResponseCcScheduledApplicationHealthSummary = "healthy"

const ApplicationListResponseCcScheduledApplicationHealthSummaryDegraded ApplicationListResponseCcScheduledApplicationHealthSummary = "degraded"

const ApplicationListResponseCcScheduledApplicationHealthSummaryUnhealthy ApplicationListResponseCcScheduledApplicationHealthSummary = "unhealthy"

const ApplicationListResponseCcScheduledApplicationHealthSummaryPending ApplicationListResponseCcScheduledApplicationHealthSummary = "pending"

MaxInstances int64Optional

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

Observability ApplicationListResponseCcScheduledApplicationObservabilityOptional

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

Logs ApplicationListResponseCcScheduledApplicationObservabilityLogsOptional

Observability logging settings.

Enabled boolOptional

RolloutActiveGracePeriod int64Optional

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

type ApplicationListResponseCcDurableObjectApplication struct{…}

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

ID string

An Application ID represents an identifier of an application.

AccountID string

A unique identifier for the user’s account.

CreatedAt string

UTC timestamp string in ISO 8601 format.

DurableObjects ApplicationListResponseCcDurableObjectApplicationDurableObjects

Durable object configuration using a namespace ID.

NamespaceID string

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

Name string

The application name.

SchedulingPolicy ApplicationListResponseCcDurableObjectApplicationSchedulingPolicy

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.

UpdatedAt string

UTC timestamp string in ISO 8601 format.

Configuration ApplicationListResponseCcDurableObjectApplicationConfigurationOptional

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

AuthorizedKeys []ApplicationListResponseCcDurableObjectApplicationConfigurationAuthorizedKeyOptional

PublicKey string

An SSH public key.

Name stringOptional

Optional human readable name for this key.

WranglerSSH ApplicationListResponseCcDurableObjectApplicationConfigurationWranglerSSHOptional

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

Enabled boolOptional

Port int64Optional

maximum65535

minimum1

Health ApplicationListResponseCcDurableObjectApplicationHealthOptional

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 ApplicationListResponseCcDurableObjectApplicationHealthInstances

Counts of observed non-terminal instances.

Active int64

Number of instances whose runtime reports running or stopping.

minimum0

Starting int64

Number of instances whose runtime reports starting.

minimum0

Summary ApplicationListResponseCcDurableObjectApplicationHealthSummaryOptional

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

Observability ApplicationListResponseCcDurableObjectApplicationObservabilityOptional

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 ApplicationListResponseCcDurableObjectApplicationObservabilityLogsOptional

Application-wide logging settings.

Enabled boolOptional

List Applications associated with your account

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/containers"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  page, err := client.Containers.Applications.List(context.TODO(), containers.ApplicationListParams{
    AccountID: cloudflare.F("account-123"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "id": "id",
      "account_id": "account_id",
      "configuration": {
        "image": "image",
        "authorized_keys": [
          {
            "public_key": "public_key",
            "name": "name"
          }
        ],
        "command": [
          "myapp",
          "--default-option"
        ],
        "entrypoint": [
          "/bin/bash"
        ],
        "environment_variables": [
          {
            "name": "name",
            "value": "value"
          }
        ],
        "instance_type": "lite",
        "observability": {
          "logs": {
            "enabled": true
          }
        }
      },
      "created_at": "2021-04-01T12:32:41.488Z",
      "instances": 0,
      "name": "name",
      "scheduling_policy": "default",
      "updated_at": "2021-04-01T12:32:41.488Z",
      "version": 0,
      "active_rollout_id": "active_rollout_id",
      "constraints": {
        "jurisdiction": "jurisdiction",
        "regions": [
          "WNAM"
        ]
      },
      "durable_objects": {
        "namespace_id": "14758f1afd44c09b7992073ccf00b43d"
      },
      "health": {
        "errors": [
          {
            "event": {
              "id": "id",
              "details": {
                "foo": "bar"
              },
              "message": "message",
              "name": "SchedulerPlaced",
              "statusChange": {
                "foo": "bar"
              },
              "time": "2021-04-01T12:32:41.488Z",
              "type": "Info"
            },
            "instance_id": "instance_id"
          }
        ],
        "instances": {
          "active": 0,
          "assigned": 0
        },
        "summary": "healthy"
      },
      "max_instances": 0,
      "observability": {
        "logs": {
          "enabled": true
        }
      },
      "rollout_active_grace_period": 0
    }
  ],
  "result_info": {
    "next_page_token": "next_page_token",
    "page_token": "page_token",
    "per_page": 0
  },
  "success": true
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "id": "id",
      "account_id": "account_id",
      "configuration": {
        "image": "image",
        "authorized_keys": [
          {
            "public_key": "public_key",
            "name": "name"
          }
        ],
        "command": [
          "myapp",
          "--default-option"
        ],
        "entrypoint": [
          "/bin/bash"
        ],
        "environment_variables": [
          {
            "name": "name",
            "value": "value"
          }
        ],
        "instance_type": "lite",
        "observability": {
          "logs": {
            "enabled": true
          }
        }
      },
      "created_at": "2021-04-01T12:32:41.488Z",
      "instances": 0,
      "name": "name",
      "scheduling_policy": "default",
      "updated_at": "2021-04-01T12:32:41.488Z",
      "version": 0,
      "active_rollout_id": "active_rollout_id",
      "constraints": {
        "jurisdiction": "jurisdiction",
        "regions": [
          "WNAM"
        ]
      },
      "durable_objects": {
        "namespace_id": "14758f1afd44c09b7992073ccf00b43d"
      },
      "health": {
        "errors": [
          {
            "event": {
              "id": "id",
              "details": {
                "foo": "bar"
              },
              "message": "message",
              "name": "SchedulerPlaced",
              "statusChange": {
                "foo": "bar"
              },
              "time": "2021-04-01T12:32:41.488Z",
              "type": "Info"
            },
            "instance_id": "instance_id"
          }
        ],
        "instances": {
          "active": 0,
          "assigned": 0
        },
        "summary": "healthy"
      },
      "max_instances": 0,
      "observability": {
        "logs": {
          "enabled": true
        }
      },
      "rollout_active_grace_period": 0
    }
  ],
  "result_info": {
    "next_page_token": "next_page_token",
    "page_token": "page_token",
    "per_page": 0
  },
  "success": true
}