Read the platform settings entries
GET /v1/platform/settings
| Property | Value |
|---|---|
| Operation | get_platform_settings |
| Group | Platform |
| Scope | platform:read |
| Route class | read |
| Idempotency | No Idempotency-Key |
| Audit | Not audited: A configuration read; the entries are platform data. |
| Released in | 1.9.0 |
| Phase 0 host | Served (the hosted api pins 1.65.0) |
Request
Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the platform:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.
curl "$VOCAL_API/v1/platform/settings" \
-H "Authorization: Bearer $VOCAL_API_KEY"const response = await fetch(`${process.env.VOCAL_API}/v1/platform/settings`, {
headers: {
Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
},
});
console.log(response.status, await response.text());import os
import requests
response = requests.get(
f"{os.environ['VOCAL_API']}/v1/platform/settings",
headers={
"Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
},
)
print(response.status_code, response.text)Responses
| Status | Content type | Shape | Error codes |
|---|---|---|---|
200 | application/json | PlatformSettings | |
400 | application/json | ErrorEnvelope | invalid_request |
401 | application/json | ErrorEnvelope | unauthenticated |
403 | application/json | ErrorEnvelope | forbidden |
429 | application/json | ErrorEnvelope | rate_limited |
500 | application/json | ErrorEnvelope | internal_error |
Fields of the 200 answer
The shape is PlatformSettings.
| Field | Type | Required | Description |
|---|---|---|---|
carrier_leg | CarrierLegSecurity or null | no | What the deployment sets the SIP trunks to (1.34.0), read-only and not part of the entries or their version: PATCH /v1/platform/settings refuses a body that names it. Null when the deployment sets none; a reader treats its absence as null, as from an api before 1.34.0. |
entries | array of PlatformEntry | yes | |
object | "platform_settings" | yes | |
price_ceiling_factor | PriceCeilingFactor | no | The factor of the price ceiling in force (1.38.0, PriceCeilingFactor): a new vendor price entry above it times the highest price in force of the same unit is refused with price_above_ceiling. The api from 1.38.0 always sends it; a reader treats its absence as 2, the default. |
updated_at | Timestamp or null | yes | |
updated_by | ActorRef or null | yes | |
version | integer | yes | 0 before the first replacement; the ETag. |