---
title: "List All Deployments"
method: GET
path: "/v1/deployments"
tags: ["Deployments"]
---

# List All Deployments

`GET /v1/deployments`

## Request

- Base URL: `https://api.edgegap.com`
- URL: `https://api.edgegap.com/v1/deployments`
- Auth: API key in header `authorization`

[Rate Limit: 10/second] List all deployments.

## Query parameters

- `query` string

## Response `200`

Success

- Deployments
  - `data` DeploymentListData[]: List of active deployments
    - `request_id` string, required: Unique UUID
    - `fqdn` string, required: The FQDN that allow to connect to your deployment
    - `start_time` string, required: Timestamp of the deployment when it is up and running
    - `ready` boolean, required: If the deployment is ready
    - `public_ip` string, required: The public IP
    - `ports` object
    - `tags` string[]: List of tags associated with the deployment
    - `sockets` integer: The capacity of the deployment
    - `sockets_usage` integer: The capacity usage of the deployment
    - `is_joinable_by_session` boolean: If the deployment is joinable by sessions
  - `total_count` integer: Total Objects in the Database
  - `pagination` Pagination
    - `number` integer: Current page number
    - `next_page_number` integer: Next page number
    - `previous_page_number` integer: Previous page number
    - `paginator` Paginator
      - `num_pages` integer: Total pages count
    - `has_next` boolean: If there is a next page
    - `has_previous` boolean: If there is a previous page
  - `message` string[]: Extra Messages for the query

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `500`: Internal Server Error

---

[API](https://skmtc.dev/edgegap/apis/edgegap-v1.md) · [All operations](https://skmtc.dev/edgegap/apis/edgegap-v1/llms.txt) · [OpenAPI document](https://skmtc.dev/edgegap/apis/edgegap-v1/revisions/9fa2b393a6be?raw)