Setup Server
List
Retrieve a paginated list of Setup Server records. Supports filtering, sorting, and search.
get/api/cp/setup/server
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'
Filter by Type
status'Active' | 'Failed' | 'Paused' | 'Unallocated' | 'Expired' | 'Installing' | 'Upgrading'
Filter by Status
Response
Successful response
Example response
[
{
"id": 12345,
"account_id": 1,
"type": "Database",
"ip": "192.168.1.1",
"ipv6": "example_ipv6",
"alias": "example_alias",
"status": "Active",
"managed": 1,
"ssh_user": "example_ssh_user",
"ssh_password": "example_ssh_password",
"port": 123,
"interconnect_form": "termination-ingress",
"rtp_groups": "example_rtp_groups",
"channels": 123,
"cps": 123,
"rtp_capacity": 123,
"last_activity": 1000000,
"platform": "example_platform",
"expire_date": "2025-01-17T10:30:00Z",
"cost": 99.99,
"setting": "base64-encoded-data",
"setting_json": "Sample setting_json text content",
"capacity_302": "example_capacity_302",
"cpu_count": 10,
"ram": 123,
"s_mem": 123,
"p_mem": 123,
"processes": 123,
"last_call": "2025-01-17T10:30:00Z",
"location": "example_location",
"provider_id": 1,
"rack_info": "example_rack_info",
"detailed_spec": "example_detailed_spec",
"disk_size": "example_disk_size",
"fqdn": "example_fqdn",
"stale": 1,
"startup_time": "2025-01-17T10:30:00Z",
"approved_delete": "example_approved_delete",
"internal_ip": "example_internal_ip",
"tinc_private_key": "example_tinc_private_key",
"tinc_public_key": "example_tinc_public_key",
"upgrade_scheduled": "2025-01-17T10:30:00Z",
"cluster_id": 1,
"image_slug": "example_image_slug",
"size_slug": "example_size_slug",
"last_provision": "2025-01-17T10:30:00Z",
"created_date": "2025-01-17T10:30:00Z",
"flags": "example_flags",
"routing_zone": "example_routing_zone",
"tasks": "example_tasks",
"registrar": "example_registrar",
"ansible_toml": "Sample ansible_toml text content",
"last_deploy": "2025-01-17T10:30:00Z",
"certs": "example_certs",
"provider_cost_usd": 99.99,
"min_cost": 99.99,
"peak_min_cost": 99.99,
"cpu_benchmark": 1000000,
"box_id": 1,
"last_resize": "2025-01-17",
"max_30_day_channels": 123
}
]Changes
No recorded changes to this endpoint across all 1 revision of this API.