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

# List your deployments

`GET /v1/deployments`

## Request

- Base URL: `https://api.auxen.ai`
- URL: `https://api.auxen.ai/v1/deployments`
- Auth: HTTP bearer

## Query parameters

- `status` 'deploying' | 'ready' | 'paused' | 'warming' | 'switching' | 'suspended' | 'error' | 'deleted'
- `billing` 'subscription' | 'pay_as_you_go' | 'on_demand'
- `limit` integer

## Response `200`

OK

- object
  - `success` true, required
  - `data` object, required
    - `deployments` Deployment[]
      - `deployment_id` string
      - `instance_id` string: Deprecated alias of `deployment_id`; returned until 2027-04-02.
      - `status` 'deploying' | 'ready' | 'paused' | 'warming' | 'switching' | 'suspended' | 'error' | 'deleted': On /v1/deployments/* routes. (Deprecated routes return the pre-2026 value here and the new one in `deployment_status`.)
      - `legacy_status` string: Pre-2026 status value (e.g. `running` for `ready`); returned until 2027-04-02.
      - `model` string
      - `billing` 'subscription' | 'pay_as_you_go' | 'on_demand': Current billing mode. `pay_as_you_go` is canonical; `on_demand` is a back-compat alias; `subscription` is legacy and applies only to grandfathered accounts.
      - `label` string, nullable
      - `endpoint` string, nullable: Inference endpoint. OpenAI-compatible base URL is `{endpoint}/v1`.
      - `api_key` string, nullable: Per-deployment inference key. Use this in Authorization for /chat and /v1/chat/completions.
      - `webhook_url` string, nullable
      - `throughput` 'standard' | 'double' | 'quad' | 'max'
      - `throughput_multiplier` 1 | 2 | 4 | 8
      - `capacity` 1 | 2 | 4 | 8: Deprecated alias of `throughput_multiplier`; returned until 2027-04-02.
      - `system_prompt` string, nullable: Per-deployment system prompt. null = inherit account default.
      - `billing_details` union
        - object
          - `mode` 'subscription'
          - `plan` 'shared' | 'dedicated' | 'business' | 'enterprise'
          - `monthly_cost` number
          - `next_billing_date` string, nullable
        - object
          - `mode` 'pay_as_you_go'
          - `rate_per_hour` string
          - `hourly_rate` number: Deprecated alias of `rate_per_hour`; returned until 2027-04-02.
          - `accumulated_cost` number
          - `spending_cap` number, nullable
          - `paused_at` string, date-time, nullable
      - `created_at` string, date-time
      - `ready_at` string, date-time, nullable
      - `deleted_at` string, date-time, nullable
      - `destroyed_at` string, date-time, nullable: Deprecated alias of `deleted_at`; returned until 2027-04-02.
    - `instances` Deployment[]: Deprecated alias of `deployments`; returned until 2027-04-02.
      - `deployment_id` string
      - `instance_id` string: Deprecated alias of `deployment_id`; returned until 2027-04-02.
      - `status` 'deploying' | 'ready' | 'paused' | 'warming' | 'switching' | 'suspended' | 'error' | 'deleted': On /v1/deployments/* routes. (Deprecated routes return the pre-2026 value here and the new one in `deployment_status`.)
      - `legacy_status` string: Pre-2026 status value (e.g. `running` for `ready`); returned until 2027-04-02.
      - `model` string
      - `billing` 'subscription' | 'pay_as_you_go' | 'on_demand': Current billing mode. `pay_as_you_go` is canonical; `on_demand` is a back-compat alias; `subscription` is legacy and applies only to grandfathered accounts.
      - `label` string, nullable
      - `endpoint` string, nullable: Inference endpoint. OpenAI-compatible base URL is `{endpoint}/v1`.
      - `api_key` string, nullable: Per-deployment inference key. Use this in Authorization for /chat and /v1/chat/completions.
      - `webhook_url` string, nullable
      - `throughput` 'standard' | 'double' | 'quad' | 'max'
      - `throughput_multiplier` 1 | 2 | 4 | 8
      - `capacity` 1 | 2 | 4 | 8: Deprecated alias of `throughput_multiplier`; returned until 2027-04-02.
      - `system_prompt` string, nullable: Per-deployment system prompt. null = inherit account default.
      - `billing_details` union
        - object
          - `mode` 'subscription'
          - `plan` 'shared' | 'dedicated' | 'business' | 'enterprise'
          - `monthly_cost` number
          - `next_billing_date` string, nullable
        - object
          - `mode` 'pay_as_you_go'
          - `rate_per_hour` string
          - `hourly_rate` number: Deprecated alias of `rate_per_hour`; returned until 2027-04-02.
          - `accumulated_cost` number
          - `spending_cap` number, nullable
          - `paused_at` string, date-time, nullable
      - `created_at` string, date-time
      - `ready_at` string, date-time, nullable
      - `deleted_at` string, date-time, nullable
      - `destroyed_at` string, date-time, nullable: Deprecated alias of `deleted_at`; returned until 2027-04-02.
  - `meta` Meta, required
    - `requestId` string
    - `timestamp` string, date-time

---

[API](https://skmtc.dev/auxen/apis/auxen-headless-api.md) · [All operations](https://skmtc.dev/auxen/apis/auxen-headless-api/llms.txt) · [OpenAPI document](https://skmtc.dev/auxen/apis/auxen-headless-api/revisions/164be65f5ce8?raw)