DEVELOPER · REST API REFERENCE
Explore machine-readable endpoints for health diagnostics, pricing scopes, dynamic SKU discovery, architectural cost estimates, and price sheet synchronization.
INTERACTIVE ENVIRONMENT
Configure your target server and bearer token to dynamically update all code snippets across the catalog in real time.
REST ENDPOINTS
Select any endpoint from the catalog to jump directly to its specification and code examples.
HEALTH & DIAGNOSTICS
/api/healthReturns service status, local Azure CLI authentication status, SQLite database timestamps, and active pricing snapshots.
{ "ok": true, "version": "v0.1.0", "status": "ok", "azure_cli": { "available": true, "authenticated": true } }
PRICING SCOPES
/api/pricing/scopesLists all configured contract pricing scopes (e.g. EA Enrollment ea:65220517) with currency, provider type, and active status.
{ "ok": true, "scopes": [ { "scope_id": "ea:65220517", "currency": "BRL", "active": true } ] }
PRICING SCOPES
/api/pricing/scopes/{scope}/syncReturns current synchronization state, row count, and active snapshot metadata for a specific pricing scope.
| Parameter | Type | Description |
|---|---|---|
scope Required | string (path) | Scope identifier (e.g. ea:65220517) |
{ "ok": true, "scope_id": "ea:65220517", "snapshot": { "row_count": 107065, "status": "completed" } }
PRODUCT CATALOG
/api/catalog/productsLists product definitions supported by the pricing engine (virtual_machine, managed_disk, sql_database).
{ "ok": true, "products": [ { "id": "virtual_machine", "label": "Virtual Machine" } ] }
PRODUCT CATALOG
/api/catalog/products/{id}/options/{field}Returns dynamic options for dropdown fields. For VM shapes (field=sku), returns complete shapes across all generations (v1 to v7) with vCPUs, RAM and EA availability.
| Parameter | Type | Description |
|---|---|---|
region Required | string (query) | ARM region (e.g. brazilsouth, eastus) |
os Optional | string (query) | Operating system (linux or windows) |
{ "ok": true, "options": [ { "value": "Standard_D4s_v5", "label": "Standard_D4s_v5 (4 vCPU · 16 GB RAM)" } ] }
PRODUCT CATALOG
/api/skusQuick shape list for a region annotated with hardware specifications and pricing source indicators.
{ "ok": true, "region": "brazilsouth", "skus": [ { "name": "Standard_D4s_v5", "vcpus": 4, "memory_gb": 16.0 } ] }
ESTIMATES & CALCULATIONS
/api/estimateCalculates a composite architecture estimate comparing Retail vs negotiated EA Contract across PAYG, 1Y RI, 3Y RI, and Savings Plans.
| Field | Type | Description |
|---|---|---|
pricing_scope Required | string (body) | Scope identifier (e.g. ea:65220517) |
lines Required | array (body) | Array of product configuration line items |
{ "ok": true, "currency": "BRL", "totals": { "retail": { "payg_monthly": 2450.80 }, "corporate": { "payg_monthly": 1820.50 } } }
ESTIMATES & CALCULATIONS
/api/estimateQuick single-line estimate calculation using URL query parameters.
{ "ok": true, "currency": "BRL", "totals": { "corporate": { "payg_monthly": 910.25 } } }
ENTERPRISE AGREEMENT (EA)
/api/ea/metersSearch and filter corporate negotiated price sheet meters by text query, category, and meter location.
{ "ok": true, "count": 4, "rows": [ { "meterId": "6c6fb48f-4ee0-555e-a5bc-4a4f0b2fe489", "meterName": "D4s v5", "unitPrice": 175.66 } ] }
ENTERPRISE AGREEMENT (EA)
/api/ea/calculateCalculates monthly cost for a specific corporate EA meter given quantity and hours.
{ "ok": true, "monthly_cost": 175.66, "currency": "BRL" }
DATA SYNCHRONIZATION
/api/sync/billingTriggers an automated background pull of the Billing Account Price Sheet from Azure.
{ "ok": true, "status": "completed", "items": 107065 }
DATA SYNCHRONIZATION
/api/sync/retailTriggers an automated background pull of the latest Retail prices snapshot.
{ "ok": true, "status": "completed" }
DATA SYNCHRONIZATION
/api/import/ea-pricesheetUploads and ingests a ZIP or CSV file exported from the Azure Portal for manual pricing update.
{ "ok": true, "status": "completed", "row_count": 107065 }