---
title: "Get list of deployments"
method: GET
path: "/deployments"
tags: ["Configuration - Deployment"]
---

# Get list of deployments

`GET /deployments`

Get deployment details across multiple sites.

## Query parameters

- `page` integer
- `limit` integer

## Response `200`

OK

- PagedXiqDeploymentDetailsResponse
  - `page` integer, required — The current page number
  - `count` integer, required — The element count of the current page
  - `total_pages` integer, required — The total page number based on request page size
  - `total_count` integer, required — The total element count
  - `data` XiqDeploymentDetailsResponse[] — The data in the current page
    - `deployment_id` integer — The deployment ID
    - `schedule` XiqScheduleDetails — Deployment Schedule details
      - `start_time` integer, required — The start time
    - `devices` XiqDevices — The device details response
      - `ids` integer[] — The device ids
      - `site_ids` integer[] — The site ids
    - `policy` XiqDeploymentsPolicyResponse — The deployment policy
      - `enable_complete_configuration_update` boolean — True if update complete configuration, otherwise update delta configuration.
      - `firmware_upgrade_policy` XiqFirmwareUpgradePolicy — The firmware upgrade policy
        - `enable_enforce_upgrade` boolean — Whether enforce firmware upgrade even if the versions are the same
        - `enable_distributed_upgrade` boolean — Whether enable distributed firmware upgrade (Only applicable to APs)
      - `firmware_upgrade_versions` XiqFirmwareUpgradeVersion[] — The firmware upgrade versions
        - `firmware_id` integer, required — The device compatible firmware metadata ID
        - `device_id` integer — The device ID
        - `product_type` string — The product type
      - `firmware_activate_option` XiqFirmwareActivateOption — The firmware activate option (Only one of them can be enabled)
        - `activation_delay_seconds` integer — Activate after the given seconds
        - `activation_time` integer — Activate at the following time according to the system clock on the updated device
        - `enable_activate_at_next_reboot` boolean — Activate at next reboot (requires rebooting manually)
    - `schedule_status` 'SCHEDULED' | 'IN_PROGRESS' | 'ABORTED' | 'COMPLETED' | 'FAILED' | 'TIME_OUT' — The schedule status
    - `overview` XiqDeploymentOverviewDetails — The configuration deployment overview
      - `total_devices` integer — The total device count
      - `in_progress_devices` integer — The device count with in progress deployment
      - `total_progress` integer — The total progress, range from 0 to 100

---

[API](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api.md) · [All operations](https://skmtc.net/extremecloudiq/apis/extremecloud-iq-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/extremecloudiq/extremecloud-iq-api/versions/5ff7ab84e8e8/schema)