API: Providers
REST API endpoints for querying bare-metal provider information.
API: Providers
Overview
The providers API exposes information about configured bare-metal providers, including available server types, locations, and current server inventory.
Endpoints
| Method | Path | Description |
|---|---|---|
| GET | /v1/providers | List configured providers |
| GET | /v1/providers/{name}/server-types | Available server types |
| GET | /v1/providers/{name}/locations | Available locations |
| GET | /v1/providers/{name}/servers | Current server inventory |
GET /v1/providers
{
"items": [
{"name": "hetzner", "status": "connected", "server_count": 12},
{"name": "ovh", "status": "connected", "server_count": 5},
{"name": "equinix", "status": "connected", "server_count": 3}
]
}
Get Server Types
GET /v1/providers/hetzner/server-types
{
"items": [
{"name": "cx11", "vcpus": 1, "memory_mb": 2048, "disk_gb": 20, "price_monthly": 3.29},
{"name": "cx21", "vcpus": 2, "memory_mb": 4096, "disk_gb": 40, "price_monthly": 5.83},
{"name": "cx31", "vcpus": 2, "memory_mb": 8192, "disk_gb": 80, "price_monthly": 10.49}
]
}
Get Locations
GET /v1/providers/hetzner/locations
{
"items": [
{"id": "fsn1", "name": "Falkenstein", "country": "DE"},
{"id": "nbg1", "name": "Nuremberg", "country": "DE"},
{"id": "hel1", "name": "Helsinki", "country": "FI"}
]
}
Get Server Inventory
GET /v1/providers/hetzner/servers
Returns the current list of servers provisioned through this provider.