API v3
GET /iot/connectors/{name}
One cloud connector.
Addresshttps://api.voicepro.plus/v3/iot/connectors/{name}
Key permissionread
Fields
| Name | In | Type | |
|---|---|---|---|
| name * | path | string | The connector's name, as you gave it. |
* required
Example
curl -X GET "https://api.voicepro.plus/v3/iot/connectors/acme-ingest" \ -H "Authorization: Bearer vpkey_YOUR_KEY"
Response
{
"object": "iot_connector",
"name": "acme-ingest",
"type": "https",
"settings": {
"url": "https://ingest.example.com/iot"
},
"secrets": {},
"passthrough": [
{
"protocol": "tcp",
"ip": "203.0.113.10",
"port": 8883
}
],
"sim_count": 12
}Errors
Every error has the same shape: { "error": { "type", "code", "message", "param", "request_id" } }.
missing_api_key401: No Authorization header, or not a Bearer key.
invalid_api_key401: The key is not recognised.
api_key_revoked401: The key was revoked in the portal.
api_key_expired401: The key passed the expiry date set on it.
missing_scope403: The key lacks the scope this endpoint needs; param names the scope.
ip_not_allowed403: The key has an IP allowlist and this request came from elsewhere.
account_not_active403: The workspace is suspended or closed.
route_not_found404: No such path in v3.
resource_not_found404: No object with that id on this account.
service_not_enabled404: The account does not have this service (voice trunk, IoT, numbers); param names it.
rate_limited429: Too many requests for this key or for the whole account (the message says which); wait Retry-After seconds.
upstream_unavailable503: A network partner or data service behind this endpoint is unavailable.
network_action_unavailable503: This network action is not switched on for the account yet (for example SIM suspend).
internal_error500: Our fault. Quote the request_id to support.
service_unavailable503: API v3 itself is briefly unavailable (for example a configuration problem on our side); the rest of VoicePro is unaffected. Retry later.