---
title: "list containers"
method: GET
path: "/api/v1/container"
tags: ["api/v1/container"]
---

# list containers

`GET /api/v1/container`

#### Controller: 

`github.com/raghavyuva/nixopus-api/internal/features/container/controller.(*ContainerController).ListContainers`

#### Middlewares:

- `github.com/go-fuego/fuego.defaultLogger.middleware`
- `github.com/raghavyuva/nixopus-api/internal/routes.(*Router).SetupRoutes.(*Router).setupAuthentication.func2`
- `github.com/raghavyuva/nixopus-api/internal/routes.(*Router).applyMiddleware.func1`
- `github.com/raghavyuva/nixopus-api/internal/routes.(*Router).applyMiddleware.func2`
- `github.com/raghavyuva/nixopus-api/internal/routes.(*Router).applyMiddleware.func3`

---

## Headers

- `Accept` string

## Response `200`

OK

- ListContainersResponse — ListContainersResponse schema
  - `data` object
    - `containers` object[]
      - `command` string
      - `created` string
      - `host_config` object
        - `cpu_shares` integer
        - `memory` integer
        - `memory_swap` integer
      - `id` string
      - `image` string
      - `ip_address` string
      - `labels` object
      - `mounts` object[]
        - `destination` string
        - `mode` string
        - `source` string
        - `type` string
      - `name` string
      - `networks` object[]
        - `aliases` string[]
        - `gateway` string
        - `ip_address` string
        - `mac_address` string
        - `name` string
      - `ports` object[]
        - `private_port` integer
        - `public_port` integer
        - `type` string
      - `state` string
      - `status` string
    - `group_count` integer
    - `groups` object[], nullable
      - `application_id` string
      - `application_name` string
      - `containers` object[]
        - `command` string
        - `created` string
        - `host_config` object
          - `cpu_shares` integer
          - `memory` integer
          - `memory_swap` integer
        - `id` string
        - `image` string
        - `ip_address` string
        - `labels` object
        - `mounts` object[]
          - `destination` string
          - `mode` string
          - `source` string
          - `type` string
        - `name` string
        - `networks` object[]
          - `aliases` string[]
          - `gateway` string
          - `ip_address` string
          - `mac_address` string
          - `name` string
        - `ports` object[]
          - `private_port` integer
          - `public_port` integer
          - `type` string
        - `state` string
        - `status` string
    - `image` string
    - `name` string
    - `page` integer
    - `page_size` integer
    - `search` string
    - `sort_by` string
    - `sort_order` string
    - `status` string
    - `total_count` integer
    - `ungrouped` object[], nullable
      - `command` string
      - `created` string
      - `host_config` object
        - `cpu_shares` integer
        - `memory` integer
        - `memory_swap` integer
      - `id` string
      - `image` string
      - `ip_address` string
      - `labels` object
      - `mounts` object[]
        - `destination` string
        - `mode` string
        - `source` string
        - `type` string
      - `name` string
      - `networks` object[]
        - `aliases` string[]
        - `gateway` string
        - `ip_address` string
        - `mac_address` string
        - `name` string
      - `ports` object[]
        - `private_port` integer
        - `public_port` integer
        - `type` string
      - `state` string
      - `status` string
  - `message` string
  - `status` string

## Other responses

- `400` — Bad Request _(validation or deserialization error)_
- `500` — Internal Server Error _(panics)_
- `default`

## Changes

- **2026-02-27** `93bf2b2f361d` — 14 breaking
  - the response property `data/groups/items/` became nullable for the status `200` (media type: application/json)
  - the response property `data/groups/items/` became nullable for the status `200` (media type: application/xml)
  - the response property `data/ungrouped/items/` became nullable for the status `200` (media type: application/json)
  - the response property `data/ungrouped/items/` became nullable for the status `200` (media type: application/xml)
  - …10 more
- **2026-01-28** `aa5bc43ffd43` — 6 info
  - added the optional property `data/group_count` to the response with the `200` status (media type: application/json)
  - added the optional property `data/group_count` to the response with the `200` status (media type: application/xml)
  - added the optional property `data/groups` to the response with the `200` status (media type: application/json)
  - added the optional property `data/groups` to the response with the `200` status (media type: application/xml)
  - …2 more
  - …this revision’s changelog is incomplete
- …earlier changes not shown

[Full history](https://skmtc.dev/nixopus/apis/openapi/changes/api/v1/container/get.md)

---

[API](https://skmtc.dev/nixopus/apis/openapi.md) · [All operations](https://skmtc.dev/nixopus/apis/openapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nixopus/openapi/revisions/86356bbcc727/schema)