---
title: "List"
method: GET
path: "/api/cp/setup/server"
tags: ["Setup Server"]
---

# List

`GET /api/cp/setup/server`

Retrieve a paginated list of Setup Server records. Supports filtering, sorting, and search.

## Query parameters

- `type` 'Database' | 'Switch' | 'Cache' | 'Dispatcher' | 'RTP' | 'PBX' | 'SIPTest' | 'Javascript' | 'Web' | 'Other' | '3CX' | 'Any-Dispatcher' | 'Registrar' | 'Turn' | 'AnyEdge-Dev' | 'AnyRTP-Control' | 'AnyRTP-Actuator' | 'Box'
- `status` 'Active' | 'Failed' | 'Paused' | 'Unallocated' | 'Expired' | 'Installing' | 'Upgrading'

## Response `200`

Successful response

- SetupServer[]
  - `id` integer — Id
  - `account_id` integer — Account Id
  - `type` 'Database' | 'Switch' | 'Cache' | 'Dispatcher' | 'RTP' | 'PBX' | 'SIPTest' | 'Javascript' | 'Web' | 'Other' | '3CX' | 'Any-Dispatcher' | 'Registrar' | 'Turn' | 'AnyEdge-Dev' | 'AnyRTP-Control' | 'AnyRTP-Actuator' | 'Box' — Type
  - `ip` string, ipv4 — Ip (unique)
  - `ipv6` string — Ipv 6
  - `alias` string — Alias
  - `status` 'Active' | 'Failed' | 'Paused' | 'Unallocated' | 'Expired' | 'Installing' | 'Upgrading' — Status
  - `managed` integer — Managed
  - `ssh_user` string — Ssh User
  - `ssh_password` string, password — Ssh Password
  - `port` integer — Port
  - `interconnect_form` string[] — Interconnect Form
  - `rtp_groups` string — Rtp Groups
  - `channels` integer — Channels
  - `cps` integer — Cps
  - `rtp_capacity` integer — Rtp Capacity
  - `last_activity` integer, nullable — Last Activity
  - `platform` string — Platform
  - `expire_date` string, date — Expire Date
  - `cost` number — Cost
  - `setting` string, binary — Setting
  - `setting_json` string — Setting Json
  - `capacity_302` string — Capacity 302
  - `cpu_count` integer — Cpu Count
  - `ram` integer — Ram
  - `s_mem` integer — S Mem
  - `p_mem` integer — P Mem
  - `processes` integer — Processes
  - `last_call` string, date-time, nullable — Last Call
  - `location` string — Location
  - `provider_id` string — Provider Id
  - `rack_info` string — Rack Info
  - `detailed_spec` string — Detailed Spec
  - `disk_size` string — Disk Size
  - `fqdn` string — Fqdn
  - `stale` integer — Stale
  - `startup_time` string, date-time — Startup Time
  - `approved_delete` string — Approved Delete
  - `internal_ip` string, ipv4 — Internal Ip
  - `tinc_private_key` string — Tinc Private Key
  - `tinc_public_key` string — Tinc Public Key
  - `upgrade_scheduled` string, date-time — Upgrade Scheduled
  - `cluster_id` integer — Cluster Id
  - `image_slug` string — Image Slug
  - `size_slug` string — Size Slug
  - `last_provision` string, date-time, nullable — Last Provision
  - `created_date` string, date-time — Created Date
  - `flags` string — Flags
  - `routing_zone` string — Routing Zone
  - `tasks` string — Tasks
  - `registrar` string — Registrar
  - `ansible_toml` string — Ansible Toml
  - `last_deploy` string, date-time, nullable — Last Deploy
  - `certs` string — Certs
  - `provider_cost_usd` number — Provider Cost Usd
  - `min_cost` number — Min Cost
  - `peak_min_cost` number — Peak Min Cost
  - `cpu_benchmark` integer — Cpu Benchmark
  - `box_id` integer — Box Id
  - `last_resize` string, date, nullable — Last Resize
  - `max_30_day_channels` integer — Max 30 Day Channels

## Other responses

- `400` — Bad Request - Invalid parameters or request body
- `401` — Authentication information is missing or invalid
- `403` — Access denied - insufficient permissions or dependency access failure
- `500` — Internal server error

---

[API](https://skmtc.dev/connexcs/apis/connexcs-control-panel-api.md) · [All operations](https://skmtc.dev/connexcs/apis/connexcs-control-panel-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/connexcs/connexcs-control-panel-api/revisions/54bc2ed6edae/schema)
