{
"item": [
{
"id": "de265168-e4c9-46fb-af52-205f468612b3",
"name": "cloud-connector",
"description": {
"content": "",
"type": "text/plain"
},
"item": [
{
"id": "8531619e-cdbb-4056-8173-d804c1948e2f",
"name": "Connector - DELETE",
"request": {
"name": "Connector - DELETE",
"description": {
"content": "Forward DELETE requests to UniFi applications using RESTful HTTP methods.
**Request Flow**: The request is proxied through `api.ui.com` cloud endpoint to the remote console at `http://127.0.0.1/proxy/[path]` with DELETE method.
**Requirements**:
- Console firmware version must >= 5.0.3
- For non-organization API keys: Limited to API key owner's consoles only (cannot access other admins' consoles)
- For organization API keys: Can access any console within the organization
**Rate Limit**:
- Each console is limited to 100 requests per minute
**Limits**:
- Request timeout: each proxied request must complete within 25 seconds; otherwise it is terminated and a timeout error is returned
- Response body size: the upstream response body is limited to 10 MB; larger responses are not supported
**API Documentation**:
- Network API: [https://developer.ui.com/network](https://developer.ui.com/network)
- Protect API: [https://developer.ui.com/protect](https://developer.ui.com/protect)
- InnerSpace API: [https://developer.ui.com/innerspace](https://developer.ui.com/innerspace)
**Response**: On success, the upstream API response is passed through directly. On error, a standardized error schema is returned.",
"type": "text/plain"
},
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"auth": null
},
"response": [
{
"id": "3edace77-3b84-4b30-8bf8-3e6023596c74",
"name": "200",
"originalRequest": {
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"vouchersDeleted\": 0\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "d6e39a43-0f16-4fc5-b16f-edffb4e16a14",
"name": "400",
"originalRequest": {
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"parameter_invalid\",\n \"httpStatusCode\": 400,\n \"message\": \"path is invalid\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "8faafb9e-9639-4a86-8cd5-ef0d4b1a6424",
"name": "401",
"originalRequest": {
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"body": {}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"unauthorized\",\n \"httpStatusCode\": 401,\n \"message\": \"unauthorized\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "2bf4ef81-8da1-4523-849b-adbc9a067267",
"name": "403",
"originalRequest": {
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"body": {}
},
"status": "Forbidden",
"code": 403,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"forbidden\",\n \"httpStatusCode\": 403,\n \"message\": \"insufficient permissions or not the owner of the host\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "8739d3db-e013-42eb-b99f-9feabda9f853",
"name": "408",
"originalRequest": {
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"body": {}
},
"status": "Request Timeout",
"code": 408,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"DeviceTimeout\",\n \"httpStatusCode\": 408,\n \"message\": \"Device connection timeout\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "fed56e08-313b-41fb-9551-56525d3b568b",
"name": "429",
"originalRequest": {
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"body": {}
},
"status": "Too Many Requests",
"code": 429,
"header": [
{
"disabled": false,
"key": "Retry-After",
"value": "5",
"description": ""
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"rate_limit\",\n \"httpStatusCode\": 429,\n \"message\": \"rate limit exceeded, retry after 5.372786998s\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "72ca7363-dc9e-4792-a882-1c2a27d09601",
"name": "500",
"originalRequest": {
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"body": {}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"server_error\",\n \"httpStatusCode\": 500,\n \"message\": \"failed to proxy request\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "8f61832c-b4e7-4899-8548-7290c6624d55",
"name": "502",
"originalRequest": {
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "DELETE",
"body": {}
},
"status": "Bad Gateway",
"code": 502,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"bad_gateway\",\n \"httpStatusCode\": 502,\n \"message\": \"bad gateway\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "79f70f1c-6fe4-4dca-8817-dfbea18ef7d3",
"name": "Connector - GET",
"request": {
"name": "Connector - GET",
"description": {
"content": "Forward GET requests to UniFi applications using RESTful HTTP methods.
**Request Flow**: The request is proxied through `api.ui.com` cloud endpoint to the remote console at `http://127.0.0.1/proxy/[path]` with GET method.
**Requirements**:
- Console firmware version must >= 5.0.3
- For non-organization API keys: Limited to API key owner's consoles only (cannot access other admins' consoles)
- For organization API keys: Can access any console within the organization
**Rate Limit**:
- Each console is limited to 100 requests per minute
**Limits**:
- Request timeout: each proxied request must complete within 25 seconds; otherwise it is terminated and a timeout error is returned
- Response body size: the upstream response body is limited to 10 MB; larger responses are not supported
**API Documentation**:
- Network API: [https://developer.ui.com/network](https://developer.ui.com/network)
- Protect API: [https://developer.ui.com/protect](https://developer.ui.com/protect)
- InnerSpace API: [https://developer.ui.com/innerspace](https://developer.ui.com/innerspace)
**Examples**:
- Network: `GET /v1/connector/consoles/{id}/network/integration/v1/sites` retrieves network sites
- Protect: `GET /v1/connector/consoles/{id}/protect/integration/v1/meta/info` retrieves protect application info
**Response**: On success, the upstream API response is passed through directly. On error, a standardized error schema is returned.",
"type": "text/plain"
},
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"auth": null
},
"response": [
{
"id": "78b71dac-3be9-43e4-9d9d-909a32c445fb",
"name": "200",
"originalRequest": {
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"count\": 1,\n \"data\": [\n {\n \"id\": \"88f7af54-98f8-306a-a1c7-c9349722b1f6\",\n \"internalReference\": \"default\",\n \"name\": \"Default\"\n }\n ],\n \"limit\": 25,\n \"offset\": 0,\n \"totalCount\": 1\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "d88882fb-e3cc-4ae4-96f7-9218edceb0fa",
"name": "400",
"originalRequest": {
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"parameter_invalid\",\n \"httpStatusCode\": 400,\n \"message\": \"path is invalid\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "203eba65-dfc0-4464-a636-719f1f93d7d4",
"name": "401",
"originalRequest": {
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"unauthorized\",\n \"httpStatusCode\": 401,\n \"message\": \"unauthorized\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "9cf3dc93-658e-4a71-93ca-4a8d58fb4f11",
"name": "403",
"originalRequest": {
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Forbidden",
"code": 403,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"forbidden\",\n \"httpStatusCode\": 403,\n \"message\": \"insufficient permissions or not the owner of the host\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "0a0d2a56-d3f8-4083-aad5-ee1478d6dd2b",
"name": "408",
"originalRequest": {
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Request Timeout",
"code": 408,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"DeviceTimeout\",\n \"httpStatusCode\": 408,\n \"message\": \"Device connection timeout\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "a8a22263-894f-4e30-9d31-709e7ceb286d",
"name": "429",
"originalRequest": {
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Too Many Requests",
"code": 429,
"header": [
{
"disabled": false,
"key": "Retry-After",
"value": "5",
"description": ""
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"rate_limit\",\n \"httpStatusCode\": 429,\n \"message\": \"rate limit exceeded, retry after 5.372786998s\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "d08ce6cc-e1de-4cd0-84c3-b520b2360033",
"name": "500",
"originalRequest": {
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"server_error\",\n \"httpStatusCode\": 500,\n \"message\": \"failed to proxy request\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "037dd155-2b2e-4d3b-939d-cbf928deeee4",
"name": "502",
"originalRequest": {
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Gateway",
"code": 502,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"bad_gateway\",\n \"httpStatusCode\": 502,\n \"message\": \"bad gateway\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "c7206fe8-165e-4c59-b5aa-eb49697234ce",
"name": "Connector - PATCH",
"request": {
"name": "Connector - PATCH",
"description": {
"content": "Forward PATCH requests to UniFi applications using RESTful HTTP methods.
**Request Flow**: The request is proxied through `api.ui.com` cloud endpoint to the remote console at `http://127.0.0.1/proxy/[path]` with PATCH method.
**Requirements**:
- Console firmware version must >= 5.0.3
- For non-organization API keys: Limited to API key owner's consoles only (cannot access other admins' consoles)
- For organization API keys: Can access any console within the organization
**Rate Limit**:
- Each console is limited to 100 requests per minute
**Limits**:
- Request timeout: each proxied request must complete within 25 seconds; otherwise it is terminated and a timeout error is returned
- Response body size: the upstream response body is limited to 10 MB; larger responses are not supported
**API Documentation**:
- Network API: [https://developer.ui.com/network](https://developer.ui.com/network)
- Protect API: [https://developer.ui.com/protect](https://developer.ui.com/protect)
- InnerSpace API: [https://developer.ui.com/innerspace](https://developer.ui.com/innerspace)
**Response**: On success, the upstream API response is passed through directly. On error, a standardized error schema is returned.",
"type": "text/plain"
},
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PATCH",
"auth": null,
"body": {
"mode": "raw",
"raw": "{\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"id": "83467cd5-7e56-43b7-99ce-bf0a53197bce",
"name": "200",
"originalRequest": {
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PATCH",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Updated Viewer Name\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"507f1f77bcf86cd799439011\",\n \"liveview\": \"507f1f77bcf86cd799439012\",\n \"modelKey\": \"viewer\",\n \"name\": \"Living Room Viewer\",\n \"state\": \"CONNECTED\",\n \"streamLimit\": 4\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "8dab0e8f-410e-4135-9893-f94f824ce11d",
"name": "400",
"originalRequest": {
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PATCH",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Updated Viewer Name\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"parameter_invalid\",\n \"httpStatusCode\": 400,\n \"message\": \"path is invalid\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "e75f64e6-b1a0-4fa0-beca-eed4d872e6bb",
"name": "401",
"originalRequest": {
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PATCH",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Updated Viewer Name\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"unauthorized\",\n \"httpStatusCode\": 401,\n \"message\": \"unauthorized\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "8716119c-0a0c-402c-b626-d363076e89f1",
"name": "403",
"originalRequest": {
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PATCH",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Updated Viewer Name\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "Forbidden",
"code": 403,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"forbidden\",\n \"httpStatusCode\": 403,\n \"message\": \"insufficient permissions or not the owner of the host\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "ca13651f-97fa-4fff-86e1-7c6709f2733d",
"name": "408",
"originalRequest": {
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PATCH",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Updated Viewer Name\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "Request Timeout",
"code": 408,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"DeviceTimeout\",\n \"httpStatusCode\": 408,\n \"message\": \"Device connection timeout\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "39019929-931c-4394-b01f-8dba84c2bef4",
"name": "429",
"originalRequest": {
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PATCH",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Updated Viewer Name\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "Too Many Requests",
"code": 429,
"header": [
{
"disabled": false,
"key": "Retry-After",
"value": "5",
"description": ""
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"rate_limit\",\n \"httpStatusCode\": 429,\n \"message\": \"rate limit exceeded, retry after 5.372786998s\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "69b73f18-194f-4399-a322-444107ebe213",
"name": "500",
"originalRequest": {
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PATCH",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Updated Viewer Name\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"server_error\",\n \"httpStatusCode\": 500,\n \"message\": \"failed to proxy request\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "7b88962d-94d4-4b76-b223-959b23a57e69",
"name": "502",
"originalRequest": {
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PATCH",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Updated Viewer Name\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "Bad Gateway",
"code": 502,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"bad_gateway\",\n \"httpStatusCode\": 502,\n \"message\": \"bad gateway\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "31b65110-6f1f-4870-8166-aa03b23eb75d",
"name": "Connector - POST",
"request": {
"name": "Connector - POST",
"description": {
"content": "Forward POST requests to UniFi applications using RESTful HTTP methods.
**Request Flow**: The request is proxied through `api.ui.com` cloud endpoint to the remote console at `http://127.0.0.1/proxy/[path]` with POST method.
**Requirements**:
- Console firmware version must >= 5.0.3
- For non-organization API keys: Limited to API key owner's consoles only (cannot access other admins' consoles)
- For organization API keys: Can access any console within the organization
**Rate Limit**:
- Each console is limited to 100 requests per minute
**Limits**:
- Request timeout: each proxied request must complete within 25 seconds; otherwise it is terminated and a timeout error is returned
- Response body size: the upstream response body is limited to 10 MB; larger responses are not supported
**API Documentation**:
- Network API: [https://developer.ui.com/network](https://developer.ui.com/network)
- Protect API: [https://developer.ui.com/protect](https://developer.ui.com/protect)
- InnerSpace API: [https://developer.ui.com/innerspace](https://developer.ui.com/innerspace)
**Response**: On success, the upstream API response is passed through directly. On error, a standardized error schema is returned.",
"type": "text/plain"
},
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"auth": null,
"body": {
"mode": "raw",
"raw": "{\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"id": "242562cc-8dbe-4dbe-90ee-3163da0d3703",
"name": "200",
"originalRequest": {
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"action\": \"AUTHORIZE_GUEST_ACCESS\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"success\": true\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "79676c49-f785-4e83-88db-9f83586e5279",
"name": "400",
"originalRequest": {
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"action\": \"AUTHORIZE_GUEST_ACCESS\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"parameter_invalid\",\n \"httpStatusCode\": 400,\n \"message\": \"path is invalid\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "904da68b-326d-40a3-8662-2343ac63fbc3",
"name": "401",
"originalRequest": {
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"action\": \"AUTHORIZE_GUEST_ACCESS\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"unauthorized\",\n \"httpStatusCode\": 401,\n \"message\": \"unauthorized\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "e6b7461d-e84a-4973-b5df-836fb95e8814",
"name": "403",
"originalRequest": {
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"action\": \"AUTHORIZE_GUEST_ACCESS\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "Forbidden",
"code": 403,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"forbidden\",\n \"httpStatusCode\": 403,\n \"message\": \"insufficient permissions or not the owner of the host\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "5d47ff14-b478-449a-9a63-1f54f020742f",
"name": "408",
"originalRequest": {
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"action\": \"AUTHORIZE_GUEST_ACCESS\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "Request Timeout",
"code": 408,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"DeviceTimeout\",\n \"httpStatusCode\": 408,\n \"message\": \"Device connection timeout\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "4afe2496-4751-4dd0-830e-79dda332d2aa",
"name": "429",
"originalRequest": {
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"action\": \"AUTHORIZE_GUEST_ACCESS\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "Too Many Requests",
"code": 429,
"header": [
{
"disabled": false,
"key": "Retry-After",
"value": "5",
"description": ""
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"rate_limit\",\n \"httpStatusCode\": 429,\n \"message\": \"rate limit exceeded, retry after 5.372786998s\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "2dcba1a5-c439-41af-9d9f-f8222651be26",
"name": "500",
"originalRequest": {
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"action\": \"AUTHORIZE_GUEST_ACCESS\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"server_error\",\n \"httpStatusCode\": 500,\n \"message\": \"failed to proxy request\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "7e56c451-86a9-4321-b129-acc1057ffa4f",
"name": "502",
"originalRequest": {
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"action\": \"AUTHORIZE_GUEST_ACCESS\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "Bad Gateway",
"code": 502,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"bad_gateway\",\n \"httpStatusCode\": 502,\n \"message\": \"bad gateway\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "eaecd0e1-ffdd-42c0-b378-a34d57061a10",
"name": "Connector - PUT",
"request": {
"name": "Connector - PUT",
"description": {
"content": "Forward PUT requests to UniFi applications using RESTful HTTP methods.
**Request Flow**: The request is proxied through `api.ui.com` cloud endpoint to the remote console at `http://127.0.0.1/proxy/[path]` with PUT method.
**Requirements**:
- Console firmware version must >= 5.0.3
- For non-organization API keys: Limited to API key owner's consoles only (cannot access other admins' consoles)
- For organization API keys: Can access any console within the organization
**Rate Limit**:
- Each console is limited to 100 requests per minute
**Limits**:
- Request timeout: each proxied request must complete within 25 seconds; otherwise it is terminated and a timeout error is returned
- Response body size: the upstream response body is limited to 10 MB; larger responses are not supported
**API Documentation**:
- Network API: [https://developer.ui.com/network](https://developer.ui.com/network)
- Protect API: [https://developer.ui.com/protect](https://developer.ui.com/protect)
- InnerSpace API: [https://developer.ui.com/innerspace](https://developer.ui.com/innerspace)
**Response**: On success, the upstream API response is passed through directly. On error, a standardized error schema is returned.",
"type": "text/plain"
},
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"auth": null,
"body": {
"mode": "raw",
"raw": "{\n \"key_0\": {},\n \"key_1\": {},\n \"key_2\": {}\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"id": "72a4d489-9f8d-405d-a805-d07f6521cae5",
"name": "200",
"originalRequest": {
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Updated Firewall Zone\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"id\": \"ffcdb32c-6278-4364-8947-df4f77118df8\",\n \"metadata\": {\n \"isConfigurable\": true,\n \"type\": \"system\"\n },\n \"name\": \"External\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "34879f75-97bf-4c9f-bcb3-aabaddcdd589",
"name": "400",
"originalRequest": {
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Updated Firewall Zone\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"parameter_invalid\",\n \"httpStatusCode\": 400,\n \"message\": \"path is invalid\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "7b003143-42ad-4397-95fb-d15f817b1ff5",
"name": "401",
"originalRequest": {
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Updated Firewall Zone\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"unauthorized\",\n \"httpStatusCode\": 401,\n \"message\": \"unauthorized\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "b84615b1-48e2-4d73-abde-f27a75f8af9b",
"name": "403",
"originalRequest": {
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Updated Firewall Zone\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "Forbidden",
"code": 403,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"forbidden\",\n \"httpStatusCode\": 403,\n \"message\": \"insufficient permissions or not the owner of the host\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "1d6a9228-a2df-4357-ae82-e6c4d26f3553",
"name": "408",
"originalRequest": {
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Updated Firewall Zone\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "Request Timeout",
"code": 408,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"DeviceTimeout\",\n \"httpStatusCode\": 408,\n \"message\": \"Device connection timeout\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "8d053f13-3b56-4e25-911b-7edd2ea79461",
"name": "429",
"originalRequest": {
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Updated Firewall Zone\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "Too Many Requests",
"code": 429,
"header": [
{
"disabled": false,
"key": "Retry-After",
"value": "5",
"description": ""
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"rate_limit\",\n \"httpStatusCode\": 429,\n \"message\": \"rate limit exceeded, retry after 5.372786998s\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "74c3d735-c566-4a18-83d4-63fdc2216ba6",
"name": "500",
"originalRequest": {
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Updated Firewall Zone\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"server_error\",\n \"httpStatusCode\": 500,\n \"message\": \"failed to proxy request\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "c5b82b72-2fc2-4eb1-a1f5-effa39e1347f",
"name": "502",
"originalRequest": {
"url": {
"path": [
"v1",
"connector",
"consoles",
":id",
"*path"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Host ID to proxy the request to"
},
{
"disabled": false,
"type": "any",
"value": "",
"key": "path",
"description": "(Required) API path to proxy"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "PUT",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"Updated Firewall Zone\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "Bad Gateway",
"code": 502,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"bad_gateway\",\n \"httpStatusCode\": 502,\n \"message\": \"bad gateway\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
],
"event": []
},
{
"id": "98eb1ac0-7196-45d4-ae8c-16b5208b9966",
"name": "List Devices",
"request": {
"name": "List Devices",
"description": {
"content": "Retrieves a list of UniFi devices managed by hosts where the UI account making the API call is the owner or a super admin.
**Note**: The structure of the `devices.uidb` field may vary depending on the UniFi OS or Network Server version. The example provided is based on UniFi OS 4.1.13.",
"type": "text/plain"
},
"url": {
"path": [
"v1",
"devices"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"key": "hostIds[]",
"value": "",
"description": "List of host IDs to filter the results"
},
{
"disabled": false,
"key": "hostIds[]",
"value": "",
"description": "List of host IDs to filter the results"
},
{
"disabled": false,
"key": "time",
"value": "",
"description": "Last processed timestamp of devices in RFC3339 format"
},
{
"disabled": false,
"key": "pageSize",
"value": "",
"description": "Number of items to return per page"
},
{
"disabled": false,
"key": "nextToken",
"value": "",
"description": "Token for pagination to retrieve the next set of results"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"auth": null
},
"response": [
{
"id": "7f4206f0-036f-4b2d-b516-05840520d683",
"name": "200",
"originalRequest": {
"url": {
"path": [
"v1",
"devices"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"key": "hostIds[]",
"value": "900A6F00301100000000074A6BA90000000007A3387E0000000063EC9853:123456789"
},
{
"key": "hostIds[]",
"value": "900A6F00301100000000074A6BA90000000007A3387E0000000063EC9853:987654321"
},
{
"key": "time",
"value": "2026-06-15T07:21:27Z"
},
{
"key": "pageSize",
"value": "10"
},
{
"key": "nextToken",
"value": "602232A870250000000006C514FF00000000073DD8DB000000006369FDA2:1467082514"
}
],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"data\": [\n {\n \"hostId\": \"900A6F00301100000000074A6BA90000000007A3387E0000000063EC9853:123456789\",\n \"hostName\": \"unifi.yourdomain.com\",\n \"devices\": [\n {\n \"id\": \"F4E2C6C23F13\",\n \"mac\": \"F4E2C6C23F13\",\n \"name\": \"unifi.yourdomain.com\",\n \"model\": \"UDM SE\",\n \"shortname\": \"UDMPROSE\",\n \"ip\": \"192.168.1.226\",\n \"productLine\": \"network\",\n \"status\": \"online\",\n \"version\": \"4.1.13\",\n \"firmwareStatus\": \"upToDate\",\n \"updateAvailable\": null,\n \"isConsole\": true,\n \"isManaged\": true,\n \"startupTime\": \"2024-06-19T13:41:43Z\",\n \"adoptionTime\": null,\n \"note\": null,\n \"uidb\": {\n \"guid\": \"0fd8c390-a0e8-4cb2-b93a-7b3051c83c46\",\n \"id\": \"e85485da-54c3-4906-8f19-3cef4116ff02\",\n \"images\": {\n \"default\": \"3008400039c483c496f4ad820242c447\",\n \"nopadding\": \"67b553529d0e523ca9dd4826076c5f3f\",\n \"topology\": \"8371ecdda1f00f1636a2eefadf0d7d47\"\n }\n }\n }\n ],\n \"updatedAt\": \"2026-06-15T07:21:27Z\"\n }\n ],\n \"httpStatusCode\": 200,\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\",\n \"nextToken\": \"ba8e384e-3308-4236-b344-7357657351ca\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "c55618be-0a23-4bf0-9c3a-023cfd06924a",
"name": "400",
"originalRequest": {
"url": {
"path": [
"v1",
"devices"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"key": "hostIds[]",
"value": "900A6F00301100000000074A6BA90000000007A3387E0000000063EC9853:123456789"
},
{
"key": "hostIds[]",
"value": "900A6F00301100000000074A6BA90000000007A3387E0000000063EC9853:987654321"
},
{
"key": "time",
"value": "2026-06-15T07:21:27Z"
},
{
"key": "pageSize",
"value": "10"
},
{
"key": "nextToken",
"value": "602232A870250000000006C514FF00000000073DD8DB000000006369FDA2:1467082514"
}
],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"parameter_invalid\",\n \"httpStatusCode\": 400,\n \"message\": \"invalid time format: 2024-04-24\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "e8a7cfa1-1cc9-4cb8-9073-fa86b6af1c04",
"name": "401",
"originalRequest": {
"url": {
"path": [
"v1",
"devices"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"key": "hostIds[]",
"value": "900A6F00301100000000074A6BA90000000007A3387E0000000063EC9853:123456789"
},
{
"key": "hostIds[]",
"value": "900A6F00301100000000074A6BA90000000007A3387E0000000063EC9853:987654321"
},
{
"key": "time",
"value": "2026-06-15T07:21:27Z"
},
{
"key": "pageSize",
"value": "10"
},
{
"key": "nextToken",
"value": "602232A870250000000006C514FF00000000073DD8DB000000006369FDA2:1467082514"
}
],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"unauthorized\",\n \"httpStatusCode\": 401,\n \"message\": \"unauthorized\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "e4f5ba15-4653-452c-8336-b7be9c2b1ae0",
"name": "429",
"originalRequest": {
"url": {
"path": [
"v1",
"devices"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"key": "hostIds[]",
"value": "900A6F00301100000000074A6BA90000000007A3387E0000000063EC9853:123456789"
},
{
"key": "hostIds[]",
"value": "900A6F00301100000000074A6BA90000000007A3387E0000000063EC9853:987654321"
},
{
"key": "time",
"value": "2026-06-15T07:21:27Z"
},
{
"key": "pageSize",
"value": "10"
},
{
"key": "nextToken",
"value": "602232A870250000000006C514FF00000000073DD8DB000000006369FDA2:1467082514"
}
],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Too Many Requests",
"code": 429,
"header": [
{
"disabled": false,
"key": "Retry-After",
"value": "5",
"description": ""
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"rate_limit\",\n \"httpStatusCode\": 429,\n \"message\": \"rate limit exceeded, retry after 5.372786998s\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "3b7f31ef-8124-470a-9f9b-ed0ee72d8651",
"name": "500",
"originalRequest": {
"url": {
"path": [
"v1",
"devices"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"key": "hostIds[]",
"value": "900A6F00301100000000074A6BA90000000007A3387E0000000063EC9853:123456789"
},
{
"key": "hostIds[]",
"value": "900A6F00301100000000074A6BA90000000007A3387E0000000063EC9853:987654321"
},
{
"key": "time",
"value": "2026-06-15T07:21:27Z"
},
{
"key": "pageSize",
"value": "10"
},
{
"key": "nextToken",
"value": "602232A870250000000006C514FF00000000073DD8DB000000006369FDA2:1467082514"
}
],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"server_error\",\n \"httpStatusCode\": 500,\n \"message\": \"failed to list devices\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "8bcdde52-2e53-45d2-a9f0-87b8db7eca98",
"name": "502",
"originalRequest": {
"url": {
"path": [
"v1",
"devices"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"key": "hostIds[]",
"value": "900A6F00301100000000074A6BA90000000007A3387E0000000063EC9853:123456789"
},
{
"key": "hostIds[]",
"value": "900A6F00301100000000074A6BA90000000007A3387E0000000063EC9853:987654321"
},
{
"key": "time",
"value": "2026-06-15T07:21:27Z"
},
{
"key": "pageSize",
"value": "10"
},
{
"key": "nextToken",
"value": "602232A870250000000006C514FF00000000073DD8DB000000006369FDA2:1467082514"
}
],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Gateway",
"code": 502,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"bad_gateway\",\n \"httpStatusCode\": 502,\n \"message\": \"bad gateway\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "8b3cb110-442b-4ddf-86a0-e096eed3360a",
"name": "List Hosts",
"request": {
"name": "List Hosts",
"description": {
"content": "Retrieves a list of all hosts associated with the UI account making the API call.
**Note**: The structure of `userData` and `reportedState` fields may vary depending on the UniFi OS or Network Server version. The example provided is based on UniFi OS 4.1.13.",
"type": "text/plain"
},
"url": {
"path": [
"v1",
"hosts"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"key": "pageSize",
"value": "",
"description": "Number of items to return per page"
},
{
"disabled": false,
"key": "nextToken",
"value": "",
"description": "Token for pagination to retrieve the next set of results"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"auth": null
},
"response": [
{
"id": "54c15b82-dbdf-44fe-a66d-82cda1ae1818",
"name": "200",
"originalRequest": {
"url": {
"path": [
"v1",
"hosts"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"key": "pageSize",
"value": "10"
},
{
"key": "nextToken",
"value": "602232A870250000000006C514FF00000000073DD8DB000000006369FDA2:1467082514"
}
],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"data\": [\n {\n \"id\": \"70A7419783ED0000000006797F060000000006C719490000000062ABD4EA:1261206302\",\n \"hardwareId\": \"e5bf13cd-98a7-5a96-9463-0d65d78cd3a4\",\n \"type\": \"ucore\",\n \"ipAddress\": \"220.130.137.169\",\n \"owner\": true,\n \"isBlocked\": false,\n \"registrationTime\": \"\",\n \"lastConnectionStateChange\": \"2024-04-16T02:52:54.193Z\",\n \"latestBackupTime\": \"\",\n \"userData\": {\n \"apps\": [\n \"users\"\n ],\n \"consoleGroupMembers\": [\n {\n \"mac\": \"70A7419783ED\",\n \"role\": \"UNADOPTED\",\n \"roleAttributes\": {\n \"applications\": {\n \"access\": {\n \"owned\": false,\n \"required\": false,\n \"supported\": true\n },\n \"connect\": {\n \"owned\": false,\n \"required\": false,\n \"supported\": true\n },\n \"innerspace\": {\n \"owned\": false,\n \"required\": false,\n \"supported\": true\n },\n \"network\": {\n \"owned\": false,\n \"required\": true,\n \"supported\": true\n },\n \"protect\": {\n \"owned\": false,\n \"required\": false,\n \"supported\": true\n },\n \"talk\": {\n \"owned\": false,\n \"required\": false,\n \"supported\": true\n }\n },\n \"candidateRoles\": [\n \"PRIMARY\"\n ],\n \"connectedState\": \"CONNECTED\",\n \"connectedStateLastChanged\": \"2024-04-16T02:52:54.193Z\"\n },\n \"sysId\": 59925\n }\n ],\n \"controllers\": [\n \"network\",\n \"protect\",\n \"access\",\n \"talk\",\n \"connect\",\n \"innerspace\"\n ],\n \"email\": \"example@ui.com\",\n \"features\": {\n \"deviceGroups\": true,\n \"floorplan\": {\n \"canEdit\": true,\n \"canView\": true\n },\n \"manageApplications\": true,\n \"notifications\": true,\n \"pion\": true,\n \"webrtc\": {\n \"iceRestart\": true,\n \"mediaStreams\": true,\n \"twoWayAudio\": true\n }\n },\n \"fullName\": \"UniFi User\",\n \"localId\": \"d4eb483d-98a7-438b-abe1-f46628dff73f\",\n \"permissions\": {\n \"access.management\": [\n \"admin\"\n ],\n \"connect.management\": [\n \"admin\"\n ],\n \"innerspace.management\": [\n \"admin\"\n ],\n \"network.management\": [\n \"admin\"\n ],\n \"protect.management\": [\n \"admin\"\n ],\n \"system.management.location\": [\n \"admin\"\n ],\n \"system.management.user\": [\n \"admin\"\n ],\n \"talk.management\": [\n \"admin\"\n ]\n },\n \"role\": \"owner\",\n \"roleId\": \"c349b256-98a7-44ab-b8a1-13c437ea7742\",\n \"status\": \"ACTIVE\"\n },\n \"reportedState\": null\n }\n ],\n \"httpStatusCode\": 200,\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\",\n \"nextToken\": \"ba8e384e-3308-4236-b344-7357657351ca\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "10ae3b33-ffd7-44ea-83d4-be1149d54b21",
"name": "401",
"originalRequest": {
"url": {
"path": [
"v1",
"hosts"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"key": "pageSize",
"value": "10"
},
{
"key": "nextToken",
"value": "602232A870250000000006C514FF00000000073DD8DB000000006369FDA2:1467082514"
}
],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"unauthorized\",\n \"httpStatusCode\": 401,\n \"message\": \"unauthorized\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "346d7ceb-df92-4575-844c-1e2bfc82d63b",
"name": "429",
"originalRequest": {
"url": {
"path": [
"v1",
"hosts"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"key": "pageSize",
"value": "10"
},
{
"key": "nextToken",
"value": "602232A870250000000006C514FF00000000073DD8DB000000006369FDA2:1467082514"
}
],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Too Many Requests",
"code": 429,
"header": [
{
"disabled": false,
"key": "Retry-After",
"value": "5",
"description": ""
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"rate_limit\",\n \"httpStatusCode\": 429,\n \"message\": \"rate limit exceeded, retry after 5.372786998s\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "a9f967e2-b8b6-4034-8f4c-7c215163aecb",
"name": "500",
"originalRequest": {
"url": {
"path": [
"v1",
"hosts"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"key": "pageSize",
"value": "10"
},
{
"key": "nextToken",
"value": "602232A870250000000006C514FF00000000073DD8DB000000006369FDA2:1467082514"
}
],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"server_error\",\n \"httpStatusCode\": 500,\n \"message\": \"failed to list hosts\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "1f454242-864c-493a-bc2f-78efb6390049",
"name": "502",
"originalRequest": {
"url": {
"path": [
"v1",
"hosts"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"key": "pageSize",
"value": "10"
},
{
"key": "nextToken",
"value": "602232A870250000000006C514FF00000000073DD8DB000000006369FDA2:1467082514"
}
],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Gateway",
"code": 502,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"bad_gateway\",\n \"httpStatusCode\": 502,\n \"message\": \"bad gateway\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "6d0b6427-d31d-4e8c-b608-14359079339f",
"name": "Get Host by ID",
"request": {
"name": "Get Host by ID",
"description": {
"content": "Retrieves detailed information about a specific host by ID.
**Note**: The structure of the `userData` and `reportedState` fields may vary depending on the UniFi OS or Network Server version. The example provided is based on UniFi OS 4.1.13.",
"type": "text/plain"
},
"url": {
"path": [
"v1",
"hosts",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Unique identifier of the host"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"auth": null
},
"response": [
{
"id": "4778a9d5-383a-46e0-990b-91d42551b2ba",
"name": "200",
"originalRequest": {
"url": {
"path": [
"v1",
"hosts",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Unique identifier of the host"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"data\": {\n \"id\": \"70A7419783ED0000000006797F060000000006C719490000000062ABD4EA:1261206302\",\n \"hardwareId\": \"e5bf13cd-98a7-5a96-9463-0d65d78cd3a4\",\n \"type\": \"ucore\",\n \"ipAddress\": \"220.130.137.169\",\n \"owner\": true,\n \"isBlocked\": false,\n \"registrationTime\": \"\",\n \"lastConnectionStateChange\": \"2024-04-16T02:52:54.193Z\",\n \"latestBackupTime\": \"\",\n \"userData\": {\n \"apps\": [\n \"users\"\n ],\n \"consoleGroupMembers\": [\n {\n \"mac\": \"70A7419783ED\",\n \"role\": \"UNADOPTED\",\n \"roleAttributes\": {\n \"applications\": {\n \"access\": {\n \"owned\": false,\n \"required\": false,\n \"supported\": true\n },\n \"connect\": {\n \"owned\": false,\n \"required\": false,\n \"supported\": true\n },\n \"innerspace\": {\n \"owned\": false,\n \"required\": false,\n \"supported\": true\n },\n \"network\": {\n \"owned\": false,\n \"required\": true,\n \"supported\": true\n },\n \"protect\": {\n \"owned\": false,\n \"required\": false,\n \"supported\": true\n },\n \"talk\": {\n \"owned\": false,\n \"required\": false,\n \"supported\": true\n }\n },\n \"candidateRoles\": [\n \"PRIMARY\"\n ],\n \"connectedState\": \"CONNECTED\",\n \"connectedStateLastChanged\": \"2024-04-16T02:52:54.193Z\"\n },\n \"sysId\": 59925\n }\n ],\n \"controllers\": [\n \"network\",\n \"protect\",\n \"access\",\n \"talk\",\n \"connect\",\n \"innerspace\"\n ],\n \"email\": \"example@ui.com\",\n \"features\": {\n \"deviceGroups\": true,\n \"floorplan\": {\n \"canEdit\": true,\n \"canView\": true\n },\n \"manageApplications\": true,\n \"notifications\": true,\n \"pion\": true,\n \"webrtc\": {\n \"iceRestart\": true,\n \"mediaStreams\": true,\n \"twoWayAudio\": true\n }\n },\n \"fullName\": \"UniFi User\",\n \"localId\": \"d4eb483d-98a7-438b-abe1-f46628dff73f\",\n \"permissions\": {\n \"access.management\": [\n \"admin\"\n ],\n \"connect.management\": [\n \"admin\"\n ],\n \"innerspace.management\": [\n \"admin\"\n ],\n \"network.management\": [\n \"admin\"\n ],\n \"protect.management\": [\n \"admin\"\n ],\n \"system.management.location\": [\n \"admin\"\n ],\n \"system.management.user\": [\n \"admin\"\n ],\n \"talk.management\": [\n \"admin\"\n ]\n },\n \"role\": \"owner\",\n \"roleId\": \"c349b256-98a7-44ab-b8a1-13c437ea7742\",\n \"status\": \"ACTIVE\"\n },\n \"reportedState\": null\n },\n \"httpStatusCode\": 200,\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "04b2eb3f-49ee-49ee-b58c-eb7a7ad9eef0",
"name": "401",
"originalRequest": {
"url": {
"path": [
"v1",
"hosts",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Unique identifier of the host"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"unauthorized\",\n \"httpStatusCode\": 401,\n \"message\": \"unauthorized\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "2d18e34a-1a3c-41e2-bc58-f3b6b1c2b9f0",
"name": "404",
"originalRequest": {
"url": {
"path": [
"v1",
"hosts",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Unique identifier of the host"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Not Found",
"code": 404,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"NOT_FOUND\",\n \"httpStatusCode\": 404,\n \"message\": \"thing not found: 942A6F00301100000000074A6BA90000000007A3387E0000000063EC9853:714694\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "ca3e7786-ff13-41e8-9f8f-b66724f5fc8c",
"name": "429",
"originalRequest": {
"url": {
"path": [
"v1",
"hosts",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Unique identifier of the host"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Too Many Requests",
"code": 429,
"header": [
{
"disabled": false,
"key": "Retry-After",
"value": "5",
"description": ""
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"rate_limit\",\n \"httpStatusCode\": 429,\n \"message\": \"rate limit exceeded, retry after 5.372786998s\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "fe0ca328-d02e-454e-87af-0f7b9ba492a0",
"name": "500",
"originalRequest": {
"url": {
"path": [
"v1",
"hosts",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Unique identifier of the host"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"server_error\",\n \"httpStatusCode\": 500,\n \"message\": \"failed to get host\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "08ba8614-ccc4-4f94-bdca-0c14d855487e",
"name": "502",
"originalRequest": {
"url": {
"path": [
"v1",
"hosts",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Unique identifier of the host"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Gateway",
"code": 502,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"bad_gateway\",\n \"httpStatusCode\": 502,\n \"message\": \"bad gateway\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "2b33569f-6313-44e0-bcc7-e5698e33d5ff",
"name": "Get ISP Metrics",
"request": {
"name": "Get ISP Metrics",
"description": {
"content": "Retrieves ISP metrics data for all sites linked to the UI account's API key. 5-minute interval metrics are available for at least 24 hours, and 1-hour interval metrics are available for at least 30 days.",
"type": "text/plain"
},
"url": {
"path": [
"v1",
"isp-metrics",
":type"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"key": "beginTimestamp",
"value": "",
"description": "The earliest timestamp to retrieve data from (RFC3339 format)"
},
{
"disabled": false,
"key": "endTimestamp",
"value": "",
"description": "The latest timestamp to retrieve data up to (RFC3339 format)"
},
{
"disabled": false,
"key": "duration",
"value": "",
"description": "Specifies the time range of metrics to retrieve, starting from when the request is made. Supports `24h` for 5-minute metrics, and `7d` or `30d` for 1-hour metrics. This parameter **cannot** be used with `beginTimestamp` or `endTimestamp`."
}
],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "type",
"description": "(Required) Specifies whether metrics are returned using `5m` or `1h` intervals"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"auth": null
},
"response": [
{
"id": "445a6d8c-15af-4da6-86fa-c713b31d961c",
"name": "200",
"originalRequest": {
"url": {
"path": [
"v1",
"isp-metrics",
":type"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"key": "beginTimestamp",
"value": "2024-06-30T13:35:00Z"
},
{
"key": "endTimestamp",
"value": "2024-06-30T15:35:00Z"
},
{
"key": "duration",
"value": ""
}
],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "type",
"description": "(Required) Specifies whether metrics are returned using `5m` or `1h` intervals"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"data\": [\n {\n \"metricType\": \"5m\",\n \"periods\": [\n {\n \"data\": {\n \"wan\": {\n \"avgLatency\": 1,\n \"download_kbps\": 0,\n \"downtime\": 0,\n \"ispAsn\": \"12578\",\n \"ispName\": \"ISP\",\n \"maxLatency\": 2,\n \"packetLoss\": 0,\n \"upload_kbps\": 0,\n \"uptime\": 100\n }\n },\n \"metricTime\": \"2024-06-30T13:35:00Z\",\n \"version\": \"1\"\n }\n ],\n \"hostId\": \"900A6F00301100000000074A6BA90000000007A3387E0000000063EC9853:123456789\",\n \"siteId\": \"661900ae6aec8f548d49fd54\"\n }\n ],\n \"httpStatusCode\": 200,\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "a301b24b-da7d-466f-aa64-f280b01e47d3",
"name": "400",
"originalRequest": {
"url": {
"path": [
"v1",
"isp-metrics",
":type"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"key": "beginTimestamp",
"value": "2024-06-30T13:35:00Z"
},
{
"key": "endTimestamp",
"value": "2024-06-30T15:35:00Z"
},
{
"key": "duration",
"value": ""
}
],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "type",
"description": "(Required) Specifies whether metrics are returned using `5m` or `1h` intervals"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"parameter_invalid\",\n \"httpStatusCode\": 400,\n \"message\": \"invalid beginTimestamp format: 2024-06-30\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "4a5487ec-4966-4b82-bd5d-2b01a89c1227",
"name": "401",
"originalRequest": {
"url": {
"path": [
"v1",
"isp-metrics",
":type"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"key": "beginTimestamp",
"value": "2024-06-30T13:35:00Z"
},
{
"key": "endTimestamp",
"value": "2024-06-30T15:35:00Z"
},
{
"key": "duration",
"value": ""
}
],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "type",
"description": "(Required) Specifies whether metrics are returned using `5m` or `1h` intervals"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"unauthorized\",\n \"httpStatusCode\": 401,\n \"message\": \"unauthorized\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "d123ca7f-dd52-4edd-9f90-3e6e3c744463",
"name": "429",
"originalRequest": {
"url": {
"path": [
"v1",
"isp-metrics",
":type"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"key": "beginTimestamp",
"value": "2024-06-30T13:35:00Z"
},
{
"key": "endTimestamp",
"value": "2024-06-30T15:35:00Z"
},
{
"key": "duration",
"value": ""
}
],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "type",
"description": "(Required) Specifies whether metrics are returned using `5m` or `1h` intervals"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Too Many Requests",
"code": 429,
"header": [
{
"disabled": false,
"key": "Retry-After",
"value": "5",
"description": ""
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"rate_limit\",\n \"httpStatusCode\": 429,\n \"message\": \"rate limit exceeded, retry after 5.372786998s\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "d9718e26-f788-41c6-969f-b69ef77298ce",
"name": "500",
"originalRequest": {
"url": {
"path": [
"v1",
"isp-metrics",
":type"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"key": "beginTimestamp",
"value": "2024-06-30T13:35:00Z"
},
{
"key": "endTimestamp",
"value": "2024-06-30T15:35:00Z"
},
{
"key": "duration",
"value": ""
}
],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "type",
"description": "(Required) Specifies whether metrics are returned using `5m` or `1h` intervals"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"server_error\",\n \"httpStatusCode\": 500,\n \"message\": \"failed to get ISP metrics\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "9988b0e3-5410-43c3-8c56-4ca8612a40e1",
"name": "502",
"originalRequest": {
"url": {
"path": [
"v1",
"isp-metrics",
":type"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"key": "beginTimestamp",
"value": "2024-06-30T13:35:00Z"
},
{
"key": "endTimestamp",
"value": "2024-06-30T15:35:00Z"
},
{
"key": "duration",
"value": ""
}
],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "type",
"description": "(Required) Specifies whether metrics are returned using `5m` or `1h` intervals"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Gateway",
"code": 502,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"bad_gateway\",\n \"httpStatusCode\": 502,\n \"message\": \"bad gateway\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "ce0d7db9-504f-4a9a-b567-d96978262de6",
"name": "Query ISP Metrics",
"request": {
"name": "Query ISP Metrics",
"description": {
"content": "Retrieves ISP metrics data based on specific query parameters. 5-minute interval metrics are available for at least 24 hours, and 1-hour interval metrics are available for at least 30 days.
**Note:** If the UI account lacks access to all requested sites, a 502 error is returned. If partial access is granted, the response will include `status: partialSuccess`.",
"type": "text/plain"
},
"url": {
"path": [
"v1",
"isp-metrics",
":type",
"query"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "type",
"description": "(Required) Specifies whether metrics are returned using `5m` or `1h` intervals"
}
]
},
"header": [
{
"key": "Content-Type",
"value": "application/json"
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"auth": null,
"body": {
"mode": "raw",
"raw": "{\n \"sites\": [\n {\n \"hostId\": \"\",\n \"siteId\": \"\",\n \"beginTimestamp\": \"\",\n \"endTimestamp\": \"\"\n },\n {\n \"hostId\": \"\",\n \"siteId\": \"\",\n \"beginTimestamp\": \"\",\n \"endTimestamp\": \"\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": [
{
"id": "3006ff16-3701-47f0-b2e0-3d6cd7c86fb2",
"name": "200",
"originalRequest": {
"url": {
"path": [
"v1",
"isp-metrics",
":type",
"query"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "type",
"description": "(Required) Specifies whether metrics are returned using `5m` or `1h` intervals"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"sites\": [\n {\n \"beginTimestamp\": \"2024-06-30T13:35:00Z\",\n \"hostId\": \"900A6F00301100000000074A6BA90000000007A3387E0000000063EC9853:123456789\",\n \"endTimestamp\": \"2024-06-30T15:35:00Z\",\n \"siteId\": \"661900ae6aec8f548d49fd54\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"data\": {\n \"metrics\": [\n {\n \"metricType\": \"5m\",\n \"periods\": [\n {\n \"data\": {\n \"wan\": {\n \"avgLatency\": 1,\n \"download_kbps\": 0,\n \"downtime\": 0,\n \"ispAsn\": \"12578\",\n \"ispName\": \"ISP\",\n \"maxLatency\": 2,\n \"packetLoss\": 0,\n \"upload_kbps\": 0,\n \"uptime\": 100\n }\n },\n \"metricTime\": \"2024-06-30T13:35:00Z\",\n \"version\": \"1\"\n }\n ],\n \"hostId\": \"900A6F00301100000000074A6BA90000000007A3387E0000000063EC9853:123456789\",\n \"siteId\": \"661900ae6aec8f548d49fd54\"\n }\n ]\n },\n \"httpStatusCode\": 200,\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "d8499fc0-82d7-4abf-8537-42ec56faf793",
"name": "400",
"originalRequest": {
"url": {
"path": [
"v1",
"isp-metrics",
":type",
"query"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "type",
"description": "(Required) Specifies whether metrics are returned using `5m` or `1h` intervals"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"sites\": [\n {\n \"beginTimestamp\": \"2024-06-30T13:35:00Z\",\n \"hostId\": \"900A6F00301100000000074A6BA90000000007A3387E0000000063EC9853:123456789\",\n \"endTimestamp\": \"2024-06-30T15:35:00Z\",\n \"siteId\": \"661900ae6aec8f548d49fd54\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "Bad Request",
"code": 400,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"parameter_invalid\",\n \"httpStatusCode\": 400,\n \"message\": \"invalid beginTimestamp format: 2024-06-30\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "11c4ec80-f3a5-4371-8ad4-eea98cf25b43",
"name": "401",
"originalRequest": {
"url": {
"path": [
"v1",
"isp-metrics",
":type",
"query"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "type",
"description": "(Required) Specifies whether metrics are returned using `5m` or `1h` intervals"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"sites\": [\n {\n \"beginTimestamp\": \"2024-06-30T13:35:00Z\",\n \"hostId\": \"900A6F00301100000000074A6BA90000000007A3387E0000000063EC9853:123456789\",\n \"endTimestamp\": \"2024-06-30T15:35:00Z\",\n \"siteId\": \"661900ae6aec8f548d49fd54\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"unauthorized\",\n \"httpStatusCode\": 401,\n \"message\": \"unauthorized\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "9132b356-efe5-4e6a-a627-f35f1dd2803f",
"name": "429",
"originalRequest": {
"url": {
"path": [
"v1",
"isp-metrics",
":type",
"query"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "type",
"description": "(Required) Specifies whether metrics are returned using `5m` or `1h` intervals"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"sites\": [\n {\n \"beginTimestamp\": \"2024-06-30T13:35:00Z\",\n \"hostId\": \"900A6F00301100000000074A6BA90000000007A3387E0000000063EC9853:123456789\",\n \"endTimestamp\": \"2024-06-30T15:35:00Z\",\n \"siteId\": \"661900ae6aec8f548d49fd54\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "Too Many Requests",
"code": 429,
"header": [
{
"disabled": false,
"key": "Retry-After",
"value": "5",
"description": ""
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"rate_limit\",\n \"httpStatusCode\": 429,\n \"message\": \"rate limit exceeded, retry after 5.372786998s\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "98e5ba40-f471-4baf-97aa-a7492b2abbac",
"name": "500",
"originalRequest": {
"url": {
"path": [
"v1",
"isp-metrics",
":type",
"query"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "type",
"description": "(Required) Specifies whether metrics are returned using `5m` or `1h` intervals"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"sites\": [\n {\n \"beginTimestamp\": \"2024-06-30T13:35:00Z\",\n \"hostId\": \"900A6F00301100000000074A6BA90000000007A3387E0000000063EC9853:123456789\",\n \"endTimestamp\": \"2024-06-30T15:35:00Z\",\n \"siteId\": \"661900ae6aec8f548d49fd54\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"server_error\",\n \"httpStatusCode\": 500,\n \"message\": \"failed to query ISP metrics\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "289879ef-8e91-4327-8ccf-ff655a62cfec",
"name": "502",
"originalRequest": {
"url": {
"path": [
"v1",
"isp-metrics",
":type",
"query"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "type",
"description": "(Required) Specifies whether metrics are returned using `5m` or `1h` intervals"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "POST",
"body": {
"mode": "raw",
"raw": "{\n \"sites\": [\n {\n \"beginTimestamp\": \"2024-06-30T13:35:00Z\",\n \"hostId\": \"900A6F00301100000000074A6BA90000000007A3387E0000000063EC9853:123456789\",\n \"endTimestamp\": \"2024-06-30T15:35:00Z\",\n \"siteId\": \"661900ae6aec8f548d49fd54\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"status": "Bad Gateway",
"code": 502,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"bad_gateway\",\n \"httpStatusCode\": 502,\n \"message\": \"bad gateway\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "e56a4538-e962-4791-8af4-b417737dc440",
"name": "List SD-WAN Configs",
"request": {
"name": "List SD-WAN Configs",
"description": {
"content": "Retrieves a list of all SD-WAN configurations associated with the UI account making the API call.",
"type": "text/plain"
},
"url": {
"path": [
"v1",
"sd-wan-configs"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"auth": null
},
"response": [
{
"id": "6c629d2a-bceb-43cc-8797-7c892a8bcf27",
"name": "200",
"originalRequest": {
"url": {
"path": [
"v1",
"sd-wan-configs"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"data\": [\n {\n \"id\": \"9304163b-680d-4de8-a7a0-7617e328911d\",\n \"name\": \"SD-WAN test\",\n \"type\": \"sdwan-hbsp\"\n }\n ],\n \"httpStatusCode\": 200,\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "776de5f5-8f27-46e4-b0bb-85ed3f5c9b56",
"name": "401",
"originalRequest": {
"url": {
"path": [
"v1",
"sd-wan-configs"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"unauthorized\",\n \"httpStatusCode\": 401,\n \"message\": \"unauthorized\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "b8ad1b9c-b652-4d57-8a06-fdabdaade748",
"name": "429",
"originalRequest": {
"url": {
"path": [
"v1",
"sd-wan-configs"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Too Many Requests",
"code": 429,
"header": [
{
"disabled": false,
"key": "Retry-After",
"value": "5",
"description": ""
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"rate_limit\",\n \"httpStatusCode\": 429,\n \"message\": \"rate limit exceeded, retry after 5.372786998s\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "4d93be53-d294-4aac-b007-e386eddd6bcc",
"name": "500",
"originalRequest": {
"url": {
"path": [
"v1",
"sd-wan-configs"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"server_error\",\n \"httpStatusCode\": 500,\n \"message\": \"failed to list network cloud SD-WAN configs\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "8685952a-501c-4cf0-8409-7d6a95dbd6a0",
"name": "502",
"originalRequest": {
"url": {
"path": [
"v1",
"sd-wan-configs"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Gateway",
"code": 502,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"bad_gateway\",\n \"httpStatusCode\": 502,\n \"message\": \"bad gateway\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "1d6f5e66-4a28-489d-b466-a0b829d79242",
"name": "Get SD-WAN Config by ID",
"request": {
"name": "Get SD-WAN Config by ID",
"description": {
"content": "Retrieves detailed information about a specific SD-WAN configuration by ID.",
"type": "text/plain"
},
"url": {
"path": [
"v1",
"sd-wan-configs",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Unique identifier of the SD-WAN configuration"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"auth": null
},
"response": [
{
"id": "de885573-4e3c-4359-942d-eb5f39aff75d",
"name": "200",
"originalRequest": {
"url": {
"path": [
"v1",
"sd-wan-configs",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Unique identifier of the SD-WAN configuration"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"data\": {\n \"id\": \"b344034f-2636-478c-8c7a-e3350f8ed37a\",\n \"name\": \"RS test\",\n \"type\": \"sdwan-hbsp\",\n \"variant\": \"single\",\n \"settings\": {\n \"hubsInterconnect\": null,\n \"spokeToHubTunnelsMode\": \"scalable\",\n \"spokesAutoScaleAndNatEnabled\": true,\n \"spokesAutoScaleAndNatRange\": \"172.16.0.0/12\",\n \"spokesIsolate\": true,\n \"spokeStandardSettingsEnabled\": false,\n \"spokeStandardSettingsValues\": null,\n \"spokeToHubRouting\": \"geo\"\n },\n \"hubs\": [\n {\n \"id\": \"9C05D6B1DA7100000000080A820B000000000877B4A4000000006634E113:779231894_670d14b2b4e979611b761866\",\n \"hostId\": \"9C05D6B1DA7100000000080A820B000000000877B4A4000000006634E113:779231894\",\n \"siteId\": \"670d14b2b4e979611b761866\",\n \"networkIds\": [\n \"670d14deb4e979611b761880\"\n ],\n \"routes\": [],\n \"primaryWan\": \"WAN\",\n \"wanFailover\": false\n }\n ],\n \"spokes\": [\n {\n \"id\": \"28704E43D00C0000000008339D3C0000000008A2F4D300000000669FE9E7:1731456649_670d153bf6db0d4204f8d150\",\n \"hostId\": \"28704E43D00C0000000008339D3C0000000008A2F4D300000000669FE9E7:1731456649\",\n \"siteId\": \"670d153bf6db0d4204f8d150\",\n \"networkIds\": [],\n \"routes\": [\n \"172.16.1.0/24\"\n ],\n \"primaryWan\": \"WAN\",\n \"wanFailover\": false,\n \"hubsPriority\": null\n },\n {\n \"id\": \"F4E2C61FA6000000000007D5831A00000000083CEEC600000000655DA309:763649230_66b5f02af5521234f6f28a23\",\n \"hostId\": \"F4E2C61FA6000000000007D5831A00000000083CEEC600000000655DA309:763649230\",\n \"siteId\": \"66b5f02af5521234f6f28a23\",\n \"networkIds\": [],\n \"routes\": [\n \"172.16.2.0/24\"\n ],\n \"primaryWan\": \"WAN\",\n \"wanFailover\": false,\n \"hubsPriority\": null\n }\n ]\n },\n \"httpStatusCode\": 200,\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "75a7a31b-118d-4ecf-a96f-70141af9a057",
"name": "401",
"originalRequest": {
"url": {
"path": [
"v1",
"sd-wan-configs",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Unique identifier of the SD-WAN configuration"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"unauthorized\",\n \"httpStatusCode\": 401,\n \"message\": \"unauthorized\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "659ee6b6-1f38-4258-84d6-cde5a5cea1f0",
"name": "404",
"originalRequest": {
"url": {
"path": [
"v1",
"sd-wan-configs",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Unique identifier of the SD-WAN configuration"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Not Found",
"code": 404,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"not_found\",\n \"httpStatusCode\": 404,\n \"message\": \"config not found\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "cabd282a-0cd7-4cdc-9230-04c3b220c129",
"name": "429",
"originalRequest": {
"url": {
"path": [
"v1",
"sd-wan-configs",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Unique identifier of the SD-WAN configuration"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Too Many Requests",
"code": 429,
"header": [
{
"disabled": false,
"key": "Retry-After",
"value": "5",
"description": ""
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"rate_limit\",\n \"httpStatusCode\": 429,\n \"message\": \"rate limit exceeded, retry after 5.372786998s\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "68060bed-0563-4cca-b851-e5512da8c75a",
"name": "500",
"originalRequest": {
"url": {
"path": [
"v1",
"sd-wan-configs",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Unique identifier of the SD-WAN configuration"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"server_error\",\n \"httpStatusCode\": 500,\n \"message\": \"failed to get network cloud SD-WAN config by ID\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "e3174f95-6619-49ea-8ca9-d8c1b7aa0a1d",
"name": "502",
"originalRequest": {
"url": {
"path": [
"v1",
"sd-wan-configs",
":id"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Unique identifier of the SD-WAN configuration"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Gateway",
"code": 502,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"bad_gateway\",\n \"httpStatusCode\": 502,\n \"message\": \"bad gateway\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "7b9ac7c7-3cac-4599-90d5-1d055073703a",
"name": "Get SD-WAN Config Status",
"request": {
"name": "Get SD-WAN Config Status",
"description": {
"content": "Retrieves the status of a specific SD-WAN configuration, including deployment progress, errors, and associated hubs.",
"type": "text/plain"
},
"url": {
"path": [
"v1",
"sd-wan-configs",
":id",
"status"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Unique identifier of the SD-WAN configuration"
}
]
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"auth": null
},
"response": [
{
"id": "310f8580-ee66-4d2c-8069-3acdb180ff2d",
"name": "200",
"originalRequest": {
"url": {
"path": [
"v1",
"sd-wan-configs",
":id",
"status"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Unique identifier of the SD-WAN configuration"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"data\": {\n \"id\": \"\",\n \"fingerprint\": \"85d521a1b3c8992f\",\n \"updatedAt\": 1739454923342,\n \"hubs\": [\n {\n \"id\": \"9C05D6B1DA7100000000080A820B000000000877B4A4000000006634E113:779231894_670d14b2b4e979611b761866\",\n \"hostId\": \"9C05D6B1DA7100000000080A820B000000000877B4A4000000006634E113:779231894\",\n \"siteId\": \"670d14b2b4e979611b761866\",\n \"name\": \"Marlind's UDM SE\",\n \"primaryWanStatus\": {\n \"ip\": \"194.22.30.166\",\n \"latency\": 1,\n \"internetIssues\": [],\n \"wanId\": \"WAN\"\n },\n \"secondaryWanStatus\": {\n \"ip\": \"\",\n \"latency\": null,\n \"internetIssues\": null,\n \"wanId\": \"\"\n },\n \"errors\": [],\n \"warnings\": [],\n \"numberOfTunnelsUsedByOtherFeatures\": 0,\n \"networks\": [\n {\n \"networkId\": \"670d14deb4e979611b761880\",\n \"name\": \"Default\",\n \"errors\": [],\n \"warnings\": []\n }\n ],\n \"routes\": [],\n \"applyStatus\": \"OK\"\n }\n ],\n \"spokes\": [\n {\n \"id\": \"28704E43D00C0000000008339D3C0000000008A2F4D300000000669FE9E7:1731456649_670d153bf6db0d4204f8d150\",\n \"hostId\": \"28704E43D00C0000000008339D3C0000000008A2F4D300000000669FE9E7:1731456649\",\n \"siteId\": \"670d153bf6db0d4204f8d150\",\n \"name\": \"Marlind's UDR\",\n \"primaryWanStatus\": {\n \"ip\": \"10.0.1.142\",\n \"latency\": 1,\n \"internetIssues\": [],\n \"wanId\": \"WAN\"\n },\n \"secondaryWanStatus\": {\n \"ip\": \"\",\n \"latency\": null,\n \"internetIssues\": null,\n \"wanId\": \"\"\n },\n \"errors\": [],\n \"warnings\": [],\n \"numberOfTunnelsUsedByOtherFeatures\": 0,\n \"networks\": [],\n \"routes\": [\n {\n \"routeValue\": \"172.16.1.0/24\",\n \"errors\": [],\n \"warnings\": []\n }\n ],\n \"connections\": [\n {\n \"hubId\": \"9C05D6B1DA7100000000080A820B000000000877B4A4000000006634E113:779231894_670d14b2b4e979611b761866\",\n \"tunnels\": [\n {\n \"spokeWanId\": \"WAN\",\n \"hubWanId\": \"WAN\",\n \"status\": \"connected\"\n }\n ]\n }\n ],\n \"applyStatus\": \"OK\"\n },\n {\n \"id\": \"F4E2C61FA6000000000007D5831A00000000083CEEC600000000655DA309:763649230_66b5f02af5521234f6f28a23\",\n \"hostId\": \"F4E2C61FA6000000000007D5831A00000000083CEEC600000000655DA309:763649230\",\n \"siteId\": \"66b5f02af5521234f6f28a23\",\n \"name\": \"AG UCG Ultra STG\",\n \"primaryWanStatus\": {\n \"ip\": \"10.35.87.53\",\n \"latency\": 2,\n \"internetIssues\": [],\n \"wanId\": \"WAN\"\n },\n \"secondaryWanStatus\": {\n \"ip\": \"\",\n \"latency\": null,\n \"internetIssues\": null,\n \"wanId\": \"\"\n },\n \"errors\": [],\n \"warnings\": [],\n \"numberOfTunnelsUsedByOtherFeatures\": 0,\n \"networks\": [],\n \"routes\": [\n {\n \"routeValue\": \"172.16.2.0/24\",\n \"errors\": [],\n \"warnings\": []\n }\n ],\n \"connections\": [\n {\n \"hubId\": \"9C05D6B1DA7100000000080A820B000000000877B4A4000000006634E113:779231894_670d14b2b4e979611b761866\",\n \"tunnels\": [\n {\n \"spokeWanId\": \"WAN\",\n \"hubWanId\": \"WAN\",\n \"status\": \"connected\"\n }\n ]\n }\n ],\n \"applyStatus\": \"OK\"\n }\n ],\n \"lastGeneratedAt\": 1739454923342,\n \"generateStatus\": \"OK\",\n \"errors\": [],\n \"warnings\": []\n },\n \"httpStatusCode\": 200,\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "e45d56ad-520e-40a1-a249-00ed24eb3e05",
"name": "401",
"originalRequest": {
"url": {
"path": [
"v1",
"sd-wan-configs",
":id",
"status"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Unique identifier of the SD-WAN configuration"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"unauthorized\",\n \"httpStatusCode\": 401,\n \"message\": \"unauthorized\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "a4b7068b-73b1-45a6-b843-d4cee6a03f21",
"name": "404",
"originalRequest": {
"url": {
"path": [
"v1",
"sd-wan-configs",
":id",
"status"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Unique identifier of the SD-WAN configuration"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Not Found",
"code": 404,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"not_found\",\n \"httpStatusCode\": 404,\n \"message\": \"config not found\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "b2f33549-b4ff-4d1e-a232-e6507f86e274",
"name": "429",
"originalRequest": {
"url": {
"path": [
"v1",
"sd-wan-configs",
":id",
"status"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Unique identifier of the SD-WAN configuration"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Too Many Requests",
"code": 429,
"header": [
{
"disabled": false,
"key": "Retry-After",
"value": "5",
"description": ""
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"rate_limit\",\n \"httpStatusCode\": 429,\n \"message\": \"rate limit exceeded, retry after 5.372786998s\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "853ca93d-14c9-4849-ac9e-eef6372a0b9a",
"name": "500",
"originalRequest": {
"url": {
"path": [
"v1",
"sd-wan-configs",
":id",
"status"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Unique identifier of the SD-WAN configuration"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"server_error\",\n \"httpStatusCode\": 500,\n \"message\": \"failed to get network cloud SD-WAN config status by ID\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "dfd369f8-c6a7-463c-86dd-2e7f92dd2e6b",
"name": "502",
"originalRequest": {
"url": {
"path": [
"v1",
"sd-wan-configs",
":id",
"status"
],
"host": [
"{{baseUrl}}"
],
"query": [],
"variable": [
{
"disabled": false,
"type": "any",
"value": "",
"key": "id",
"description": "(Required) Unique identifier of the SD-WAN configuration"
}
]
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Gateway",
"code": 502,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"bad_gateway\",\n \"httpStatusCode\": 502,\n \"message\": \"bad gateway\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
},
{
"id": "5fc4342a-97df-4d59-adff-bf67e595ce58",
"name": "List Sites",
"request": {
"name": "List Sites",
"description": {
"content": "Retrieves a list of all sites (from hosts running the UniFi Network application) associated with the UI account making the API call.
**Note**: The structure of the `meta` and `statistics` fields may vary depending on the UniFi Network version. The example provided is based on UniFi OS 4.1.13.",
"type": "text/plain"
},
"url": {
"path": [
"v1",
"sites"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"disabled": false,
"key": "pageSize",
"value": "",
"description": "Number of items to return per page"
},
{
"disabled": false,
"key": "nextToken",
"value": "",
"description": "Token for pagination to retrieve the next set of results"
}
],
"variable": []
},
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"auth": null
},
"response": [
{
"id": "4968af37-8a9e-43bc-b038-230b1e88ac73",
"name": "200",
"originalRequest": {
"url": {
"path": [
"v1",
"sites"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"key": "pageSize",
"value": "10"
},
{
"key": "nextToken",
"value": "602232A870250000000006C514FF00000000073DD8DB000000006369FDA2:1467082514"
}
],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "OK",
"code": 200,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"data\": [\n {\n \"siteId\": \"661de833b6b2463f0c20b319\",\n \"hostId\": \"900A6F00301100000000074A6BA90000000007A3387E0000000063EC9853:123456789\",\n \"meta\": {\n \"desc\": \"Default\",\n \"gatewayMac\": \"70:a7:41:97:83:ed\",\n \"name\": \"default\",\n \"timezone\": \"Asia/Taipei\"\n },\n \"statistics\": {\n \"counts\": {\n \"criticalNotification\": 0,\n \"gatewayDevice\": 1,\n \"guestClient\": 0,\n \"lanConfiguration\": 1,\n \"offlineDevice\": 0,\n \"offlineGatewayDevice\": 0,\n \"offlineWifiDevice\": 0,\n \"offlineWiredDevice\": 0,\n \"pendingUpdateDevice\": 0,\n \"totalDevice\": 1,\n \"wanConfiguration\": 2,\n \"wifiClient\": 0,\n \"wifiConfiguration\": 0,\n \"wifiDevice\": 0,\n \"wiredClient\": 0,\n \"wiredDevice\": 0\n },\n \"gateway\": {\n \"hardwareId\": \"e5bf13cd-98a7-5a96-9463-0d65d78cd3a4\",\n \"inspectionState\": \"off\",\n \"ipsMode\": \"disabled\",\n \"ipsSignature\": {\n \"rulesCount\": 53031,\n \"type\": \"ET\"\n },\n \"shortname\": \"UDMPRO\"\n },\n \"internetIssues\": [],\n \"ispInfo\": {\n \"name\": \"Chunghwa Telecom\",\n \"organization\": \"Data Communication Business Group\"\n },\n \"percentages\": {\n \"wanUptime\": 100\n }\n },\n \"permission\": \"admin\",\n \"isOwner\": true\n }\n ],\n \"httpStatusCode\": 200,\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\",\n \"nextToken\": \"ba8e384e-3308-4236-b344-7357657351ca\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "ca2ff75b-4a1e-4c72-97c5-4673e2ab7295",
"name": "401",
"originalRequest": {
"url": {
"path": [
"v1",
"sites"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"key": "pageSize",
"value": "10"
},
{
"key": "nextToken",
"value": "602232A870250000000006C514FF00000000073DD8DB000000006369FDA2:1467082514"
}
],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Unauthorized",
"code": 401,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"unauthorized\",\n \"httpStatusCode\": 401,\n \"message\": \"unauthorized\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "6bc66660-dce3-4dc6-b3e9-c14c5a34b1a8",
"name": "429",
"originalRequest": {
"url": {
"path": [
"v1",
"sites"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"key": "pageSize",
"value": "10"
},
{
"key": "nextToken",
"value": "602232A870250000000006C514FF00000000073DD8DB000000006369FDA2:1467082514"
}
],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Too Many Requests",
"code": 429,
"header": [
{
"disabled": false,
"key": "Retry-After",
"value": "5",
"description": ""
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"rate_limit\",\n \"httpStatusCode\": 429,\n \"message\": \"rate limit exceeded, retry after 5.372786998s\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "2c0f6db3-8200-4759-ae71-56bfd1525c01",
"name": "500",
"originalRequest": {
"url": {
"path": [
"v1",
"sites"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"key": "pageSize",
"value": "10"
},
{
"key": "nextToken",
"value": "602232A870250000000006C514FF00000000073DD8DB000000006369FDA2:1467082514"
}
],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Internal Server Error",
"code": 500,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"server_error\",\n \"httpStatusCode\": 500,\n \"message\": \"failed to list sites\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
},
{
"id": "3688ccfc-d2b0-4df6-baa1-d2bc40f4cc6a",
"name": "502",
"originalRequest": {
"url": {
"path": [
"v1",
"sites"
],
"host": [
"{{baseUrl}}"
],
"query": [
{
"key": "pageSize",
"value": "10"
},
{
"key": "nextToken",
"value": "602232A870250000000006C514FF00000000073DD8DB000000006369FDA2:1467082514"
}
],
"variable": []
},
"header": [
{
"description": {
"content": "Added as a part of security scheme: apikey",
"type": "text/plain"
},
"key": "X-API-Key",
"value": ""
},
{
"key": "Accept",
"value": "application/json"
}
],
"method": "GET",
"body": {}
},
"status": "Bad Gateway",
"code": 502,
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"body": "{\n \"code\": \"bad_gateway\",\n \"httpStatusCode\": 502,\n \"message\": \"bad gateway\",\n \"traceId\": \"a7dc15e0eb4527142d7823515b15f87d\"\n}",
"cookie": [],
"_postman_previewlanguage": "json"
}
],
"event": [],
"protocolProfileBehavior": {
"disableBodyPruning": true
}
}
],
"event": [],
"variable": [
{
"type": "string",
"value": "https://api.ui.com",
"key": "baseUrl"
}
],
"auth": {
"type": "apikey",
"apikey": [
{
"key": "key",
"value": "X-API-Key"
},
{
"key": "value",
"value": "{{apiKey}}"
},
{
"key": "in",
"value": "header"
}
]
},
"info": {
"_postman_id": "89b9b1c8-a093-4a03-9882-9b6249f72305",
"name": "UniFi Site Manager API",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"description": {
"content": "",
"type": "text/plain"
}
}
}