# app.container_ids

Returns container IDs for app_name.

Type: object

##

Type: array
No Additional Items

#### Tuple Validation

##### Parameter 1: app_name

#### app_name

Type: string

Name of the application to get container IDs for.

Must be at least `1` characters long

##### Parameter 2: options

#### options

Type: object Default: {"alive_only": true}

Options for filtering the returned container list.

No Additional Properties

##

#### Alive Only

Type: boolean Default: true

Whether to return only running/active containers (`true`) or include all containers (`false`).

##

#### AppContainerResponse

Type: object

Object containing container ID to details mappings.

##

Each additional property must conform to the following schema

#### ContainerDetails

Type: object
No Additional Properties

##

#### Id

Type: string

Unique identifier for the container.

Must be at least `1` characters long

##

#### Service Name

Type: string

Name of the service this container provides.

Must be at least `1` characters long

##

#### Image

Type: string

Docker image name and tag used by this container.

Must be at least `1` characters long

##

#### State

Type: enum (of string)

Current state of the container.

##### Must be one of:

- "crashed"
- "created"
- "exited"
- "running"
- "starting"

Required roles: APPS_READ