Connector - POST
Forward POST requests to UniFi applications using RESTful HTTP methods. <br/><br/>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. <br/><br/>Requirements: <br/>- Console firmware version must >= 5.0.3<br/>- For non-organization API keys: Limited to API key owner's consoles only (cannot access other admins' consoles)<br/>- For organization API keys: Can access any console within the organization<br/><br/>Rate Limit: <br/>- Each console is limited to 100 requests per minute<br/><br/>Limits: <br/>- Request timeout: each proxied request must complete within 25 seconds; otherwise it is terminated and a timeout error is returned<br/>- Response body size: the upstream response body is limited to 10 MB; larger responses are not supported<br/><br/>API Documentation: <br/>- Network API: https://developer.ui.com/network<br/>- Protect API: https://developer.ui.com/protect<br/>- InnerSpace API: https://developer.ui.com/innerspace<br/><br/>Response: On success, the upstream API response is passed through directly. On error, a standardized error schema is returned.
Request
- Base URLhttps://api.ui.com
- AuthAPI key in header X-API-Key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
Host ID to proxy the request to
API path to proxy
Request body
Response
200
Changes
No recorded changes to this operation across all 1 revision of this API.