---
title: "List Servers"
method: GET
path: "/api/v1/extension/servers"
tags: ["Extension"]
---

# List Servers

`GET /api/v1/extension/servers`

List Servers

## Query parameters

- `limit` integer, nullable — Requests a page size of items. Returns a number of items up to a limit value.
- `marker` string, nullable — The ID of the last-seen item.
- `sort_dirs` 'desc' | 'asc'
- `sort_keys` ServerSortKey[] — Indicates in which attributes to sort. Host is only used for admin role users
- `all_projects` boolean, nullable — List servers for all projects.
- `project_id` string, nullable — Filter the list of servers by the given project ID. Only works when the all_projects filter is also specified.
- `project_name` string, nullable — Filter the list of servers by the given project name. Only works when the all_projects filter is also specified.
- `name` string, nullable — Filter the list of servers by the given server name. Support fuzzy query.
- `status` 'ACTIVE' | 'BUILD' | 'ERROR' | 'HARD_REBOOT' | 'MIGRATING' | 'PAUSED' | 'REBOOT' | 'REBUILD' | 'RESCUE' | 'RESIZE' | 'SHELVED' | 'SHELVED_OFFLOADED' | 'SHUTOFF' | 'SOFT_DELETED' | 'SUSPENDED' | 'UNKNOWN'
- `host` string, nullable — Filter the list of servers by the given host. It will be ignored for non-admin user.
- `flavor_id` string — Filter the list of servers by the given flavor ID.
- `uuid` string — Filter the list of servers by the given server UUID.
- `ip` string, nullable — Filter the list of servers by the given IP address (only fixed, not floating). Also passed to Nova API if supported.

## Headers

- `X-Openstack-Request-Id` string

## Response `200`

OK

- ServersResponse
  - `servers` ServersResponseBase[], required — Servers list
    - `id` string, uuid4, required — Server ID
    - `origin_data` object, required — The origin_data is the same like the response of https://docs.openstack.org/api-ref/compute/?expanded=list-servers-detailed-detail#list-servers-detailed
    - `project_name` string, nullable — Project name
    - `image` string, uuid4, nullable — Image ID
    - `image_name` string, nullable — Image name
    - `image_os_distro` string, nullable — Image OS distro
    - `fixed_addresses` unknown[], nullable — Fixed addresses
      - unknown
    - `floating_addresses` unknown[], nullable — Floating addresses
      - unknown
    - `name` string, nullable, required — Will be removed, please use origin_data[name]
    - `project_id` string, nullable, required — Will be removed, please use origin_data[tenant_id]
    - `host` string, nullable, required — Will be removed, please use origin_data[OS-EXT-SRV-ATTR:host]
    - `hostname` string, nullable, required — Will be removed, please use origin_data[OS-EXT-SRV-ATTR:hostname]
    - `flavor` string, nullable, required — Will be removed, please use origin_data[flavor][original_name]
    - `flavor_info` FlavorInServer, required
      - `ephemeral` integer, nullable — Ephemeral disk size in GB
      - `ram` integer, nullable — RAM size in MB
      - `original_name` string, nullable — Original flavor name
      - `vcpus` integer, nullable — Number of vCPUs
      - `extra_specs` object, nullable — Extra specs
      - `swap` integer, nullable — Swap size in MB
      - `disk` integer, nullable — Disk size in GB
    - `status` string, nullable, required — Will be removed, please use origin_data[status]
    - `locked` boolean, nullable, required — Will be removed, please use origin_data[locked]
    - `created_at` string, nullable, required — Will be removed, please use origin_data[created]
    - `task_state` string, nullable, required — Will be removed, please use origin_data[OS-EXT-STS:task_state]
    - `vm_state` string, nullable, required — Will be removed, please use origin_data[OS-EXT-STS:vm_state]
    - `power_state` integer, nullable, required — Will be removed, please use origin_data[OS-EXT-STS:power_state]
    - `root_device_name` string, nullable, required — Will be removed, please use origin_data[OS-EXT-SRV-ATTR:root_device_name]
    - `metadata` object, nullable, required — Will be removed, please use origin_data[metadata]

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `422` — Validation Error
- `500` — Internal Server Error

## Changes

> 14 revisions in range; 1 could not be searched.

- **2025-08-09** `b8c608aeb71a` — 1 info
  - added the new optional `query` request parameter `ip`
- **2025-07-21** `69284996eaa6` — 19 breaking, 30 info
  - response property `servers/items/created_at` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
  - response property `servers/items/fixed_addresses` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
  - response property `servers/items/flavor` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
  - response property `servers/items/floating_addresses` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
  - …45 more
- **2025-06-24** `0c09cad5e8d9` — 1 breaking
  - response property `detail/items/loc/items/` list-of-types was widened by adding types `integer` to media type `application/json` of response `422`
- **2022-08-25** `11bfeb1a965b` — 18 breaking, 2 info
  - removed the enum value `ACTIVE` from the `query` request parameter `status`
  - removed the enum value `BUILD` from the `query` request parameter `status`
  - removed the enum value `ERROR` from the `query` request parameter `status`
  - removed the enum value `HARD_REBOOT` from the `query` request parameter `status`
  - …16 more
- …earlier changes not shown

[Full history](https://skmtc.dev/openstack/apis/skyline-api/changes/api/v1/extension/servers/get.md)

---

[API](https://skmtc.dev/openstack/apis/skyline-api.md) · [All operations](https://skmtc.dev/openstack/apis/skyline-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/openstack/skyline-api/revisions/4b7c0ce8c025/schema)
