--- title: "List Container Groups" method: GET path: "/organizations/{organization_name}/projects/{project_name}/containers" tags: ["container_groups"] --- # List Container Groups `GET /organizations/{organization_name}/projects/{project_name}/containers` Gets the list of container groups ## Response `200` OK - ContainerGroupCollection — A paginated collection of container groups that provides a structured way to access multiple container group resources in a single response. - `items` ContainerGroup[], required — An array containing container group objects. Each object represents a discrete container group with its own properties, configuration, and status. - `autostart_policy` boolean, required — Defines whether containers in this group should automatically start when deployed (true) or require manual starting (false) - `container` Container, required — Represents a container with its configuration and resource requirements. - `command` string[], nullable, required — List of commands to run inside the container. Each command is a string representing a command-line instruction. - `environment_variables` object — Environment variables to set in the container. - `hash` string — SHA-256 hash (64-character hexadecimal string) - `image` string, required — The container image. - `image_caching` boolean — The container image caching. - `logging` ContainerLogging — Configuration options for directing container logs to a logging provider. This schema enables you to specify a single logging destination for container output, supporting monitoring, debugging, and analytics use cases. Each provider has its own configuration parameters defined in the referenced schemas. Only one logging provider can be selected at a time. - `axiom` ContainerLoggingAxiom — Configuration settings for integrating container logs with the Axiom logging service. When specified, container logs will be forwarded to the Axiom instance defined by these parameters. - `api_token` string, required — Authentication token for the Axiom API with appropriate write permissions - `dataset` string, required — Name of the Axiom dataset where the container logs will be stored and indexed - `host` string, required — The Axiom host URL where logs will be sent (e.g. logs.axiom.co) - `datadog` ContainerLoggingDatadog — Configuration for forwarding container logs to Datadog monitoring service. - `api_key` string, required — The Datadog API key used for authentication when sending logs. - `host` string, required — The Datadog intake server host URL where logs will be sent. - `tags` ContainerLoggingDatadogTag[], nullable, required — Optional metadata tags to attach to logs for filtering and categorization in Datadog. - `name` string, required — The name of the metadata tag. - `value` string, required — The value of the metadata tag. - `http` ContainerLoggingHttp — Configuration for sending container logs to an HTTP endpoint. Defines how logs are formatted, compressed, and transmitted. - `compression` 'none' | 'gzip', required — The compression algorithm to apply to logs before transmission - `format` 'json' | 'json_lines', required — The format in which logs will be delivered - `headers` ContainerLoggingHttpHeader[], nullable, required — Optional HTTP headers to include in log transmission requests - `name` string, required — The name of the HTTP header - `value` string, required — The value of the HTTP header - `host` string, required — The hostname or IP address of the HTTP logging endpoint - `password` string, nullable — Optional password for HTTP authentication - `path` string, nullable — Optional URL path for the HTTP endpoint - `port` integer, required — The port number of the HTTP logging endpoint (1-65535) - `user` string, nullable — Optional username for HTTP authentication - `new_relic` ContainerLoggingNewRelic — Configuration for sending container logs to New Relic's log management platform. - `host` string, required — The New Relic endpoint host for log ingestion (e.g., log-api.newrelic.com). - `ingestion_key` string, required — The New Relic license or ingestion key used for authentication and data routing. - `splunk` ContainerLoggingSplunk — Configuration settings for forwarding container logs to a Splunk instance. - `host` string, required — The URL of the Splunk HTTP Event Collector (HEC) endpoint. - `token` string, required — The authentication token required to send data to the Splunk HEC endpoint. - `tcp` ContainerLoggingTcp — Configuration for forwarding container logs to a remote TCP endpoint - `host` string, required — The hostname or IP address of the remote TCP logging endpoint - `port` integer, required — The port number on which the TCP logging endpoint is listening - `resources` ContainerResourceRequirements, required — Specifies the resource requirements for a container. - `cpu` integer, required — The number of CPU cores required by the container. Must be between 1 and 16. - `gpu_classes` string[], required — A list of GPU class UUIDs required by the container. Can be null if no GPU is required. - `memory` integer, required — The amount of memory (in MB) required by the container. Must be between 1024 MB and 61440 MB. - `shm_size` integer — The size of the shared memory (/dev/shm) in MB. If not specified, defaults to 1024MB. - `storage_amount` integer — The amount of storage (in bytes) required by the container. Must be between 1 GB (1073741824 bytes) and 250 GB (268435456000 bytes). - `size` integer — Size of the container in bytes. - `country_codes` CountryCode[], required — List of country codes where container instances are permitted to run. When not specified or empty, containers may run in any available region. - `create_time` string, date-time, required — ISO 8601 timestamp when this container group was initially created - `current_state` ContainerGroupState, required — Represents the operational state of a container group during its lifecycle, including timing information, status, and instance distribution metrics. This state captures the current execution status, start and finish times, and provides visibility into the operational health across instances. - `description` string, nullable — Optional textual description or notes about the current state of the container group - `finish_time` string, date-time, required — Timestamp when the container group execution finished or is expected to finish - `instance_status_counts` ContainerGroupInstanceStatusCount, required — A summary of container group instances categorized by their current lifecycle status - `allocating_count` integer, required — The number of container instances that are currently being allocated resources - `creating_count` integer, required — The number of container instances that are in the process of being created - `running_count` integer, required — The number of container instances that are currently running and operational - `stopping_count` integer, required — The number of container instances that are in the process of stopping - `start_time` string, date-time, required — Timestamp when the container group execution started - `status` 'pending' | 'running' | 'stopped' | 'succeeded' | 'failed' | 'deploying', required — Represents the current operational state of a container group within the Salad platform. - `display_name` string, required — The display-friendly name of the resource. - `id` string, uuid, required — The container group identifier. - `liveness_probe` ContainerGroupLivenessProbe, nullable — Defines a liveness probe for container groups that determines when to restart a container if it becomes unhealthy - `exec` ContainerGroupProbeExec — Defines the exec action for a probe in a container group. This is used to execute a command inside a container for health checks. - `command` string[], required — The command to execute inside the container. Exit status of 0 is considered successful, any other exit status is considered failure. - `failure_threshold` integer, required — Number of consecutive failures required to consider the probe as failed - `grpc` ContainerGroupProbeGrpc — Configuration for gRPC-based health probes in container groups, used to determine container health status. - `port` integer, required — The port number on which the gRPC health check service is exposed. - `service` string, required — The name of the gRPC service that implements the health check protocol. - `http` ContainerGroupProbeHttp — Defines HTTP probe configuration for container health checks within a container group. - `headers` ContainerGroupProbeHttpHeader[], required — A collection of HTTP header name-value pairs used for configuring requests and responses in container group endpoints. Each header consists of a name and its corresponding value. - `name` string, required — The name of the HTTP header - `value` string, required — The value associated with the HTTP header - `path` string, required — The HTTP path that will be probed to check container health. - `port` integer, required — The TCP port number to which the HTTP request will be sent. - `scheme` 'http' | 'https', nullable, required — The protocol scheme used for HTTP probe requests in container health checks. - `initial_delay_seconds` integer, required — Number of seconds to wait after container start before initiating liveness probes - `period_seconds` integer, required — Frequency in seconds at which the probe should be executed - `success_threshold` integer, required — Number of consecutive successes required to consider the probe successful - `tcp` ContainerGroupProbeTcp — Configuration for a TCP probe used to check container health via network connectivity. - `port` integer, required — The TCP port number that the probe should connect to. Must be a valid port number between 0 and 65535. - `timeout_seconds` integer, required — Number of seconds after which the probe times out if no response is received - `name` string, required — The container group name. - `networking` ContainerGroupNetworking — Network configuration for container groups that defines connectivity, routing, and access control settings - `auth` boolean, required — Whether authentication is required for network access to the container group - `client_request_timeout` integer — The container group networking client request timeout. - `dns` string, url, required — Domain name or URL endpoint for the container group's network interface - `load_balancer` 'round_robin' | 'least_number_of_connections', required — The container group networking load balancer. - `port` integer, required — The container group networking port. - `protocol` 'http', required — Defines the communication protocol used for network traffic between containers or external systems. Currently supports HTTP protocol for web-based communication. - `server_response_timeout` integer — The container group networking server response timeout. - `single_connection_limit` boolean — The container group networking single connection limit flag. - `organization_name` string, required — The organization name. - `pending_change` boolean, required — Indicates whether a configuration change has been requested but not yet applied to all containers in the group - `priority` 'high' | 'medium' | 'low' | 'batch', nullable, required — Specifies the priority level for container group execution, which determines resource allocation and scheduling precedence. - `project_name` string, required — The project name. - `queue_autoscaler` ContainerGroupQueueAutoscaler — Defines configuration for automatically scaling container instances based on queue length. The autoscaler monitors a queue and adjusts the number of running replicas to maintain the desired queue length. - `desired_queue_length` integer, required — The target number of items in the queue that the autoscaler attempts to maintain by scaling the containers up or down - `max_downscale_per_minute` integer — The maximum number of instances that can be removed per minute to prevent rapid downscaling - `max_replicas` integer, required — The maximum number of instances the container can scale up to - `max_upscale_per_minute` integer — The maximum number of instances that can be added per minute to prevent rapid upscaling - `min_replicas` integer, required — The minimum number of instances the container can scale down to, ensuring baseline availability - `polling_period` integer — The period (in seconds) in which the autoscaler checks the queue length and applies the scaling formula - `queue_connection` ContainerGroupQueueConnection — Configuration for connecting a container group to a message queue system, enabling asynchronous communication between services. - `path` string, required — The endpoint path for accessing the queue service, relative to the base URL of the queue server. - `port` integer, required — The network port number used to connect to the queue service. Must be a valid TCP/IP port between 1 and 65535. - `queue_name` string, required — Unique identifier for the queue. Must start with a lowercase letter, can contain lowercase letters, numbers, and hyphens, and must end with a letter or number. - `readiness_probe` ContainerGroupReadinessProbe, nullable — Defines how to check if a container is ready to serve traffic. The readiness probe determines whether the container's application is ready to accept traffic. If the readiness probe fails, the container is considered not ready and traffic will not be sent to it. - `exec` ContainerGroupProbeExec — Defines the exec action for a probe in a container group. This is used to execute a command inside a container for health checks. - `command` string[], required — The command to execute inside the container. Exit status of 0 is considered successful, any other exit status is considered failure. - `failure_threshold` integer, required — The number of consecutive failures required to consider the probe failed. After this many consecutive failures, the container is marked as not ready. - `grpc` ContainerGroupProbeGrpc — Configuration for gRPC-based health probes in container groups, used to determine container health status. - `port` integer, required — The port number on which the gRPC health check service is exposed. - `service` string, required — The name of the gRPC service that implements the health check protocol. - `http` ContainerGroupProbeHttp — Defines HTTP probe configuration for container health checks within a container group. - `headers` ContainerGroupProbeHttpHeader[], required — A collection of HTTP header name-value pairs used for configuring requests and responses in container group endpoints. Each header consists of a name and its corresponding value. - `name` string, required — The name of the HTTP header - `value` string, required — The value associated with the HTTP header - `path` string, required — The HTTP path that will be probed to check container health. - `port` integer, required — The TCP port number to which the HTTP request will be sent. - `scheme` 'http' | 'https', nullable, required — The protocol scheme used for HTTP probe requests in container health checks. - `initial_delay_seconds` integer, required — The time in seconds to wait after the container starts before initiating the first probe. This allows time for the application to initialize before being tested. - `period_seconds` integer, required — How frequently (in seconds) the probe should be executed during the container's lifetime. Specifies the interval between consecutive probe executions. - `success_threshold` integer, required — The minimum consecutive successes required to consider the probe successful after it has failed. Defines how many successful probe results are needed to transition from failure to success. - `tcp` ContainerGroupProbeTcp — Configuration for a TCP probe used to check container health via network connectivity. - `port` integer, required — The TCP port number that the probe should connect to. Must be a valid port number between 0 and 65535. - `timeout_seconds` integer, required — The maximum time in seconds that the probe has to complete. If the probe doesn't return a result before the timeout, it's considered failed. - `readme` string - `replicas` integer, required — The container group replicas. - `restart_policy` 'always' | 'on_failure' | 'never', required — Specifies the policy for restarting containers when they exit or fail. - `scaling-actions` ContainerGroupScalingAction[], required — List of scaling actions configurations - `replicas` integer, required — The number of replicas to scale to during the scheduled period - `schedule` string, required — The cron-style schedule string defining when the scaling should occur - `scheduled-scaling-enabled` boolean, required — Indicates if scheduled scaling is enabled - `startup_probe` ContainerGroupStartupProbe, nullable — Defines a probe that checks if a container application has started successfully. Startup probes help prevent applications from being prematurely marked as unhealthy during initialization. The probe can use HTTP requests, TCP connections, gRPC calls, or shell commands to determine startup status. - `exec` ContainerGroupProbeExec — Defines the exec action for a probe in a container group. This is used to execute a command inside a container for health checks. - `command` string[], required — The command to execute inside the container. Exit status of 0 is considered successful, any other exit status is considered failure. - `failure_threshold` integer, required — Number of times the probe must fail before considering the container not started - `grpc` ContainerGroupProbeGrpc — Configuration for gRPC-based health probes in container groups, used to determine container health status. - `port` integer, required — The port number on which the gRPC health check service is exposed. - `service` string, required — The name of the gRPC service that implements the health check protocol. - `http` ContainerGroupProbeHttp — Defines HTTP probe configuration for container health checks within a container group. - `headers` ContainerGroupProbeHttpHeader[], required — A collection of HTTP header name-value pairs used for configuring requests and responses in container group endpoints. Each header consists of a name and its corresponding value. - `name` string, required — The name of the HTTP header - `value` string, required — The value associated with the HTTP header - `path` string, required — The HTTP path that will be probed to check container health. - `port` integer, required — The TCP port number to which the HTTP request will be sent. - `scheme` 'http' | 'https', nullable, required — The protocol scheme used for HTTP probe requests in container health checks. - `initial_delay_seconds` integer, required — Number of seconds to wait after container startup before the first probe is executed - `period_seconds` integer, required — How frequently (in seconds) to perform the probe - `success_threshold` integer, required — Minimum consecutive successes required for the probe to be considered successful - `tcp` ContainerGroupProbeTcp — Configuration for a TCP probe used to check container health via network connectivity. - `port` integer, required — The TCP port number that the probe should connect to. Must be a valid port number between 0 and 65535. - `timeout_seconds` integer, required — Maximum time (in seconds) to wait for a probe response before considering it failed - `update_time` string, date-time, required — ISO 8601 timestamp when this container group was last updated - `version` integer, required — Incremental version number that increases with each configuration change to the container group ## Other responses - `429` — Too Many Requests - `default` — Unknown Error --- [API](https://skmtc.dev/salad/apis/saladcloud-api.md) · [All operations](https://skmtc.dev/salad/apis/saladcloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/salad/saladcloud-api/revisions/6ee34c3732f3/schema)