Welcome to the API OLT documentation. Below are the initial instructions for using the API.
\nThe API listing endpoints follow a consistent return and usage pattern. The base structure for all searches will adhere to this standard:
\n{\n \"return\": true,\n \"count\": 999,\n \"next\": \"http://your-instance.olt.com/api/v2/list?example=1\",\n \"previous\": null,\n \"results\": [\n ]\n}\n\nThe query returns 100 results per page by default.
\nUse the optional page_size parameter to define the number of records per page (up to 1000). If not specified, the default value is 100.
To correctly use pagination, a GET request should be sent to the URL provided in the \"next\" field returned by the API. The same logic applies to the \"previous\" field returned by the API to return to the previous search page.
\nThe \"count\" variable shows the total number of records found.
\nIt is possible to include the variable \"oper\" in the query parameters to use a specific search operator. The available operators are:
\n\"=\" - To search for exact values
\n\">\" - Greater than
\n\">=\" - Greater than or equal
\n\"<\" - Less than
\n\"<=\" - Less than or equal
\n\"OR\" - Match records that satisfy at least one of the provided fields (logical OR across columns)
\nIf no operator is specified, the search will be done by proximity.
\nThe operators above (except \"OR\") change how each field is matched. The \"OR\" operator is different: it changes how multiple fields are combined. By default, when more than one field is sent, a record must match all of them (AND). With `oper=OR`, a record is returned if it matches at least one of the sent fields, and each field is matched by proximity. Only one \"oper\" value can be sent per request, so \"OR\" cannot be combined with the comparison operators.
Example: `?name=joe&login=joe&oper=OR` returns every record whose \"name\" or \"login\" contains \"joe\".
By default, the API will always return a JSON object with the \"return\" flag. If this flag has the value true, the request was successful. If it has the value false, the parameter \"error\" will also be sent, which will contain details about the request error.
\n{\n \"return\" false,\n \"error\" \"error message\"\n}\n\n\n\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"16426554","collectionId":"56cf8310-81a5-4f8b-8a54-d2c247705ec7","publishedId":"2sAY518KuB","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-11-07T14:16:05.000Z"},"item":[{"name":"Authentication","item":[{"name":"GET Token","id":"fbdbc298-2789-4f68-9160-adbb71058f85","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"username\": \"user\",\n \"password\": \"password\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://your-instance.olt.com/api/token","urlObject":{"path":["api","token"],"host":["https://your-instance.olt.com"],"query":[],"variable":[]}},"response":[{"id":"051e863a-3aa6-4827-a13b-e1cb26e9004b","name":"GET Token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"raw","raw":"{\n \"username\": \"user\",\n \"password\": \"password\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://your-instance.olt.com/api/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 07 Oct 2024 12:03:16 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"483"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"refresh\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MTcyODM4ODk5NiwiaWF0IjoxNzI4MzAyNTk2LCJqdGkiOiI4YmEzMzRhNDFhMjg0NjU5OWE4YjZlZDI0Yzc1OGYyZCIsInVzZXJfaWQiOjF9.Rjb3r-6vO5Sfc4qepb5QzZ4040esX7jGHCDaBv5NTJg\",\n \"access\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzI4MzEzMzk2LCJpYXQiOjE3MjgzMDI1OTYsImp0aSI6IjU5NDBhOGMyOGM0YjQ4MzdhYjRkMjYwZDY2ZDUwMzE1IiwidXNlcl9pZCI6MX0.Vzz3LCtseOU4U7R0G9Ba6NE90tG-vORf-c0OrL1IlXM\"\n}"}],"_postman_id":"fbdbc298-2789-4f68-9160-adbb71058f85"},{"name":"GET Refresh Token","id":"2cc4c68f-06d8-458c-8abc-c4853e9d2e4c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"refresh\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://your-instance.olt.com/api/token/refresh","urlObject":{"path":["api","token","refresh"],"host":["https://your-instance.olt.com"],"query":[],"variable":[]}},"response":[{"id":"c349b01c-684c-4787-a939-b2878eb1ea24","name":"GET Refresh Token","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"refresh\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://your-instance.olt.com/api/token/refresh"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 07 Oct 2024 12:46:49 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"241"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"access\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzI4MzE2MDA5LCJpYXQiOjE3MjgzMDI1OTYsImp0aSI6IjllYjA3ZDlmNmEzMjRjMWViNjVjMGRmMjZiNmJlYjg3IiwidXNlcl9pZCI6MX0.7eKb7MDlZVGry_XP-s87D3NiEcif74xk8BHXjn_iW5E\"\n}"}],"_postman_id":"2cc4c68f-06d8-458c-8abc-c4853e9d2e4c"}],"id":"f00f9c18-7931-4b7a-9760-1d7bde309da2","description":"In the case of an internal server error (status code 500), an error message will be returned instead of a JSON object. For other errors, the following status codes may be returned: 400, 401, 403, and 404.
\n
To access the API, authentication is required using a JWT (JSON Web Token) with a Bearer token. This token must be included in the header of every request you make to the API.
\nHere’s how to include the token:
\nAuthorization header.Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0...\n\nPlease enter coordinates in decimal format. Example: '00.0000, 00.11111'
\n","type":"text/plain"},"key":"coordinates","value":""},{"disabled":true,"key":"contact","value":null},{"disabled":true,"key":"secondary_contact","value":null}],"variable":[]}},"response":[{"id":"72ee4f21-0b7a-465e-9e62-91c9cefd1039","name":"LIST Clients","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":{"raw":"https://your-instance.olt.com/api/v2/client/list","protocol":"https","host":["your-instance","olt","com"],"path":["api","v2","client","list"],"query":[{"key":"","value":"","disabled":true},{"key":"box","value":"","disabled":true},{"key":"id","value":null,"disabled":true},{"key":"external_id","value":null,"disabled":true},{"key":"external_contract_id","value":null,"disabled":true},{"key":"client_name","value":null,"disabled":true},{"key":"pppoe","value":null,"disabled":true},{"key":"pppoe_password","value":null,"disabled":true},{"key":"status","value":null,"disabled":true},{"key":"plan","value":null,"disabled":true},{"key":"address","value":null,"disabled":true},{"key":"street","value":null,"disabled":true},{"key":"number","value":null,"disabled":true},{"key":"neighborhood","value":null,"disabled":true},{"key":"city","value":null,"disabled":true},{"key":"state","value":null,"disabled":true},{"key":"zip_code","value":null,"disabled":true},{"key":"address_reference","value":null,"disabled":true},{"key":"box_port","value":null,"disabled":true},{"key":"coordinates","value":null,"description":"Please enter coordinates in decimal format. Example: '00.0000, 00.11111'","type":"text","disabled":true},{"key":"contact","value":null,"type":"text","disabled":true},{"key":"secondary_contact","value":null,"type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 07 Oct 2024 12:43:05 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"43121"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": true,\n \"count\": 12563,\n \"next\": \"http://your-istance.olt.com/api/v2/client/list?page=2&address=&address_reference=&box=&box_port=&city=&client_name=&external_contract_id=&external_id=&id=&neighborhood=&number=&plan=&pppoe=&pppoe_password=&state=&status=&street=&zip_code=\",\n \"previous\": null,\n \"results\": [\n {\n \"id\": 1,\n \"external_id\": null,\n \"external_contract_id\": null,\n \"client_name\": \"João Silva\",\n \"pppoe\": \"joao.silva\",\n \"pppoe_password\": \"1234\",\n \"status\": \"Ativo\",\n \"plan\": \"Plano 550mb\",\n \"address\": \"AV PAU BRASIL 269 - Centro, Curitiba - Paraná\",\n \"street\": \"AV PAU BRASIL\",\n \"number\": \"269\",\n \"neighborhood\": \"Centro\",\n \"city\": \"Curitiba\",\n \"state\": \"Paraná\",\n \"zip_code\": \"89249000\",\n \"address_reference\": \"\",\n \"box\": \"12.00.00.001A\",\n \"box_port\": 8,\n \"coordinates\": \"-25.430000,-49.260000\",\n \"contact\": 554199906677,\n \"secondary_contact\": 554199906699,\n \"impact_activity\": [\n {\n \"name\": \"Manutenção CTO 12.00.00.001A\",\n \"start_date\": \"2024-01-01T09:00:00\",\n \"end_date\": \"2024-01-01T14:00:00\",\n \"status\": \"Em Andamento\",\n \"type\": \"Rompimento de fibra CTO\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"a08a4824-2b9b-43bc-ab35-2d1e2a8d0dd4"},{"name":"GET Companies","id":"98923d5d-0efe-47ba-ba44-a0c2d5705bb0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/company/list","urlObject":{"path":["api","v2","company","list"],"host":["https://your-instance.olt.com"],"query":[],"variable":[]}},"response":[{"id":"18899371-656f-456d-9e18-b2f8fc0a449a","name":"New Request","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzI5MTA0NjIzLCJpYXQiOjE3MjkwOTM4MjMsImp0aSI6IjZkMTg0ODNkZmY2OTQzYzViNzkwNTVlZmIwMGU1MzQwIiwidXNlcl9pZCI6MX0.3SmZ7xNhl_8ia8PVvcc7qDlID21xJPIgoNEqUoRMzxk","type":"text"}],"url":"http://127.0.0.1:8000/api/v2/company/list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 16 Oct 2024 16:34:28 GMT"},{"key":"Server","value":"WSGIServer/0.2 CPython/3.9.5"},{"key":"Content-Type","value":"application/json"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"Content-Length","value":"86"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": true,\n \"companies\": [\n {\n \"id\": 1,\n \"abbreviation\": \"CPN\",\n \"name\": \"COMPANY\"\n }\n ]\n}"}],"_postman_id":"98923d5d-0efe-47ba-ba44-a0c2d5705bb0"},{"name":"GET Plans","id":"cb788339-3a59-49f2-b29c-7dfec83af5c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/plan/list","urlObject":{"path":["api","v2","plan","list"],"host":["https://your-instance.olt.com"],"query":[],"variable":[]}},"response":[{"id":"5b0eca45-5360-4e0c-be88-b2f183f98368","name":"LIST Plans","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/plan/list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"return\": true,\n \"plans\": [\n {\n \"id\": 1,\n \"name\": \"PLAN 100M\",\n \"download\": 100,\n \"upload\": 50,\n \"enable\": true\n },\n {\n \"id\": 2,\n \"name\": \"PLAN 200M\",\n \"download\": 200,\n \"upload\": 100,\n \"enable\": true\n }\n ]\n}"}],"_postman_id":"cb788339-3a59-49f2-b29c-7dfec83af5c0"},{"name":"CREATE Client","id":"fdc700e8-4dad-429e-9aaf-ad596eb32e29","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://your-instance.olt.com/api/v2/client/create","description":"This endpoint is used to create a client. The fields \"id_company\" and \"id_plan\" are mandatory. To obtain the IDs of the registered companies and plans in the system, make a GET request to the \"GET Companies\" and \"GET Plans\" endpoints listed in this section of the documentation
\nReturns the list of all alarms associated with a customer in OLT Cloud. The customer can be identified by any of the available search parameters. If more than one parameter is provided, the endpoint will use their combination to narrow down the results.
\nOptional search parameters:
\nid: internal customer ID in OLT Cloud.
\npppoe: customer PPPoE username registered in OLT Cloud.
\ndocument: customer’s CPF or CNPJ.
\nexternal_id: external customer identifier coming from integrations.
\nexternal_contract_id: external contract identifier coming from integrations.
\nThe response includes all alarms in which the customer is involved (for example, alarms generated from the OLT, PON, CTO, or directly from the customer’s device), allowing the support or monitoring system to quickly view the history and current status of alerts related to this customer.
\n","urlObject":{"path":["api","v2","client","device_alert"],"host":["https://your-instance.olt.com"],"query":[{"key":"id","value":"55789"},{"disabled":true,"key":"pppoe","value":null},{"disabled":true,"key":"document","value":null},{"disabled":true,"key":"external_id","value":null},{"disabled":true,"key":"external_contract_id","value":null}],"variable":[]}},"response":[{"id":"91d4637f-02d0-4086-9739-96734a8e648c","name":"GET Client Alerts","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://your-instance.olt.com/api/v2/client/device_alert?id=55789","host":["https://your-instance.olt.com"],"path":["api","v2","client","device_alert"],"query":[{"key":"id","value":"55789"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"return\": true,\n \"client\": {\n \"id\": 55789,\n \"external_id\": null,\n \"external_contract_id\": null,\n \"client_name\": \"Gabriel Schiavon Camargo\",\n \"document\": \"03205678999\",\n \"pppoe\": \"gabriel.camargo2@fenix\",\n \"pppoe_password\": \"1234\",\n \"status\": \"Ativo\",\n \"plan\": \"750M_INNON_MAIS_CPF\",\n \"address\": \"Rua Antônio Maria Johnsson, 776 - Centro, Colombo - PR\",\n \"street\": \"Rua Antônio Maria Johnsson\",\n \"number\": \"776\",\n \"neighborhood\": \"Centro\",\n \"city\": \"Colombo\",\n \"state\": \"Paraná\",\n \"zip_code\": \"83412220\",\n \"address_reference\": \"\",\n \"coordinates\": \"\",\n \"contact\": 52991424730,\n \"secondary_contact\": 52991424730,\n \"box\": \"27.02.05.037A\",\n \"box_port\": 3,\n \"tags\": [],\n \"impact_activity\": [],\n \"email\": \"asdasdewe@hotmail.com\"\n },\n \"alerts\": [\n {\n \"id\": 372,\n \"alert_type\": \"cto_loss\",\n \"olt_id\": 44,\n \"olt_name\": \"27 - Colombo Centro\",\n \"initial_date\": \"2025-08-18 09:43:44\",\n \"confirm_date\": null,\n \"end_date\": \"2025-08-18 17:24:49\",\n \"ignored\": false,\n \"config_id\": 1,\n \"config_name\": \"MONITORAMENTO CTO\",\n \"description\": \"ONUs em LOSS na CTO 27.02.05.037A OLT 27 - Colombo Centro\",\n \"event_id\": 25,\n \"event_name\": \"27 - Colombo Centro 18/08/2025 09:43\",\n \"total_devices_count\": 16,\n \"active_devices_count\": 0,\n \"cto_id\": 31,\n \"cto_name\": \"27.02.05.037A\",\n \"internal_id\": null,\n \"affected_devices\": [\n {\n \"id\": 3438,\n \"device_index\": \"44:FHTT92830D70\",\n \"onu_device\": {\n \"id\": 1654608,\n \"sn_onu\": \"FHTT92830D70\",\n \"alias\": \"gabriel.camargo2@fenix\",\n \"model\": \"AN5506-02-F\",\n \"status\": \"Online\",\n \"last_status_change\": \"29/10/2025 18:04:57\",\n \"client_id\": 55789,\n \"client_name\": \"Gabriel Schiavon Camargo\",\n \"client_login\": \"gabriel.camargo2@fenix\",\n \"cto_id\": 31,\n \"cto_name\": \"27.02.05.037A\",\n \"cto_port\": 3,\n \"vip\": false\n },\n \"last_rx_onu\": -23.76,\n \"last_rx_olt\": -23.2,\n \"last_rx_updated\": \"15/08/2025 05:11:38\",\n \"after_rx_onu\": -23.76,\n \"after_rx_olt\": -23.3,\n \"after_rx_updated\": \"18/08/2025 19:09:57\",\n \"registered\": \"18/08/2025 09:43:44\",\n \"deregistered\": \"18/08/2025 09:43:30\"\n }\n ],\n \"comments\": []\n }\n ]\n}"}],"_postman_id":"a8c0d4fd-58e1-404e-b104-7616cda976df"}],"id":"2704feb6-e18d-425c-8de9-9fc21b65f77c","_postman_id":"2704feb6-e18d-425c-8de9-9fc21b65f77c","description":""},{"name":"Boxes","item":[{"name":"GET Box","id":"bf968667-a74d-4948-9801-39cdf91c9291","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/box/{box_id}","urlObject":{"path":["api","v2","box","{box_id}"],"host":["https://your-instance.olt.com"],"query":[],"variable":[]}},"response":[{"id":"f702ffb2-7582-4fd7-b140-05d99727e2a9","name":"GET Box","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/box/100"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 07 Oct 2024 12:52:18 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1539"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": true,\n \"box\": {\n \"id\": 302,\n \"name\": \"12.00.00.001A\",\n \"ports\": 16,\n \"status\": \"Ativo\",\n \"pon_id\": null,\n \"initial_rx\": 0,\n \"zip_code\": null,\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"address_reference\": \"\",\n \"coordinates\": \"-1.00000, 0.100000\",\n \"description\": \"\",\n \"occupation\": [\n {\n \"port\": 1,\n \"status\": \"Livre\",\n \"client_id\": null,\n \"client_name\": null,\n \"pppoe\": null\n },\n {\n \"port\": 2,\n \"status\": \"Livre\",\n \"client_id\": null,\n \"client_name\": null,\n \"pppoe\": null\n },\n {\n \"port\": 3,\n \"status\": \"Livre\",\n \"client_id\": null,\n \"client_name\": null,\n \"pppoe\": null\n },\n {\n \"port\": 4,\n \"status\": \"Livre\",\n \"client_id\": null,\n \"client_name\": null,\n \"pppoe\": null\n },\n {\n \"port\": 5,\n \"status\": \"Livre\",\n \"client_id\": null,\n \"client_name\": null,\n \"pppoe\": null\n },\n {\n \"port\": 6,\n \"status\": \"Livre\",\n \"client_id\": null,\n \"client_name\": null,\n \"pppoe\": null\n },\n {\n \"port\": 7,\n \"status\": \"Livre\",\n \"client_id\": null,\n \"client_name\": null,\n \"pppoe\": null\n },\n {\n \"port\": 8,\n \"status\": \"Ocupada\",\n \"client_id\": 3,\n \"client_name\": \"João Silva\",\n \"pppoe\": \"joao.silva1\"\n },\n {\n \"port\": 9,\n \"status\": \"Livre\",\n \"client_id\": null,\n \"client_name\": null,\n \"pppoe\": null\n },\n {\n \"port\": 10,\n \"status\": \"Livre\",\n \"client_id\": null,\n \"client_name\": null,\n \"pppoe\": null\n },\n {\n \"port\": 11,\n \"status\": \"Livre\",\n \"client_id\": null,\n \"client_name\": null,\n \"pppoe\": null\n },\n {\n \"port\": 12,\n \"status\": \"Livre\",\n \"client_id\": null,\n \"client_name\": null,\n \"pppoe\": null\n },\n {\n \"port\": 13,\n \"status\": \"Livre\",\n \"client_id\": null,\n \"client_name\": null,\n \"pppoe\": null\n },\n {\n \"port\": 14,\n \"status\": \"Livre\",\n \"client_id\": null,\n \"client_name\": null,\n \"pppoe\": null\n },\n {\n \"port\": 15,\n \"status\": \"Livre\",\n \"client_id\": null,\n \"client_name\": null,\n \"pppoe\": null\n },\n {\n \"port\": 16,\n \"status\": \"Livre\",\n \"client_id\": null,\n \"client_name\": null,\n \"pppoe\": null\n }\n ]\n }\n}"}],"_postman_id":"bf968667-a74d-4948-9801-39cdf91c9291"},{"name":"LIST Boxes","id":"0397ebcc-403d-4237-a4cb-2ddc14763b75","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/box/list","urlObject":{"path":["api","v2","box","list"],"host":["https://your-instance.olt.com"],"query":[{"disabled":true,"key":"id","value":""},{"disabled":true,"key":"name","value":""},{"disabled":true,"description":{"content":"number of BOX ports
\n","type":"text/plain"},"key":"ports","value":""},{"disabled":true,"description":{"content":"OLT linked to the service box
\n","type":"text/plain"},"key":"olt","value":""},{"disabled":true,"description":{"content":"OLT slot linked to the service box
\n","type":"text/plain"},"key":"slot","value":""},{"disabled":true,"description":{"content":"OLT PON linked to the service box
\n","type":"text/plain"},"key":"pon","value":""},{"disabled":true,"description":{"content":"Internal OLT ID
\n","type":"text/plain"},"key":"olt_id","value":""},{"disabled":true,"description":{"content":"External OLT ID
\n","type":"text/plain"},"key":"olt_external_id","value":""},{"disabled":true,"description":{"content":"OLT Slot internal ID
\n","type":"text/plain"},"key":"slot_id","value":""},{"disabled":true,"description":{"content":"OLT PON internal ID
\n","type":"text/plain"},"key":"pon_id","value":""},{"disabled":true,"description":{"content":"RX level at the time of creating the service box
\n","type":"text/plain"},"key":"initial_rx","value":""},{"disabled":true,"description":{"content":"Service box status
\n","type":"text/plain"},"key":"status","value":""},{"disabled":true,"key":"zip_code","value":""},{"disabled":true,"key":"street","value":""},{"disabled":true,"key":"number","value":""},{"disabled":true,"key":"neighborhood","value":""},{"disabled":true,"key":"city","value":""},{"disabled":true,"key":"state","value":""},{"disabled":true,"key":"address_reference","value":""},{"disabled":true,"description":{"content":"Please enter coordinates in decimal format. Example: '00.0000, 00.11111'
\n","type":"text/plain"},"key":"coordinates","value":""},{"disabled":true,"key":"description","value":""},{"disabled":true,"key":"external_id","value":null}],"variable":[]}},"response":[{"id":"aba6cf22-799a-4181-8f87-7e7a659b2d00","name":"LIST Boxes","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":{"raw":"https://your-instance.olt.com/api/v2/box/list?id&name&ports&olt&slot&pon&olt_id&olt_external_id&slot_id&pon_id&initial_rx&status&zip_code&street&number&neighborhood&city&state&address_reference&coordinates=&description","host":["https://your-instance.olt.com"],"path":["api","v2","box","list"],"query":[{"key":"id","value":null},{"key":"name","value":null},{"key":"ports","value":null,"description":"number of BOX ports"},{"key":"olt","value":null,"description":"OLT linked to the service box"},{"key":"slot","value":null,"description":"OLT slot linked to the service box"},{"key":"pon","value":null,"description":"OLT PON linked to the service box"},{"key":"olt_id","value":null,"description":"Internal OLT ID"},{"key":"olt_external_id","value":null,"description":"External OLT ID"},{"key":"slot_id","value":null,"description":"OLT Slot internal ID"},{"key":"pon_id","value":null,"description":"OLT PON internal ID"},{"key":"initial_rx","value":null,"description":"RX level at the time of creating the service box"},{"key":"status","value":null,"description":"Service box status"},{"key":"zip_code","value":null},{"key":"street","value":null},{"key":"number","value":null},{"key":"neighborhood","value":null},{"key":"city","value":null},{"key":"state","value":null},{"key":"address_reference","value":null},{"key":"coordinates","value":"","description":"Please enter coordinates in decimal format. Example: '00.0000, 00.11111'"},{"key":"description","value":null}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 07 Oct 2024 12:54:25 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"113928"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": true,\n \"count\": 197,\n \"next\": \"https://your-instance.olt.com/api/v2/box/list?page=2\",\n \"previous\": null,\n \"results\": [\n {\n \"id\": 302,\n \"name\": \"12.00.00.001A\",\n \"ports\": 16,\n \"status\": \"Ativo\",\n \"pon_id\": null,\n \"initial_rx\": 0,\n \"zip_code\": null,\n \"street\": \"\",\n \"number\": \"\",\n \"neighborhood\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"address_reference\": \"\",\n \"coordinates\": \"-1.00000, 0.100000\",\n \"description\": \"\",\n \"occupation\": [\n {\n \"port\": 1,\n \"status\": \"Livre\",\n \"client_id\": null,\n \"client_name\": null,\n \"pppoe\": null\n },\n {\n \"port\": 2,\n \"status\": \"Livre\",\n \"client_id\": null,\n \"client_name\": null,\n \"pppoe\": null\n },\n {\n \"port\": 3,\n \"status\": \"Livre\",\n \"client_id\": null,\n \"client_name\": null,\n \"pppoe\": null\n },\n {\n \"port\": 4,\n \"status\": \"Livre\",\n \"client_id\": null,\n \"client_name\": null,\n \"pppoe\": null\n },\n {\n \"port\": 5,\n \"status\": \"Livre\",\n \"client_id\": null,\n \"client_name\": null,\n \"pppoe\": null\n },\n {\n \"port\": 6,\n \"status\": \"Livre\",\n \"client_id\": null,\n \"client_name\": null,\n \"pppoe\": null\n },\n {\n \"port\": 7,\n \"status\": \"Livre\",\n \"client_id\": null,\n \"client_name\": null,\n \"pppoe\": null\n },\n {\n \"port\": 8,\n \"status\": \"Ocupada\",\n \"client_id\": 3,\n \"client_name\": \"João Silva\",\n \"pppoe\": \"joao.silva1\",\n \"external_client_id\": null,\n \"external_client_contract_id\": null\n },\n {\n \"port\": 9,\n \"status\": \"Livre\",\n \"client_id\": null,\n \"client_name\": null,\n \"pppoe\": null\n },\n {\n \"port\": 10,\n \"status\": \"Livre\",\n \"client_id\": null,\n \"client_name\": null,\n \"pppoe\": null\n },\n {\n \"port\": 11,\n \"status\": \"Livre\",\n \"client_id\": null,\n \"client_name\": null,\n \"pppoe\": null\n },\n {\n \"port\": 12,\n \"status\": \"Livre\",\n \"client_id\": null,\n \"client_name\": null,\n \"pppoe\": null\n },\n {\n \"port\": 13,\n \"status\": \"Livre\",\n \"client_id\": null,\n \"client_name\": null,\n \"pppoe\": null\n },\n {\n \"port\": 14,\n \"status\": \"Livre\",\n \"client_id\": null,\n \"client_name\": null,\n \"pppoe\": null\n },\n {\n \"port\": 15,\n \"status\": \"Livre\",\n \"client_id\": null,\n \"client_name\": null,\n \"pppoe\": null\n },\n {\n \"port\": 16,\n \"status\": \"Livre\",\n \"client_id\": null,\n \"client_name\": null,\n \"pppoe\": null\n }\n ]\n }\n ]\n}"}],"_postman_id":"0397ebcc-403d-4237-a4cb-2ddc14763b75"},{"name":"CREATE Box","id":"ec89a038-9826-4336-af2f-32d064629845","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"BOX Example\",\n \"ports\": 16,\n \"coordinates\": \"-11.0000, -21.0000\",\n \"status\": 0,\n \"olt_id\": 1,\n \"olt_external_id\": 5,\n \"slot\": 1,\n \"pon\": 1,\n \"initial_rx\": -20.65,\n \"street\": \"AV BRASIL\",\n \"number\": \"269\",\n \"neighborhood\": \"Centro\",\n \"city\": \"Curitiba\",\n \"state\": \"Paraná\",\n \"zip_code\": \"89249000\",\n \"address_reference\": \"\",\n \"description\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://your-instance.olt.com/api/v2/box/create","description":"OLT Identification
\n\n\nThe
\nolt_idfield refers to the internal ID of the OLT within OLT Cloud. These IDs can be obtained from the existing OLT listing endpoint under the FTTH > OLTs module.
\n\n","urlObject":{"path":["api","v2","box","create"],"host":["https://your-instance.olt.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ec89a038-9826-4336-af2f-32d064629845"},{"name":"UPDATE Box","id":"bd0d0334-0021-4c57-b8b9-0315fd332d78","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"BOX Example\",\n \"ports\": 16,\n \"coordinates\": \"-11.0000, -21.0000\",\n \"status\": 0,\n \"olt_id\": 1,\n \"olt_external_id\": 5,\n \"slot\": 1,\n \"pon\": 1,\n \"initial_rx\": -20.65,\n \"street\": \"AV BRASIL\",\n \"number\": \"269\",\n \"neighborhood\": \"Centro\",\n \"city\": \"Curitiba\",\n \"state\": \"Paraná\",\n \"zip_code\": \"89249000\",\n \"address_reference\": \"\",\n \"description\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://your-instance.olt.com/api/v2/box/{box_id}","description":"Alternatively, you may use
\nolt_external_idto reference the OLT by its external identifier from your ERP system. To use this field, the External ID field of the OLT registration in OLT Cloud must contain the corresponding internal OLT identifier from your ERP.
OLT Identification
\n\n\nThe
\nolt_idfield refers to the internal ID of the OLT within OLT Cloud. These IDs can be obtained from the existing OLT listing endpoint under the FTTH > OLTs module.
\n\n","urlObject":{"path":["api","v2","box","{box_id}"],"host":["https://your-instance.olt.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"bd0d0334-0021-4c57-b8b9-0315fd332d78"},{"name":"GET Box availability","id":"39bfb6b4-5bf9-443c-99c7-d2a759cdb847","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://your-instance.olt.com/api/v2/box/availability","description":"Alternatively, you may use
\nolt_external_idto reference the OLT by its external identifier from your ERP system. To use this field, the External ID field of the OLT registration in OLT Cloud must contain the corresponding internal OLT identifier from your ERP.
This endpoint is designed to check the availability of ports based on the coordinates provided in the path parameters.
\n\n\nBy default, if no value is provided for the \"radius\" field, a distance of 1000 meters is set for searching for service boxes with available ports.
\n
The \"availability\" field returned refers to the number of available ports in the service box.
\n","urlObject":{"path":["api","v2","box","availability"],"host":["https://your-instance.olt.com"],"query":[{"disabled":true,"key":"lat","value":"-26.18375287156119"},{"disabled":true,"key":"lng","value":"-48.61538034832132"},{"disabled":true,"key":"radius","value":"1000"}],"variable":[]}},"response":[{"id":"b89203a8-a6ae-44e1-b453-758ce7f9bf99","name":"GET Box availability","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":{"raw":"https://your-instance.olt.com/api/v2/box/availability?lat=-26.18375287156119&lng=-48.61538034832132&radius=1000","protocol":"https","host":["your-instance","olt","com"],"path":["api","v2","box","availability"],"query":[{"key":"lat","value":"-26.18375287156119"},{"key":"lng","value":"-48.61538034832132"},{"key":"radius","value":"1000"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 07 Oct 2024 14:06:57 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"1100"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": true,\n \"total\": 10,\n \"boxes\": [\n {\n \"id\": 295,\n \"name\": \"92.02.05.008\",\n \"distance\": 85.8,\n \"lat\": -26.18304555,\n \"lng\": -48.61572336,\n \"availability\": 7\n },\n {\n \"id\": 294,\n \"name\": \"92.02.05.006\",\n \"distance\": 96.67,\n \"lat\": -26.183448,\n \"lng\": -48.61447345,\n \"availability\": 8\n },\n {\n \"id\": 290,\n \"name\": \"92.02.05.004\",\n \"distance\": 148.74,\n \"lat\": -26.18417911,\n \"lng\": -48.61396793,\n \"availability\": 7\n },\n {\n \"id\": 297,\n \"name\": \"92.02.05.009\",\n \"distance\": 180.59,\n \"lat\": -26.18329625,\n \"lng\": -48.6171165,\n \"availability\": 8\n },\n {\n \"id\": 296,\n \"name\": \"92.02.05.010\",\n \"distance\": 198.07,\n \"lat\": -26.18215356,\n \"lng\": -48.61625284,\n \"availability\": 7\n },\n {\n \"id\": 292,\n \"name\": \"92.02.05.005\",\n \"distance\": 216.91,\n \"lat\": -26.18215288,\n \"lng\": -48.61413805,\n \"availability\": 6\n },\n {\n \"id\": 291,\n \"name\": \"92.02.05.003\",\n \"distance\": 218.62,\n \"lat\": -26.18274391,\n \"lng\": -48.61350076,\n \"availability\": 8\n },\n {\n \"id\": 293,\n \"name\": \"92.02.05.007\",\n \"distance\": 223.02,\n \"lat\": -26.18186946,\n \"lng\": -48.61461414,\n \"availability\": 8\n },\n {\n \"id\": 288,\n \"name\": \"92.02.05.002\",\n \"distance\": 326.41,\n \"lat\": -26.18461854,\n \"lng\": -48.61225573,\n \"availability\": 8\n },\n {\n \"id\": 287,\n \"name\": \"92.02.05.001\",\n \"distance\": 544.71,\n \"lat\": -26.1846020749318,\n \"lng\": -48.6100058163949,\n \"availability\": 8\n }\n ]\n}"}],"_postman_id":"39bfb6b4-5bf9-443c-99c7-d2a759cdb847"},{"name":"UPDATE Box ocuppation","id":"f6033166-8269-40ad-ada9-fca44e2be739","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"body":{"mode":"raw","raw":"{\n \"port\": 1,\n \"client_id\": 3\n}","options":{"raw":{"language":"json"}}},"url":"https://your-instance.olt.com/api/v2/box/update/occupation/100","description":"This endpoint is used to update the occupancy of a service box. To link a client to one of the box's ports, it is necessary to provide the port number in the \"port\" field and one of the other client identification fields:
\nTo set a port as free, simply send a POST request to the endpoint, including only the port number to be released in the body of the request.
\n","urlObject":{"path":["api","v2","box","update","occupation","100"],"host":["https://your-instance.olt.com"],"query":[],"variable":[]}},"response":[{"id":"48e676b4-b8e4-4883-8a15-9e1230d67cac","name":"UPDATE Box ocuppation","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"body":{"mode":"raw","raw":"{\n \"port\": 1,\n \"client_id\": 3\n}","options":{"raw":{"language":"json"}}},"url":"https://your-instance.olt.com/api/v2/box/update/occupation/100"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 07 Oct 2024 14:58:23 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"83"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": true,\n \"message\": \"Client \\\"João Silva\\\" add in port:1 box: 12.00.00.001A\"\n}"}],"_postman_id":"f6033166-8269-40ad-ada9-fca44e2be739"},{"name":"UPDATE Box reserve port","id":"056a7896-32c7-4138-9bcc-e0d374f34346","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"body":{"mode":"raw","raw":"{\n \"port\": 3,\n \"reserve_reason\": \"Porta reservada para venda\"\n}","options":{"raw":{"language":"json"}}},"url":"https://your-instance.olt.com/api/v2/box/update/reserve/100","description":"This endpoint is used to reserve a port. The only mandatory field is the \"port\" field. If you wish to link a client to the port reservation, it is necessary to provide one of the other client identification fields:
\nThis endpoint provides statistical data for the PON linked to the service box.
\nThis endpoint only allows the removal of boxes that do not have any occupied ports. If at least one port is currently in use, the deletion request will be rejected to prevent inconsistencies, and an error message will be returned
\n","urlObject":{"path":["api","v2","box","{box_id}"],"host":["https://your-instance.olt.com"],"query":[],"variable":[]}},"response":[{"id":"dcab8153-b74f-4e0c-9816-a4ecc2a0be19","name":"DELETE Box","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/box/{box_id}"},"status":"No Content","code":204,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":""}],"_postman_id":"0d5f3cb3-3421-4e20-b0da-d6ba890bfc03"}],"id":"737a3871-ba49-41b2-8760-ef2b8e58f706","description":"This topic is related to the service boxes.
\n","_postman_id":"737a3871-ba49-41b2-8760-ef2b8e58f706"},{"name":"FTTH","item":[{"name":"Alerts","item":[{"name":"LIST Alerts","id":"9d25fb89-bf8e-4cd0-930e-fbdce1c06618","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://your-instance.olt.com/api/v2/ftth/alert/list","description":"This endpoint retrieves a list of alerts generated within the OLT Cloud platform. It supports multiple filtering options to refine search results based on alert details, associated equipment, time periods, and configuration data.
\n","urlObject":{"path":["api","v2","ftth","alert","list"],"host":["https://your-instance.olt.com"],"query":[{"disabled":true,"key":"alert_type","value":""},{"disabled":true,"key":"olt_id","value":""},{"disabled":true,"key":"olt_name","value":""},{"disabled":true,"key":"initial_date","value":""},{"disabled":true,"key":"confirm_date","value":""},{"disabled":true,"key":"end_date","value":""},{"disabled":true,"key":"ignored","value":""},{"disabled":true,"key":"config_id","value":""},{"disabled":true,"key":"config_name","value":""},{"disabled":true,"key":"description","value":""},{"disabled":true,"key":"event_id","value":""},{"disabled":true,"key":"event_name","value":""},{"disabled":true,"key":"pon_id","value":""},{"disabled":true,"key":"pon","value":""},{"disabled":true,"key":"pon_description","value":""},{"disabled":true,"key":"slot_pon","value":""},{"disabled":true,"key":"cto_id","value":""},{"disabled":true,"key":"cto_name","value":""}],"variable":[]}},"response":[{"id":"912369d7-601a-4961-abed-88f0eb450d8a","name":"LIST Alerts","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://your-instance.olt.com/api/v2/ftth/alert/list","host":["https://your-instance.olt.com"],"path":["api","v2","ftth","alert","list"],"query":[{"key":"alert_type","value":"","type":"text","disabled":true},{"key":"olt_id","value":"","type":"text","disabled":true},{"key":"olt_name","value":"","type":"text","disabled":true},{"key":"initial_date","value":"","type":"text","disabled":true},{"key":"confirm_date","value":"","type":"text","disabled":true},{"key":"end_date","value":"","type":"text","disabled":true},{"key":"ignored","value":"","type":"text","disabled":true},{"key":"config_id","value":"","type":"text","disabled":true},{"key":"config_name","value":"","type":"text","disabled":true},{"key":"description","value":"","type":"text","disabled":true},{"key":"event_id","value":"","type":"text","disabled":true},{"key":"event_name","value":"","type":"text","disabled":true},{"key":"pon_id","value":"","type":"text","disabled":true},{"key":"pon","value":"","type":"text","disabled":true},{"key":"pon_description","value":"","type":"text","disabled":true},{"key":"slot_pon","value":"","type":"text","disabled":true},{"key":"cto_id","value":"","type":"text","disabled":true},{"key":"cto_name","value":"","type":"text","disabled":true}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"return\": true,\n \"count\": 3,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": 1,\n \"alert_type\": \"cto_loss\",\n \"olt_id\": 3,\n \"olt_name\": \"OLT_ZTE_FWN_02\",\n \"initial_date\": \"2025-08-14 13:13:22\",\n \"confirm_date\": \"2025-08-14 13:56:49\",\n \"end_date\": null,\n \"ignored\": true,\n \"config_id\": 1000,\n \"config_name\": \"ALERTA POR CTO TESTE\",\n \"description\": \"ONUs em LOSS na CTO NAP-10-03B OLT OLT_ZTE_FWN_02\",\n \"event_id\": 1,\n \"event_name\": \"OLT_ZTE_FWN_02 14/08/2025 13:13\",\n \"total_devices_count\": 3,\n \"active_devices_count\": 3,\n \"cto_id\": 6773,\n \"cto_name\": \"NAP-10-03B\"\n },\n {\n \"id\": 5,\n \"alert_type\": \"cto_loss\",\n \"olt_id\": 3,\n \"olt_name\": \"OLT_ZTE_FWN_02\",\n \"initial_date\": \"2025-08-14 13:24:07\",\n \"confirm_date\": \"2025-08-14 13:52:02\",\n \"end_date\": null,\n \"ignored\": false,\n \"config_id\": 1000,\n \"config_name\": \"ALERTA POR CTO TESTE\",\n \"description\": \"ONUs em LOSS na CTO NAP-28-06 OLT OLT_ZTE_FWN_02\",\n \"event_id\": 1,\n \"event_name\": \"OLT_ZTE_FWN_02 14/08/2025 13:13\",\n \"total_devices_count\": 14,\n \"active_devices_count\": 14,\n \"cto_id\": 5606,\n \"cto_name\": \"NAP-28-06\"\n },\n {\n \"id\": 6,\n \"alert_type\": \"cto_loss\",\n \"olt_id\": 3,\n \"olt_name\": \"OLT_ZTE_FWN_02\",\n \"initial_date\": \"2025-08-14 13:24:07\",\n \"confirm_date\": \"2025-08-14 13:56:50\",\n \"end_date\": null,\n \"ignored\": true,\n \"config_id\": 1000,\n \"config_name\": \"ALERTA POR CTO TESTE\",\n \"description\": \"ONUs em LOSS na CTO NAP-28-07 OLT OLT_ZTE_FWN_02\",\n \"event_id\": 1,\n \"event_name\": \"OLT_ZTE_FWN_02 14/08/2025 13:13\",\n \"total_devices_count\": 6,\n \"active_devices_count\": 6,\n \"cto_id\": 6856,\n \"cto_name\": \"NAP-28-07\"\n }\n ]\n}"}],"_postman_id":"9d25fb89-bf8e-4cd0-930e-fbdce1c06618"},{"name":"GET Alert","id":"ea271646-9dca-4063-adb0-b643d784565f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://your-instance.olt.com/api/v2/ftth/alert/Retrieves detailed information for a specific FTTH alert by its unique identifier (pk).
Path Parameter
\nThis endpoint allows a user to confirm an existing alarm by providing its unique identifier, represented by the field pk.
Confirming an alarm updates its status to indicate that the event has been acknowledged and is being reviewed or handled by the responsible user.
\n","urlObject":{"path":["api","v2","ftth","alert","This endpoint allows a user to ignore an existing alarm by providing its unique identifier, represented by the field pk.
Ignoring an alarm updates its status to indicate that the event has been intentionally disregarded, meaning no action will be taken upon it at this moment by the responsible user.
\n","urlObject":{"path":["api","v2","ftth","alert","This endpoint allows a user to reactivate a previously confirmed or ignored alarm by providing its unique identifier, represented by the field pk.
Reactivating an alarm updates its status to indicate that the event is once again active and requires evaluation or handling by the responsible user.
\n","urlObject":{"path":["api","v2","ftth","alert","This endpoint allows updating the value of the internal ID field of an alert. The field must be sent as a string and must not exceed 100 characters.
\n","urlObject":{"path":["api","v2","ftth","alert","This endpoint allows updating the value of the internal ID field for the provided list of alert IDs. The internal ID field must be sent as a string and must not exceed 100 characters.
\nIn case of success, the status field will be returned with the value true, and the updated field will contain the number of alerts updated.
This endpoint allows confirming the provided list of alert IDs.
\nIf the request is successful, the status field will be returned with the value true, and the updated field will contain the number of updated alerts.
\n","urlObject":{"path":["api","v2","ftth","alert","batch","confirm"],"host":["https://your-instance.olt.com"],"query":[],"variable":[]}},"response":[{"id":"79a3ae29-f25c-471f-b0c8-8ad1cbeba3c8","name":"Batch Confirm Alert","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ids\": [10, 11, 15]\n}","options":{"raw":{"language":"json"}}},"url":"https://your-instance.olt.com/api/v2/ftth/alert/batch/confirm"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"return\": true,\n \"updated\": 2,\n \"errors\": [\n {\"id\": 15, \"error\": \"Alert already confirmed\"}\n ]\n}"}],"_postman_id":"4cf95f15-b33f-425e-b64d-7b1f808d155d"},{"name":"Batch Ignore alert","id":"7855013f-add5-492d-83a7-30fbeb955245","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ids\": [10, 11, 15]\n}","options":{"raw":{"language":"json"}}},"url":"https://your-instance.olt.com/api/v2/ftth/alert/batch/ignore","description":"This endpoint allows ignoring the provided list of alert IDs.
\nIf the request is successful, the status field will be returned with the value true, and the updated field will contain the number of updated alerts.
\n","urlObject":{"path":["api","v2","ftth","alert","batch","ignore"],"host":["https://your-instance.olt.com"],"query":[],"variable":[]}},"response":[{"id":"2941e418-dba4-4d86-a00c-baf525caa10b","name":"Batch ignore alert","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ids\": [10, 11, 15]\n}","options":{"raw":{"language":"json"}}},"url":"https://your-instance.olt.com/api/v2/ftth/alert/batch/ignore"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"return\": true,\n \"updated\": 2,\n \"errors\": [\n {\"id\": 15, \"error\": \"Alert already ignored\"}\n ]\n}"}],"_postman_id":"7855013f-add5-492d-83a7-30fbeb955245"},{"name":"Batch reactivate alert","id":"c59ff323-f616-40d5-bc4e-88355d6346aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ids\": [10, 11, 15]\n}","options":{"raw":{"language":"json"}}},"url":"https://your-instance.olt.com/api/v2/ftth/alert/batch/reactivate","description":"This endpoint allows reactivating the provided list of alert IDs.
\nIf the request is successful, the status field will be returned with the value true, and the updated field will contain the number of updated alerts.
\n","urlObject":{"path":["api","v2","ftth","alert","batch","reactivate"],"host":["https://your-instance.olt.com"],"query":[],"variable":[]}},"response":[{"id":"ce8cc015-2e71-4c99-b17a-98f78bb98b7f","name":"Batch reactivate alert","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ids\": [10, 11, 15]\n}","options":{"raw":{"language":"json"}}},"url":"https://your-instance.olt.com/api/v2/ftth/alert/batch/reactivate"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"return\": true,\n \"updated\": 2,\n \"errors\": [\n {\"id\": 15, \"error\": \"Alert already reactivated\"}\n ]\n}"}],"_postman_id":"c59ff323-f616-40d5-bc4e-88355d6346aa"}],"id":"0943ad8c-d8d3-4691-8d18-64dd0edf4a33","_postman_id":"0943ad8c-d8d3-4691-8d18-64dd0edf4a33","description":""},{"name":"ONU Vip","item":[{"name":"Webhook","item":[{"name":"ONU VIP Status Change","id":"658f26a0-c5a4-42ef-91aa-57f29d88a58f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"alert_type\": \"onu_vip\",\n\t\"id\": 1042,\n\t\"sn_onu\": \"HWTC1A2B3C4D\",\n\t\"onu_id\": 3,\n\t\"index_onu\": \"7:HWTC1A2B3C4D\",\n\t\"alias\": \"João Silva\",\n\t\"status\": \"LOSS\",\n\t\"last_status\": \"Online\",\n\t\"last_status_change\": \"2026-05-25T14:32:00\",\n\t\"olt_id\": 7,\n\t\"olt_name\": \"OLT-BAIRRO-NORTE\",\n\t\"slot\": 0,\n\t\"pon_id\": 45,\n\t\"pon_name\": \"PON-RUA-DAS-FLORES\",\n\t\"pon_number\": 4,\n\t\"client_name\": \"João Silva\",\n\t\"client_login\": \"joao.silva\",\n\t\"onu_vip_id\": 12,\n\t\"onu_vip_name\": \"VIP-JOAO\",\n\t\"onu_vip_configured_message\": \"Cliente prioritário - ONU Online!\",\n\t\"notification_group_id\": 3,\n\t\"notification_group_name\": \"NOC-PRINCIPAL\"\n}","options":{"raw":{"language":"json"}}},"url":"{{webhookUrl}}","urlObject":{"host":["{{webhookUrl}}"],"query":[],"variable":[]}},"response":[{"id":"6d00c6af-ed60-4cfb-9284-24e8f5dfb5ed","name":"LOSS - 200 OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"alert_type\": \"onu_vip\",\n\t\"id\": 1042,\n\t\"sn_onu\": \"HWTC1A2B3C4D\",\n\t\"onu_id\": 3,\n\t\"index_onu\": \"7:HWTC1A2B3C4D\",\n\t\"alias\": \"João Silva\",\n\t\"status\": \"LOSS\",\n\t\"last_status\": \"Online\",\n\t\"last_status_change\": \"2026-05-25T14:32:00\",\n\t\"olt_id\": 7,\n\t\"olt_name\": \"OLT-BAIRRO-NORTE\",\n\t\"slot\": 0,\n\t\"pon_id\": 45,\n\t\"pon_name\": \"PON-RUA-DAS-FLORES\",\n\t\"pon_number\": 4,\n\t\"client_name\": \"João Silva\",\n\t\"client_login\": \"joao.silva\",\n\t\"onu_vip_id\": 12,\n\t\"onu_vip_name\": \"VIP-JOAO\",\n\t\"onu_vip_configured_message\": \"Cliente prioritário - ONU Online!\",\n\t\"notification_group_id\": 3,\n\t\"notification_group_name\": \"NOC-PRINCIPAL\"\n}","options":{"raw":{"language":"json"}}},"url":"https://your-server.example.com/webhook/onu-vip"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\"received\": true}"},{"id":"0903300a-c602-4c22-8e6c-dd4439cd3fdb","name":"Online - 200 OK -","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"alert_type\": \"onu_vip\",\n\t\"id\": 1042,\n\t\"sn_onu\": \"HWTC1A2B3C4D\",\n\t\"onu_id\": 3,\n\t\"index_onu\": \"7:HWTC1A2B3C4D\",\n\t\"alias\": \"João Silva\",\n\t\"status\": \"Online\",\n\t\"last_status\": \"LOSS\",\n\t\"last_status_change\": \"2026-05-25T14:32:00\",\n\t\"olt_id\": 7,\n\t\"olt_name\": \"OLT-BAIRRO-NORTE\",\n\t\"slot\": 0,\n\t\"pon_id\": 45,\n\t\"pon_name\": \"PON-RUA-DAS-FLORES\",\n\t\"pon_number\": 4,\n\t\"client_name\": \"João Silva\",\n\t\"client_login\": \"joao.silva\",\n\t\"onu_vip_id\": 12,\n\t\"onu_vip_name\": \"VIP-JOAO\",\n\t\"onu_vip_configured_message\": \"Cliente prioritário - ONU Online!\",\n\t\"notification_group_id\": 3,\n\t\"notification_group_name\": \"NOC-PRINCIPAL\"\n}","options":{"raw":{"language":"json"}}},"url":"https://your-server.example.com/webhook/onu-vip"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\"received\": true}"},{"id":"ccb04aee-c823-4939-a52e-2f7dbf914a8a","name":"No Power - 200 OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"alert_type\": \"onu_vip\",\n\t\"id\": 1042,\n\t\"sn_onu\": \"HWTC1A2B3C4D\",\n\t\"onu_id\": 3,\n\t\"index_onu\": \"7:HWTC1A2B3C4D\",\n\t\"alias\": \"João Silva\",\n\t\"status\": \"Sem Energia\",\n\t\"last_status\": \"Online\",\n\t\"last_status_change\": \"2026-05-25T14:32:00\",\n\t\"olt_id\": 7,\n\t\"olt_name\": \"OLT-BAIRRO-NORTE\",\n\t\"slot\": 0,\n\t\"pon_id\": 45,\n\t\"pon_name\": \"PON-RUA-DAS-FLORES\",\n\t\"pon_number\": 4,\n\t\"client_name\": \"João Silva\",\n\t\"client_login\": \"joao.silva\",\n\t\"onu_vip_id\": 12,\n\t\"onu_vip_name\": \"VIP-JOAO\",\n\t\"onu_vip_configured_message\": \"Cliente prioritário - ONU sem energia\",\n\t\"notification_group_id\": 3,\n\t\"notification_group_name\": \"NOC-PRINCIPAL\"\n}","options":{"raw":{"language":"json"}}},"url":"https://your-server.example.com/webhook/onu-vip"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\"received\": true}"}],"_postman_id":"658f26a0-c5a4-42ef-91aa-57f29d88a58f"}],"id":"aa7d87df-b425-4674-a76f-e4172758efac","description":"When a webhook is configured, the system sends a POST request to the URL configured in the notification group whenever the monitored VIP ONU transitions to a new status.
\nThe webhook is fired when the notification_type of the notification group is set to onu_vip and the ONU VIP status changes.
The field onu_vip_configured_message contains the custom message configured for the specific status in the ONU VIP settings.
Creates a VIP register for the given ONU ID
\nUpdates existing VIP attributes and reapplies VIP and ACL rules.
\nRequest Path Parameter
\nRemove VIP registration from the equipment
\n","urlObject":{"path":["api","v2","ftth","equipment","{id}","vip"],"host":["https://your-instance.olt.com"],"query":[],"variable":[]}},"response":[{"id":"ba7799f2-91ba-4654-b402-eb81e721a57b","name":"Delete ONU VIP","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/ftth/equipment/{id}/vip"},"status":"No Content","code":204,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":""}],"_postman_id":"7537ad36-63db-4697-8119-81cafd338e4b"}],"id":"e81741dc-bbc6-4764-94a5-e6ae022f94d7","description":"Manage VIP status and VIP messages associated with an ONU equipment.
\n","_postman_id":"e81741dc-bbc6-4764-94a5-e6ae022f94d7"},{"name":"ONU Provisioning","item":[{"name":"List Unauthorized ONUs","id":"8e1e9323-0c6d-4606-a57c-717b11ac183b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/ftth/equipment/list/unauth","description":"Returns the ONUs waiting for authorization on each OLT the authenticated user can access. Pass olt_id to scan a single OLT.
Each OLT block reports:
\nolt_id / olt_name - the OLT.quarantined - true when the OLT is under quarantine (its unauth_list is skipped).error - true when the OLT scan failed (its lists come back empty).unauthorized - number of ONUs waiting on that OLT.required_fields - the vendor-specific fields that Authorize ONU will require for this OLT, with their allowed options. Datacom -> line_profile, VSOL -> onu_profile, Huawei -> xgspon (True/False), ZTE -> type_onu.possible_acl - present only when the OLT has more than one linked company; each entry has the company abbreviation and the hash to send in the acl field of Authorize ONU.unauth_list - the ONUs, each with:serial_number - ONU serial number.type - ONU model reported by the OLT.slot / pon - position on the OLT.onu_hash - opaque token (base64 of slot/pon/sn/type) that must be forwarded verbatim to Authorize ONU. Do not build it by hand.client - the client already registered with this serial number (client_id, client_name, client_login), or null when none matches.Errors: a non-numeric olt_id returns 400; an olt_id the user cannot access returns 403; an OLT under quarantine returns 423 when queried directly by id.
Authorizes one ONU on its OLT.
\nRequired body fields:
\nonu_hash (string) - the opaque token from List Unauthorized ONUs. It is decoded server-side into slot/pon/sn/type; forward it verbatim, do not build it by hand. A hash missing any of those fields returns 400.olt_id (integer) - target OLT id. Must be an integer; the user must be allowed to authorize on it, otherwise 403. The OLT must not be under quarantine (423).alias (string) - ONU alias/name.Conditional body fields:
\nacl (string) - mandatory only when the OLT has more than one linked company (see possible_acl in List Unauthorized ONUs). Comma-separated company hashes; every hash must belong to the OLT's allowed companies, otherwise 400. When the OLT has a single company it is assigned automatically and this field is ignored.line_profile (string) - mandatory for Datacom OLTs; must be one of the OLT's line profiles.onu_profile (string) - mandatory for VSOL OLTs; must be one of the OLT's ONU profiles.xgspon (boolean) - mandatory for Huawei OLTs; true provisions as XGS-PON, false as GPON.Optional body fields:
\nclient_id (integer) - link the ONU to this client. Must be an integer and exist/be accessible (403). Any ONUs currently linked to that client are unlinked first.type (string) - overrides the ONU model taken from the hash.Capacity rules: the request is rejected with 400 when the PON port has reached max_amount_onu, or when the owning company has reached its maximum number of linked ONUs. If the OLT rejects the authorization, the equipment record is rolled back and 400 is returned with the OLT message.
On success the ONU is provisioned, linked to the client (when provided), the ACL is applied and an authorization history entry (origin API) is created. The response returns the created equipment (same shape as the Equipment detail endpoint).
Unauthorizes the ONU identified by the equipment_id path parameter.
What it does on success:
\nCancelado or Não Instalado, unlinks the ONU serial from the client.The OLT must not be under quarantine (423). If the equipment id is not found/visible, or the OLT rejects the de-provisioning, 400 is returned.
\n","urlObject":{"path":["api","v2","ftth","equipment","unauth","{{equipment_id}}"],"host":["https://your-instance.olt.com"],"query":[],"variable":[{"id":"32a019c1-ee93-4967-b813-563ba5c1074c","description":{"content":"Equipment (ONU) id to unauthorize. Must be visible to the authenticated user.
\n","type":"text/plain"},"type":"any","value":"88213","key":"equipment_id"}]}},"response":[{"id":"cd4be849-c54b-45d1-8723-9506360d47bc","name":"ONU unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/ftth/equipment/unauth/88213"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": true,\n \"message\": \"ONU unauthorized successfully\"\n}"},{"id":"89a29757-0b25-4f74-8b46-721f4df842b7","name":"Equipment not found","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/ftth/equipment/unauth/999999"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": false,\n \"error\": \"Equipment not found\"\n}"},{"id":"cc93b1a9-aaed-40b2-bbb9-921840df5250","name":"OLT under quarantine","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/ftth/equipment/unauth/88213"},"status":"Locked","code":423,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": false,\n \"error\": \"Olt OLT-CENTRO-01 is under quarantine due to persistent connection failures and is temporarily unavailable for this operation\"\n}"},{"id":"98b93537-5b5d-4688-873a-f418b8b87953","name":"Unauthorized","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/ftth/equipment/unauth/88213"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"Authentication credentials were not provided.\"\n}"}],"_postman_id":"48c4574a-02b6-4ca5-9639-a65c15fc4418"},{"name":"List ONU Scripts","id":"3d74a3ad-0f25-4c09-98ac-46cf7b6b3892","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/ftth/equipment/{{onu}}/list_scripts","description":"Returns the scripts that can be applied to the ONU identified by the onu path parameter.
The identifier is polymorphic:
\nonu_hash (from List Unauthorized ONUs) and resolved against the pending unauthorized ONU.Only scripts compatible with that ONU's OLT and model are returned. Each result has id, name and description. Use the id with Apply ONU Script.
Returns 400 when the equipment/hash cannot be resolved.
\n","urlObject":{"path":["api","v2","ftth","equipment","{{onu}}","list_scripts"],"host":["https://your-instance.olt.com"],"query":[],"variable":[{"id":"e7a7b817-2b23-4a86-a6a1-bbf962c396cc","description":{"content":"ONU identifier: numeric equipment id (authorized ONU) OR the onu_hash from List Unauthorized ONUs (ONU not yet authorized).
\n","type":"text/plain"},"type":"any","value":"88213","key":"onu"}]}},"response":[{"id":"03f52f24-3570-41a0-9082-a7cf620da58b","name":"List ONU Scripts","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/ftth/equipment/88213/list_scripts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": true,\n \"total\": 2,\n \"results\": [\n {\n \"id\": 41,\n \"name\": \"PPPoE Router - Internet\",\n \"description\": \"Provisiona a ONU em modo roteador PPPoE na VLAN de internet\"\n },\n {\n \"id\": 47,\n \"name\": \"Bridge - Internet\",\n \"description\": \"Provisiona a ONU em modo bridge na VLAN de internet\"\n }\n ]\n}"},{"id":"fa952587-5b17-44b4-99e5-c11d2e58a5ac","name":"Equipment not found","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/ftth/equipment/999999/list_scripts"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": false,\n \"error\": \"Equipment not found\"\n}"},{"id":"b44607c5-c44e-4587-a3e6-21d0a1114b89","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/ftth/equipment/88213/list_scripts"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"Authentication credentials were not provided.\"\n}"}],"_postman_id":"3d74a3ad-0f25-4c09-98ac-46cf7b6b3892"},{"name":"Get ONU Script Fields","id":"f162fc50-41c6-4be5-8d7a-d7b967ced8d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/ftth/equipment/{{onu}}/{{script_id}}/script","description":"Returns the input fields required to apply script script_id to ONU onu. Use these to build the Apply ONU Script body.
Each field has:
\nfield - the human label.name - the field key to send in the Apply body.type - text or select.value - for text fields, a pre-filled value when available (e.g. ppp_login/ppp_senha from the linked client, alias from the ONU).options - for select fields, a list of {name, value, default} built from the OLT profiles/VLANs (VLANs, line/service/traffic profiles, LAN port, COS, etc.).Hidden fields are resolved server-side and not returned. The OLT must not be under quarantine (423). Returns 400 when the ONU/hash cannot be resolved or the script is not applicable to this equipment.
\n","urlObject":{"path":["api","v2","ftth","equipment","{{onu}}","{{script_id}}","script"],"host":["https://your-instance.olt.com"],"query":[{"disabled":true,"description":{"content":"Optional. Pending authorization-history record id (OnuDeviceAuth) owned by the user and not yet done; ties the script application to an ongoing provisioning step
\n","type":"text/plain"},"key":"oda","value":"{{oda_id}}"}],"variable":[{"id":"8fcbb7ce-f191-48a6-b68f-1a3e299c1e7b","description":{"content":"ONU identifier: numeric equipment id, or the onu_hash of a not-yet-authorized ONU.
\n","type":"text/plain"},"type":"any","value":"88213","key":"onu"},{"id":"583deeee-6121-4f15-b20a-8d2e2a478b17","description":{"content":"Script id (from List ONU Scripts).
\n","type":"text/plain"},"type":"any","value":"41","key":"script_id"}]}},"response":[{"id":"a37dddb5-402b-4f37-bc88-5696810b4801","name":"Get ONU Script Fields","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/ftth/equipment/88213/41/script"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": true,\n \"results\": [\n {\n \"field\": \"Login PPPoE\",\n \"name\": \"ppp_login\",\n \"type\": \"text\",\n \"value\": \"maria.souza@pppoe\"\n },\n {\n \"field\": \"Senha PPPoE\",\n \"name\": \"ppp_senha\",\n \"type\": \"text\",\n \"value\": \"s3cr3t\"\n },\n {\n \"field\": \"Vlan\",\n \"name\": \"vlan\",\n \"type\": \"select\",\n \"options\": [\n {\n \"name\": \"(100) INTERNET\",\n \"value\": 100,\n \"default\": false\n },\n {\n \"name\": \"(200) VOIP\",\n \"value\": 200,\n \"default\": false\n }\n ]\n }\n ]\n}"},{"id":"22b6fe80-c394-4f14-95ac-04c27b5e8873","name":"Script not applicable","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/ftth/equipment/88213/999/script"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": false,\n \"error\": \"Script cannot be applied to this equipment\"\n}"}],"_postman_id":"f162fc50-41c6-4be5-8d7a-d7b967ced8d9"},{"name":"Apply ONU Script","id":"1507edba-2b15-4f6e-b95f-73df6c6f2cad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ppp_login\": \"maria.souza@pppoe\",\n \"ppp_senha\": \"s3cr3t\",\n \"vlan\": 100\n}","options":{"raw":{"language":"json"}}},"url":"https://your-instance.olt.com/api/v2/ftth/equipment/{{onu}}/{{script_id}}/script","description":"Applies script script_id to ONU onu on its OLT.
The body is a flat object keyed by each field's name from Get ONU Script Fields, with the chosen value. Every non-hidden field is required: a missing or empty field returns 400 with Field <name> is required.
Special handling:
\nvlan field is present, the ONU's VLAN record is updated from the submitted value(s);oda query parameter points to a pending authorization step, that step is advanced on success.Returns {return, message} - 200 with the OLT result message on success, 400 with the failure reason otherwise (missing field, script not applicable, OLT quarantine, or OLT execution error).
ONU identifier: numeric equipment id, or the onu_hash of a not-yet-authorized ONU.
\n","type":"text/plain"},"type":"any","value":"88213","key":"onu"},{"id":"3ec399e1-5ea2-4572-afa2-9637386906f7","description":{"content":"Script id (from List ONU Scripts).
\n","type":"text/plain"},"type":"any","value":"41","key":"script_id"}]}},"response":[{"id":"dfb31706-5cdb-4d8a-96b0-8c0b18b93773","name":"Script applied","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ppp_login\": \"maria.souza@pppoe\",\n \"ppp_senha\": \"s3cr3t\",\n \"vlan\": 100\n}","options":{"raw":{"language":"json"}}},"url":"https://your-instance.olt.com/api/v2/ftth/equipment/88213/41/script"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": true,\n \"message\": \"Script applied successfully\"\n}"},{"id":"a8a6b612-10b0-4818-bec6-ac218fc36d1d","name":"Required field missing","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ppp_login\": \"maria.souza@pppoe\",\n \"ppp_senha\": \"s3cr3t\"\n}","options":{"raw":{"language":"json"}}},"url":"https://your-instance.olt.com/api/v2/ftth/equipment/88213/41/script"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": false,\n \"error\": \"Field vlan is required\"\n}"},{"id":"2eef3ed2-c3ac-4805-942f-c8585e645df8","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ppp_login\": \"maria.souza@pppoe\",\n \"ppp_senha\": \"s3cr3t\",\n \"vlan\": 100\n}","options":{"raw":{"language":"json"}}},"url":"https://your-instance.olt.com/api/v2/ftth/equipment/88213/41/script"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"Authentication credentials were not provided.\"\n}"}],"_postman_id":"1507edba-2b15-4f6e-b95f-73df6c6f2cad"},{"name":"List ONU provisioning history","id":"7f07e208-9595-4b84-b6b4-818554f4a296","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/ftth/equipment/{onu_id}/script_history","description":"Returns the provisioning history for a specific ONU, including the scripts and actions executed on the device
\n","urlObject":{"path":["api","v2","ftth","equipment","{onu_id}","script_history"],"host":["https://your-instance.olt.com"],"query":[],"variable":[]}},"response":[{"id":"b7c05ed5-a946-4959-9fa7-ff6880cae5fe","name":"List ONU provisioning history","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/ftth/equipment/{onu_id}/script_history"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"return\": true,\n \"results\": [\n {\n \"script_id\": 16,\n \"script_name\": \"ONT ROUTER (internet)\",\n \"commands\": [\n \"environment inhibit-alarms\\nexit all\",\n \"configure equipment ont slot 1/1/1/8/67/1 admin-state down\",\n \"configure equipment ont no slot 1/1/1/8/67/1\\nexit all\",\n \"configure equipment ont slot 1/1/1/8/67/14 planned-card-type veip plndnumdataports 1 plndnumvoiceports 0 admin-state up\\nexit all\",\n \"configure qos interface 1/1/1/8/67/14/1 upstream-queue 0 bandwidth-profile name:600M\\nexit all\",\n \"configure qos interface 1/1/1/8/67/14/1 queue 0 shaper-profile name:600M\\nexit all\",\n \"configure interface port uni:1/1/1/8/67/14/1 admin-up\\nexit all\",\n \"configure bridge port 1/1/1/8/67/14/1\\nvlan-id 300\\nexit all\",\n \"configure bridge port 1/1/1/8/67/14/1\\nvlan-id 400\\nexit all\",\n \"configure bridge port 1/1/1/8/67/14/1\\npvid 400\\nexit all\",\n \"configure bridge port 1/1/1/8/67/14/1 max-unicast-mac 2\"\n ],\n \"output\": \"\",\n \"fail\": false,\n \"executed_at\": \"2026-05-06 10:42:19\",\n \"executed_by\": \"user.name\"\n }\n ]\n}"}],"_postman_id":"7f07e208-9595-4b84-b6b4-818554f4a296"}],"id":"f565643e-f3fa-4633-b4b2-d59aea3a4701","_postman_id":"f565643e-f3fa-4633-b4b2-d59aea3a4701","description":""},{"name":"OLT Provisioning","item":[{"name":"List OLT Profiles and VLANs","id":"665823fd-2f45-493b-a683-d273b48262c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/ftth/olt/{{olt_id}}/profiles_vlans","description":"Returns the provisioning profiles and VLANs of the OLT identified by the olt_id path parameter.
profiles - a vendor-dependent object. The keys and their meaning change per vendor, e.g. Fiberhome exposes bw_prfs / ngn / vlan / uplink / onu_type; ZTE exposes download/upload/line/service profiles, uplinks and onu types; other vendors expose their own sets. Use it to fill the vendor field required by Authorize ONU (Datacom line_profile, VSOL onu_profile, etc.).vlans - the list of VLANs configured on the OLT.The OLT must not be under quarantine (423). Returns 403 when the OLT is not found/visible, and 400 on an internal processing error.
\n","urlObject":{"path":["api","v2","ftth","olt","{{olt_id}}","profiles_vlans"],"host":["https://your-instance.olt.com"],"query":[],"variable":[{"id":"bb190168-14d9-40e1-ac3f-60013c6996c6","description":{"content":"OLT id whose profiles/VLANs to list. Must be visible to the authenticated user.
\n","type":"text/plain"},"type":"any","value":"12","key":"olt_id"}]}},"response":[{"id":"da8802cb-1f3a-432f-bf8e-1fa046ddf61d","name":"List OLT Profiles and VLANs","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/ftth/olt/12/profiles_vlans"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": true,\n \"profiles\": {\n \"onu_type\": [\n \"HG8145V5\",\n \"EG8145V5\"\n ],\n \"line_profile\": [\n \"LINE-1G\",\n \"LINE-500M\"\n ],\n \"srv_profile\": [\n \"SRV-INTERNET\",\n \"SRV-IPTV\"\n ]\n },\n \"vlans\": [\n 100,\n 200,\n 4000\n ]\n}"},{"id":"e1195b30-1237-4951-adec-d889649d6a83","name":"OLT under quarantine","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/ftth/olt/12/profiles_vlans"},"status":"Locked","code":423,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": false,\n \"error\": \"Olt OLT-CENTRO-01 is under quarantine due to persistent connection failures and is temporarily unavailable for this operation\"\n}"},{"id":"a5e50804-22ac-4e9b-8c00-ad137ab8ed84","name":"OLT not found / not allowed","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/ftth/olt/999/profiles_vlans"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": false,\n \"error\": \"Olt not found\"\n}"},{"id":"91936b20-9658-4123-8627-658f2150f5d1","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/ftth/olt/12/profiles_vlans"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"Authentication credentials were not provided.\"\n}"}],"_postman_id":"665823fd-2f45-493b-a683-d273b48262c5"},{"name":"List OLT Scripts","id":"d6be5c87-7d4e-45f0-9986-2c24ccad34ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/ftth/olt/{{olt_id}}/list_scripts","description":"Returns the scripts that can be applied to the OLT identified by the olt_id path parameter. Each result has id, name and description; use the id with Apply OLT Script.
Returns 403 when the OLT is not found/visible, and 400 on an internal processing error.
\n","urlObject":{"path":["api","v2","ftth","olt","{{olt_id}}","list_scripts"],"host":["https://your-instance.olt.com"],"query":[],"variable":[{"id":"7606d7f4-4d36-4208-a0f5-89bef70184b1","description":{"content":"OLT id. Must be visible to the authenticated user.
\n","type":"text/plain"},"type":"any","value":"12","key":"olt_id"}]}},"response":[{"id":"194c2844-f5aa-4521-b305-1e37e7da6074","name":"List OLT Scripts","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/ftth/olt/12/list_scripts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": true,\n \"total\": 2,\n \"results\": [\n {\n \"id\": 12,\n \"name\": \"Criar VLAN de servico\",\n \"description\": \"Cria uma VLAN de servico na OLT\"\n },\n {\n \"id\": 19,\n \"name\": \"Configurar uplink\",\n \"description\": \"Configura a porta de uplink da OLT\"\n }\n ]\n}"},{"id":"0806864f-be49-4d56-85aa-08947d53c769","name":"OLT not found / not allowed","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/ftth/olt/999/list_scripts"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": false,\n \"error\": \"Olt not found\"\n}"},{"id":"e441befd-c608-4e29-853b-98a2dc49b2be","name":"Unauthorized","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/ftth/olt/12/list_scripts"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"Authentication credentials were not provided.\"\n}"}],"_postman_id":"d6be5c87-7d4e-45f0-9986-2c24ccad34ef"},{"name":"Get OLT Script Fields","id":"2f6c9808-e64f-41ca-8b50-28ea0eb532e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/ftth/olt/{{olt_id}}/{{script_id}}/script","description":"Returns the input fields required to apply script script_id to OLT olt_id. Use these to build the Apply OLT Script body.
Each field has:
\nfield - the human label.name - the field key to send in the Apply body.type - text or select.value - for text fields, a pre-filled value when available.options - for select fields, a list of {name, value, default} built from the OLT profiles/VLANs (VLANs, line/service/traffic profiles, slot/pon, COS, etc.).Hidden fields are resolved server-side and not returned. The OLT must not be under quarantine (423). Returns 403 when the OLT is not found/visible, and 400 when the script is not applicable to this OLT.
\n","urlObject":{"path":["api","v2","ftth","olt","{{olt_id}}","{{script_id}}","script"],"host":["https://your-instance.olt.com"],"query":[],"variable":[{"id":"d756d75e-35fc-4de2-8cc5-afe0cc552ceb","description":{"content":"OLT id. Must be visible to the authenticated user.
\n","type":"text/plain"},"type":"any","value":"12","key":"olt_id"},{"id":"a26722e6-063c-4646-bb38-9c15b8567a42","description":{"content":"Script id (from List OLT Scripts).
\n","type":"text/plain"},"type":"any","value":"12","key":"script_id"}]}},"response":[{"id":"1cb06736-f8ea-4e72-929b-db703f21ecba","name":"Get OLT Script Fields","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/ftth/olt/12/12/script"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": true,\n \"results\": [\n {\n \"field\": \"Vlan\",\n \"name\": \"vlan\",\n \"type\": \"text\",\n \"value\": null\n },\n {\n \"field\": \"SRV Profile\",\n \"name\": \"hw_srv_profile\",\n \"type\": \"select\",\n \"options\": [\n {\n \"name\": \"SRV-INTERNET\",\n \"value\": \"SRV-INTERNET\",\n \"default\": false\n },\n {\n \"name\": \"SRV-IPTV\",\n \"value\": \"SRV-IPTV\",\n \"default\": false\n }\n ]\n }\n ]\n}"},{"id":"8a722e63-0eee-425b-8183-0b02858602e3","name":"Script not applicable","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/ftth/olt/12/999/script"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": false,\n \"error\": \"Script cannot be applied to this olt\"\n}"}],"_postman_id":"2f6c9808-e64f-41ca-8b50-28ea0eb532e9"},{"name":"Apply OLT Script","id":"d5311918-96ec-4a94-95d4-4b1c93a185e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"vlan\": 100,\n \"hw_srv_profile\": \"SRV-INTERNET\"\n}","options":{"raw":{"language":"json"}}},"url":"https://your-instance.olt.com/api/v2/ftth/olt/{{olt_id}}/{{script_id}}/script","description":"Applies script script_id to OLT olt_id.
The body is a flat object keyed by each field's name from Get OLT Script Fields, with the chosen value. Every non-hidden field is required: a missing or empty field returns 400 with Field <name> is required.
Returns {return, message} - 200 with the OLT result message on success, 400 with the failure reason otherwise (missing field, script not applicable, OLT quarantine, or OLT execution error).
OLT id. Must be visible to the authenticated user.
\n","type":"text/plain"},"type":"any","value":"12","key":"olt_id"},{"id":"83bb9d86-6a34-4b3f-b332-9f76a2f62937","description":{"content":"Script id (from List OLT Scripts).
\n","type":"text/plain"},"type":"any","value":"12","key":"script_id"}]}},"response":[{"id":"7b45b8b2-11c4-482c-a699-a2957f9b9916","name":"Script applied","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"vlan\": 100,\n \"hw_srv_profile\": \"SRV-INTERNET\"\n}","options":{"raw":{"language":"json"}}},"url":"https://your-instance.olt.com/api/v2/ftth/olt/12/12/script"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": true,\n \"message\": \"Script applied successfully\"\n}"},{"id":"eda9015c-d24c-405f-8b39-8729a1ab10f7","name":"Required field missing","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"hw_srv_profile\": \"SRV-INTERNET\"\n}","options":{"raw":{"language":"json"}}},"url":"https://your-instance.olt.com/api/v2/ftth/olt/12/12/script"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": false,\n \"error\": \"Field vlan is required\"\n}"},{"id":"d2004b55-79d3-4627-901f-e57058d73705","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"vlan\": 100,\n \"hw_srv_profile\": \"SRV-INTERNET\"\n}","options":{"raw":{"language":"json"}}},"url":"https://your-instance.olt.com/api/v2/ftth/olt/12/12/script"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"Authentication credentials were not provided.\"\n}"}],"_postman_id":"d5311918-96ec-4a94-95d4-4b1c93a185e1"}],"id":"ec121a6a-284b-42b3-bb17-82bb992f40df","_postman_id":"ec121a6a-284b-42b3-bb17-82bb992f40df","description":""},{"name":"GET Equipment","id":"9eb6c817-6724-4f26-a1ff-1315d3c8e580","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/ftth/equipment/{id}","description":"\n\n","urlObject":{"path":["api","v2","ftth","equipment","{id}"],"host":["https://your-instance.olt.com"],"query":[],"variable":[]}},"response":[{"id":"615d5667-47ef-4920-85e1-1206c7dc5c6c","name":"GET Equipment","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/ftth/equipment/{id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 07 Oct 2024 15:21:18 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"326"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": true,\n \"equipment\": {\n \"id\": 3,\n \"serial_number\": \"ZTEGCEC5FC50\",\n \"status\": \"Online\",\n \"last_status_update\": \"2025-07-12T13:43:54.001648\",\n \"last_disconnection\": \"2025-07-12T13:35:05\",\n \"uptime_since\": \"2025-07-12T13:36:13\",\n \"model\": \"F601\",\n \"device_alias\": \"RAQUEL TIAGO FONTES\",\n \"distance\": 1248.0,\n \"device_rx\": -19.542,\n \"olt_rx\": -22.986,\n \"client_id\": 51816,\n \"client_pppoe\": \"76256@provedor.com.br\",\n \"external_client_id\": \"30765\",\n \"external_client_contract_id\": \"78411\",\n \"olt\": \"OLT-PNU-ZTE-PAICANDU-01\",\n \"olt_id\": 14,\n \"olt_external_id\": \"\",\n \"slot\": 1,\n \"slot_id\": 1,\n \"pon\": 3,\n \"pon_id\": 3,\n \"onu_id\": 1,\n \"slot/pon/onu_id\": \"1/3/1\",\n \"bandwith_profile\": null,\n \"version\": \"F601V7.0\",\n \"firmware\": \"V7.0\",\n \"optical_module_intermittency\": false,\n \"optical_module_last_alarm\": \"Sem Energia\",\n \"optical_module_uptime\": \"4 days, 19:26:25.319867\",\n \"optical_module_temperature\": 49.234,\n \"optical_module_volt\": 3.26,\n \"optical_module_current\": 11.8,\n \"optical_module_distance\": 1248,\n \"tags\": []\n }\n}"}],"_postman_id":"9eb6c817-6724-4f26-a1ff-1315d3c8e580"},{"name":"LIST Equipments","id":"0abad50b-67a8-4040-b87e-5438278a5b6f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/ftth/equipment/list","urlObject":{"path":["api","v2","ftth","equipment","list"],"host":["https://your-instance.olt.com"],"query":[{"disabled":true,"key":"id","value":""},{"disabled":true,"key":"serial_number","value":""},{"disabled":true,"key":"status","value":""},{"disabled":true,"key":"model","value":""},{"disabled":true,"key":"device_rx","value":""},{"disabled":true,"key":"device_tx","value":""},{"disabled":true,"key":"device_alias","value":""},{"disabled":true,"key":"last_status_update","value":"2024-10-10T10:00:00"},{"disabled":true,"key":"last_disconnection","value":""},{"disabled":true,"key":"uptime_since","value":""},{"disabled":true,"key":"client_id","value":""},{"disabled":true,"key":"client_pppoe","value":""},{"disabled":true,"key":"olt","value":""},{"disabled":true,"key":"olt_id","value":""},{"disabled":true,"key":"slot","value":""},{"disabled":true,"key":"pon","value":""},{"disabled":true,"key":"olt_external_id","value":""},{"disabled":true,"key":"slot_id","value":""},{"disabled":true,"key":"pon_id","value":""},{"disabled":true,"key":"external_client_id","value":null},{"disabled":true,"key":"external_client_contract_id","value":null}],"variable":[]}},"response":[{"id":"ca9bd3f1-4798-4f6e-82d8-3ec760041a88","name":"LIST Equipments","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":{"raw":"https://your-instance.olt.com/api/v2/ftth/equipment/list","protocol":"https","host":["your-instance","olt","com"],"path":["api","v2","ftth","equipment","list"],"query":[{"key":"id","value":"","disabled":true},{"key":"serial_number","value":null,"disabled":true},{"key":"status","value":null,"disabled":true},{"key":"model","value":null,"disabled":true},{"key":"device_rx","value":null,"disabled":true},{"key":"device_tx","value":null,"disabled":true},{"key":"device_alias","value":null,"disabled":true},{"key":"last_status_update","value":null,"disabled":true},{"key":"last_disconnection","value":null,"disabled":true},{"key":"uptime_since","value":null,"disabled":true},{"key":"client_id","value":null,"disabled":true},{"key":"client_pppoe","value":null,"disabled":true},{"key":"olt","value":null,"disabled":true},{"key":"olt_id","value":null,"disabled":true},{"key":"slot","value":null,"disabled":true},{"key":"pon","value":null,"disabled":true},{"key":"olt_external_id","value":null,"disabled":true},{"key":"slot_id","value":null,"disabled":true},{"key":"pon_id","value":null,"disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 07 Oct 2024 15:25:09 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"364"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": true,\n \"count\": 754,\n \"next\": \"http://yout-instance.olt.com/api/v2/ftth/equipment/list?client_id=&client_pppoe=&device_alias=&device_rx=&device_tx=&id=&last_disconnection=&last_status_update=&model=&olt=&olt_external_id=&olt_id=&page=2&pon=&pon_id=&serial_number=&slot=&slot_id=&status=&uptime_since=\",\n \"previous\": null,\n \"results\": [\n {\n \"id\": 7518,\n \"serial_number\": \"HWTC907dccac\",\n \"status\": \"Online\",\n \"model\": \"EG8145X6-10\",\n \"device_rx\": -15.46,\n \"device_alias\": \"joao.silva1\",\n \"last_status_update\": \"2024-10-07T12:22:41.560191\",\n \"last_disconnection\": \"2024-10-07T12:22:41.560191\",\n \"uptime_since\": \"2024-10-07T12:22:41.560191\",\n \"client_id\": 3,\n \"client_pppoe\": \"joao.silva1\",\n \"external_client_id\": null,\n \"external_client_contract_id\": null,\n \"olt\": \"OLT_ITP01\",\n \"olt_id\": 1,\n \"slot\": 1,\n \"slot_id\": 2,\n \"pon\": 13,\n \"pon_id\": 30,\n \"tags\": []\n }\n ]\n}"}],"_postman_id":"0abad50b-67a8-4040-b87e-5438278a5b6f"},{"name":"GET OLT","id":"fd1b47cf-06ef-4d7e-aa98-3c0ee10e9982","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://your-instance.olt.com/api/v2/ftth/olts/The ID can be obtained from the endpoint FTTH > List Equipments listed in this section of the documentation.
\n
This section documents the response body returned by the GET OLT endpoint. Use it to understand the structure, types, and semantics of each field.
{\n \"return\": true,\n \"data\": { /* OLT object */ }\n}\n\nreturn (boolean): Indicates whether the request was successful.
data (object): The OLT resource with inventory, status, access control, slots, and PONs.
data (OLT object)AclItemSlotRepresents a line card/slot and its PON ports.
\nPonPer-port monitoring, thresholds, capacity, and SFP inventory.
\n\n\n
Notes
\nRX values are typically negative (dBm).
\nAggregates are computed per PON based on the latest monitoring sample.
\nThis endpoint returns detailed information about a PON port of a specific OLT, including:
\nPON Identification and Configuration:
\nID, slot/pon number, enable status, maximum supported ONUs, number of connected ONUs.
\nOptical module hardware details (serial, class, vendor, and product number).
\nMonitoring Metrics:
\nTemperature, voltage, bias current, transmit (TX) and receive (RX) power, as well as optical error margins (MIR, MAR, MER, DFR).
\nConfigured warning/critical thresholds for RX.
\nDate/time of the last monitoring update.
\nConnected Equipment (ONUs):
\nList of ONUs associated with the PON, including:
\nIdentification (internal ID, serial, model, alias).
\nOperational status (Online, Inactive), uptime, last connection/disconnection.
\nOptical data (ONU RX/TX and OLT RX).
\nLinked customer information (ID, PPPoE, contract, VLANs).
\nTopology location (slot/pon/onu_id).
\nTraffic Statistics:
\nThis endpoint returns a list of all PONs registered in the system, allowing filters and specific searches. The response includes essential information for each PON, such as identifiers, OLT name, enable status, maximum supported ONUs, current ONU count, last monitoring update, and optical module details (serial, class, vendor, and product number). This resource is mainly used to simplify the management and consultation of PON ports across the system, providing flexibility for locating and analyzing network resources.
\n","urlObject":{"path":["api","v2","ftth","pons"],"host":["https://your-instance.olt.com"],"query":[{"disabled":true,"key":"slot_pon","value":null},{"disabled":true,"key":"olt_id","value":null},{"disabled":true,"key":"slot_id","value":null},{"disabled":true,"key":"id","value":null},{"disabled":true,"key":"olt_name","value":null},{"disabled":true,"key":"max_amount_onu","value":null},{"disabled":true,"key":"onu_count","value":null},{"disabled":true,"key":"pon","value":null},{"disabled":true,"key":"slot","value":null}],"variable":[]}},"response":[{"id":"5daac27b-564a-40a9-8969-cf2a46bf64b8","name":"LIST PONs","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://your-instance.olt.com/api/v2/ftth/pons?olt_id=123&slot=1","host":["https://your-instance.olt.com"],"path":["api","v2","ftth","pons"],"query":[{"key":"olt_id","value":"123"},{"key":"slot","value":"1"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"return\": true,\n \"count\": 16,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": 18433,\n \"pon\": 0,\n \"slot_pon\": \"1/0\",\n \"description\": \"\",\n \"enable\": 1,\n \"onu_count\": 14,\n \"temperature\": 37,\n \"voltage\": 3.29,\n \"bias_current\": 5,\n \"tx\": 5.55,\n \"miro\": -33.97,\n \"maro\": -17.16,\n \"mero\": -21.04,\n \"dfro\": 16.81,\n \"mirp\": -25.58,\n \"marp\": -19.33,\n \"merp\": -22.08,\n \"dfrp\": 6.25,\n \"rx_pon_onu_warning\": 0,\n \"rx_pon_onu_critical\": 0,\n \"rx_pon_olt_warning\": 0,\n \"rx_pon_olt_critical\": 0,\n \"last_monitoring_update\": \"2025-09-08 23:59:40\",\n \"min_rx_activate\": 0,\n \"max_amount_onu\": 64,\n \"sfp_serial\": \"V5VC4002782 \",\n \"sfp_class\": \"C+\",\n \"sfp_vendor\": \"Hisense \",\n \"sfp_product_number\": \"LTE3680P-BC+ \",\n \"olt_name\": \"olt3-mva-se\",\n \"olt_id\": 123,\n \"slot\": 1,\n \"slot_id\": 1213\n },\n {\n \"id\": 18434,\n \"pon\": 1,\n \"slot_pon\": \"1/1\",\n \"description\": \"\",\n \"enable\": 1,\n \"onu_count\": 12,\n \"temperature\": 40,\n \"voltage\": 3.29,\n \"bias_current\": 6,\n \"tx\": 5.47,\n \"miro\": -24.95,\n \"maro\": -17.21,\n \"mero\": -19.7,\n \"dfro\": 7.74,\n \"mirp\": -23.61,\n \"marp\": -19.79,\n \"merp\": -21.63,\n \"dfrp\": 3.82,\n \"rx_pon_onu_warning\": 0,\n \"rx_pon_onu_critical\": 0,\n \"rx_pon_olt_warning\": 0,\n \"rx_pon_olt_critical\": 0,\n \"last_monitoring_update\": \"2025-09-08 23:59:41\",\n \"min_rx_activate\": 0,\n \"max_amount_onu\": 64,\n \"sfp_serial\": \"V5VC4001231 \",\n \"sfp_class\": \"C+\",\n \"sfp_vendor\": \"Hisense \",\n \"sfp_product_number\": \"LTE3680P-BC+ \",\n \"olt_name\": \"olt3-mva-se\",\n \"olt_id\": 123,\n \"slot\": 1,\n \"slot_id\": 1213\n },\n {\n \"id\": 18435,\n \"pon\": 2,\n \"slot_pon\": \"1/2\",\n \"description\": \"\",\n \"enable\": 1,\n \"onu_count\": 8,\n \"temperature\": 38,\n \"voltage\": 3.3,\n \"bias_current\": 5,\n \"tx\": 5.5,\n \"miro\": -26.19,\n \"maro\": -18.24,\n \"mero\": -21.22,\n \"dfro\": 7.95,\n \"mirp\": -27.82,\n \"marp\": -20.9,\n \"merp\": -22.92,\n \"dfrp\": 6.92,\n \"rx_pon_onu_warning\": 0,\n \"rx_pon_onu_critical\": 0,\n \"rx_pon_olt_warning\": 0,\n \"rx_pon_olt_critical\": 0,\n \"last_monitoring_update\": \"2025-09-08 23:59:41\",\n \"min_rx_activate\": 0,\n \"max_amount_onu\": 64,\n \"sfp_serial\": \"V5VC4003328 \",\n \"sfp_class\": \"C+\",\n \"sfp_vendor\": \"Hisense \",\n \"sfp_product_number\": \"LTE3680P-BC+ \",\n \"olt_name\": \"olt3-mva-se\",\n \"olt_id\": 123,\n \"slot\": 1,\n \"slot_id\": 1213\n },\n {\n \"id\": 18436,\n \"pon\": 3,\n \"slot_pon\": \"1/3\",\n \"description\": \"\",\n \"enable\": 1,\n \"onu_count\": 0,\n \"temperature\": 37,\n \"voltage\": 3.28,\n \"bias_current\": 6,\n \"tx\": 5.56,\n \"miro\": 0,\n \"maro\": 0,\n \"mero\": 0,\n \"dfro\": 0,\n \"mirp\": 0,\n \"marp\": 0,\n \"merp\": 0,\n \"dfrp\": 0,\n \"rx_pon_onu_warning\": 0,\n \"rx_pon_onu_critical\": 0,\n \"rx_pon_olt_warning\": 0,\n \"rx_pon_olt_critical\": 0,\n \"last_monitoring_update\": \"2025-09-08 23:59:42\",\n \"min_rx_activate\": 0,\n \"max_amount_onu\": 128,\n \"sfp_serial\": \"V5VC4003202 \",\n \"sfp_class\": \"C+\",\n \"sfp_vendor\": \"Hisense \",\n \"sfp_product_number\": \"LTE3680P-BC+ \",\n \"olt_name\": \"olt3-mva-se\",\n \"olt_id\": 123,\n \"slot\": 1,\n \"slot_id\": 1213\n },\n {\n \"id\": 18437,\n \"pon\": 4,\n \"slot_pon\": \"1/4\",\n \"description\": \"\",\n \"enable\": 1,\n \"onu_count\": 0,\n \"temperature\": 39,\n \"voltage\": 3.29,\n \"bias_current\": 5,\n \"tx\": 5.54,\n \"miro\": 0,\n \"maro\": 0,\n \"mero\": 0,\n \"dfro\": 0,\n \"mirp\": 0,\n \"marp\": 0,\n \"merp\": 0,\n \"dfrp\": 0,\n \"rx_pon_onu_warning\": 0,\n \"rx_pon_onu_critical\": 0,\n \"rx_pon_olt_warning\": 0,\n \"rx_pon_olt_critical\": 0,\n \"last_monitoring_update\": \"2025-09-08 23:59:42\",\n \"min_rx_activate\": 0,\n \"max_amount_onu\": 128,\n \"sfp_serial\": \"V5VC4002801 \",\n \"sfp_class\": \"C+\",\n \"sfp_vendor\": \"Hisense \",\n \"sfp_product_number\": \"LTE3680P-BC+ \",\n \"olt_name\": \"olt3-mva-se\",\n \"olt_id\": 123,\n \"slot\": 1,\n \"slot_id\": 1213\n },\n {\n \"id\": 18438,\n \"pon\": 5,\n \"slot_pon\": \"1/5\",\n \"description\": \"\",\n \"enable\": 1,\n \"onu_count\": 0,\n \"temperature\": 40,\n \"voltage\": 3.28,\n \"bias_current\": 5,\n \"tx\": 5.47,\n \"miro\": 0,\n \"maro\": 0,\n \"mero\": 0,\n \"dfro\": 0,\n \"mirp\": 0,\n \"marp\": 0,\n \"merp\": 0,\n \"dfrp\": 0,\n \"rx_pon_onu_warning\": 0,\n \"rx_pon_onu_critical\": 0,\n \"rx_pon_olt_warning\": 0,\n \"rx_pon_olt_critical\": 0,\n \"last_monitoring_update\": \"2025-09-08 23:59:43\",\n \"min_rx_activate\": 0,\n \"max_amount_onu\": 128,\n \"sfp_serial\": \"V5VC4000532 \",\n \"sfp_class\": \"C+\",\n \"sfp_vendor\": \"Hisense \",\n \"sfp_product_number\": \"LTE3680P-BC+ \",\n \"olt_name\": \"olt3-mva-se\",\n \"olt_id\": 123,\n \"slot\": 1,\n \"slot_id\": 1213\n },\n {\n \"id\": 18439,\n \"pon\": 6,\n \"slot_pon\": \"1/6\",\n \"description\": \"\",\n \"enable\": 1,\n \"onu_count\": 0,\n \"temperature\": 39,\n \"voltage\": 3.28,\n \"bias_current\": 5,\n \"tx\": 5.5,\n \"miro\": 0,\n \"maro\": 0,\n \"mero\": 0,\n \"dfro\": 0,\n \"mirp\": 0,\n \"marp\": 0,\n \"merp\": 0,\n \"dfrp\": 0,\n \"rx_pon_onu_warning\": 0,\n \"rx_pon_onu_critical\": 0,\n \"rx_pon_olt_warning\": 0,\n \"rx_pon_olt_critical\": 0,\n \"last_monitoring_update\": \"2025-09-08 23:59:43\",\n \"min_rx_activate\": 0,\n \"max_amount_onu\": 128,\n \"sfp_serial\": \"V5VC4009368 \",\n \"sfp_class\": \"C+\",\n \"sfp_vendor\": \"Hisense \",\n \"sfp_product_number\": \"LTE3680P-BC+ \",\n \"olt_name\": \"olt3-mva-se\",\n \"olt_id\": 123,\n \"slot\": 1,\n \"slot_id\": 1213\n },\n {\n \"id\": 18440,\n \"pon\": 7,\n \"slot_pon\": \"1/7\",\n \"description\": \"\",\n \"enable\": 1,\n \"onu_count\": 0,\n \"temperature\": 40,\n \"voltage\": 3.28,\n \"bias_current\": 6,\n \"tx\": 5.5,\n \"miro\": 0,\n \"maro\": 0,\n \"mero\": 0,\n \"dfro\": 0,\n \"mirp\": 0,\n \"marp\": 0,\n \"merp\": 0,\n \"dfrp\": 0,\n \"rx_pon_onu_warning\": 0,\n \"rx_pon_onu_critical\": 0,\n \"rx_pon_olt_warning\": 0,\n \"rx_pon_olt_critical\": 0,\n \"last_monitoring_update\": \"2025-09-08 23:59:44\",\n \"min_rx_activate\": 0,\n \"max_amount_onu\": 128,\n \"sfp_serial\": \"V5VC4011963 \",\n \"sfp_class\": \"C+\",\n \"sfp_vendor\": \"Hisense \",\n \"sfp_product_number\": \"LTE3680P-BC+ \",\n \"olt_name\": \"olt3-mva-se\",\n \"olt_id\": 123,\n \"slot\": 1,\n \"slot_id\": 1213\n },\n {\n \"id\": 18441,\n \"pon\": 8,\n \"slot_pon\": \"1/8\",\n \"description\": \"\",\n \"enable\": 1,\n \"onu_count\": 0,\n \"temperature\": 40,\n \"voltage\": 3.28,\n \"bias_current\": 5,\n \"tx\": 5.53,\n \"miro\": 0,\n \"maro\": 0,\n \"mero\": 0,\n \"dfro\": 0,\n \"mirp\": 0,\n \"marp\": 0,\n \"merp\": 0,\n \"dfrp\": 0,\n \"rx_pon_onu_warning\": 0,\n \"rx_pon_onu_critical\": 0,\n \"rx_pon_olt_warning\": 0,\n \"rx_pon_olt_critical\": 0,\n \"last_monitoring_update\": \"2025-09-08 23:59:44\",\n \"min_rx_activate\": 0,\n \"max_amount_onu\": 128,\n \"sfp_serial\": \"V5VC4012086 \",\n \"sfp_class\": \"C+\",\n \"sfp_vendor\": \"Hisense \",\n \"sfp_product_number\": \"LTE3680P-BC+ \",\n \"olt_name\": \"olt3-mva-se\",\n \"olt_id\": 123,\n \"slot\": 1,\n \"slot_id\": 1213\n },\n {\n \"id\": 18442,\n \"pon\": 9,\n \"slot_pon\": \"1/9\",\n \"description\": \"\",\n \"enable\": 1,\n \"onu_count\": 0,\n \"temperature\": 40,\n \"voltage\": 3.27,\n \"bias_current\": 5,\n \"tx\": 5.48,\n \"miro\": 0,\n \"maro\": 0,\n \"mero\": 0,\n \"dfro\": 0,\n \"mirp\": 0,\n \"marp\": 0,\n \"merp\": 0,\n \"dfrp\": 0,\n \"rx_pon_onu_warning\": 0,\n \"rx_pon_onu_critical\": 0,\n \"rx_pon_olt_warning\": 0,\n \"rx_pon_olt_critical\": 0,\n \"last_monitoring_update\": \"2025-09-08 23:59:45\",\n \"min_rx_activate\": 0,\n \"max_amount_onu\": 128,\n \"sfp_serial\": \"V5VC4009841 \",\n \"sfp_class\": \"C+\",\n \"sfp_vendor\": \"Hisense \",\n \"sfp_product_number\": \"LTE3680P-BC+ \",\n \"olt_name\": \"olt3-mva-se\",\n \"olt_id\": 123,\n \"slot\": 1,\n \"slot_id\": 1213\n },\n {\n \"id\": 18443,\n \"pon\": 10,\n \"slot_pon\": \"1/10\",\n \"description\": \"\",\n \"enable\": 1,\n \"onu_count\": 0,\n \"temperature\": 38,\n \"voltage\": 3.28,\n \"bias_current\": 4,\n \"tx\": 5.52,\n \"miro\": 0,\n \"maro\": 0,\n \"mero\": 0,\n \"dfro\": 0,\n \"mirp\": 0,\n \"marp\": 0,\n \"merp\": 0,\n \"dfrp\": 0,\n \"rx_pon_onu_warning\": 0,\n \"rx_pon_onu_critical\": 0,\n \"rx_pon_olt_warning\": 0,\n \"rx_pon_olt_critical\": 0,\n \"last_monitoring_update\": \"2025-09-08 23:59:45\",\n \"min_rx_activate\": 0,\n \"max_amount_onu\": 128,\n \"sfp_serial\": \"V5VC4008180 \",\n \"sfp_class\": \"C+\",\n \"sfp_vendor\": \"Hisense \",\n \"sfp_product_number\": \"LTE3680P-BC+ \",\n \"olt_name\": \"olt3-mva-se\",\n \"olt_id\": 123,\n \"slot\": 1,\n \"slot_id\": 1213\n },\n {\n \"id\": 18444,\n \"pon\": 11,\n \"slot_pon\": \"1/11\",\n \"description\": \"\",\n \"enable\": 1,\n \"onu_count\": 0,\n \"temperature\": 39,\n \"voltage\": 3.28,\n \"bias_current\": 5,\n \"tx\": 5.48,\n \"miro\": 0,\n \"maro\": 0,\n \"mero\": 0,\n \"dfro\": 0,\n \"mirp\": 0,\n \"marp\": 0,\n \"merp\": 0,\n \"dfrp\": 0,\n \"rx_pon_onu_warning\": 0,\n \"rx_pon_onu_critical\": 0,\n \"rx_pon_olt_warning\": 0,\n \"rx_pon_olt_critical\": 0,\n \"last_monitoring_update\": \"2025-09-08 23:59:45\",\n \"min_rx_activate\": 0,\n \"max_amount_onu\": 128,\n \"sfp_serial\": \"V5VC4008820 \",\n \"sfp_class\": \"C+\",\n \"sfp_vendor\": \"Hisense \",\n \"sfp_product_number\": \"LTE3680P-BC+ \",\n \"olt_name\": \"olt3-mva-se\",\n \"olt_id\": 123,\n \"slot\": 1,\n \"slot_id\": 1213\n },\n {\n \"id\": 18445,\n \"pon\": 12,\n \"slot_pon\": \"1/12\",\n \"description\": \"\",\n \"enable\": 1,\n \"onu_count\": 0,\n \"temperature\": 38,\n \"voltage\": 3.28,\n \"bias_current\": 5,\n \"tx\": 5.48,\n \"miro\": 0,\n \"maro\": 0,\n \"mero\": 0,\n \"dfro\": 0,\n \"mirp\": 0,\n \"marp\": 0,\n \"merp\": 0,\n \"dfrp\": 0,\n \"rx_pon_onu_warning\": 0,\n \"rx_pon_onu_critical\": 0,\n \"rx_pon_olt_warning\": 0,\n \"rx_pon_olt_critical\": 0,\n \"last_monitoring_update\": \"2025-09-08 23:59:48\",\n \"min_rx_activate\": 0,\n \"max_amount_onu\": 128,\n \"sfp_serial\": \"V5VC4011940 \",\n \"sfp_class\": \"C+\",\n \"sfp_vendor\": \"Hisense \",\n \"sfp_product_number\": \"LTE3680P-BC+ \",\n \"olt_name\": \"olt3-mva-se\",\n \"olt_id\": 123,\n \"slot\": 1,\n \"slot_id\": 1213\n },\n {\n \"id\": 18446,\n \"pon\": 13,\n \"slot_pon\": \"1/13\",\n \"description\": \"\",\n \"enable\": 1,\n \"onu_count\": 0,\n \"temperature\": 37,\n \"voltage\": 3.26,\n \"bias_current\": 5,\n \"tx\": 5.48,\n \"miro\": 0,\n \"maro\": 0,\n \"mero\": 0,\n \"dfro\": 0,\n \"mirp\": 0,\n \"marp\": 0,\n \"merp\": 0,\n \"dfrp\": 0,\n \"rx_pon_onu_warning\": 0,\n \"rx_pon_onu_critical\": 0,\n \"rx_pon_olt_warning\": 0,\n \"rx_pon_olt_critical\": 0,\n \"last_monitoring_update\": \"2025-09-08 23:59:50\",\n \"min_rx_activate\": 0,\n \"max_amount_onu\": 128,\n \"sfp_serial\": \"V5VC4012087 \",\n \"sfp_class\": \"C+\",\n \"sfp_vendor\": \"Hisense \",\n \"sfp_product_number\": \"LTE3680P-BC+ \",\n \"olt_name\": \"olt3-mva-se\",\n \"olt_id\": 123,\n \"slot\": 1,\n \"slot_id\": 1213\n },\n {\n \"id\": 18447,\n \"pon\": 14,\n \"slot_pon\": \"1/14\",\n \"description\": \"\",\n \"enable\": 1,\n \"onu_count\": 0,\n \"temperature\": 36,\n \"voltage\": 3.28,\n \"bias_current\": 5,\n \"tx\": 5.49,\n \"miro\": 0,\n \"maro\": 0,\n \"mero\": 0,\n \"dfro\": 0,\n \"mirp\": 0,\n \"marp\": 0,\n \"merp\": 0,\n \"dfrp\": 0,\n \"rx_pon_onu_warning\": 0,\n \"rx_pon_onu_critical\": 0,\n \"rx_pon_olt_warning\": 0,\n \"rx_pon_olt_critical\": 0,\n \"last_monitoring_update\": \"2025-09-08 23:59:52\",\n \"min_rx_activate\": 0,\n \"max_amount_onu\": 128,\n \"sfp_serial\": \"V5VC4009922 \",\n \"sfp_class\": \"C+\",\n \"sfp_vendor\": \"Hisense \",\n \"sfp_product_number\": \"LTE3680P-BC+ \",\n \"olt_name\": \"olt3-mva-se\",\n \"olt_id\": 123,\n \"slot\": 1,\n \"slot_id\": 1213\n },\n {\n \"id\": 18448,\n \"pon\": 15,\n \"slot_pon\": \"1/15\",\n \"description\": \"\",\n \"enable\": 1,\n \"onu_count\": 0,\n \"temperature\": 36,\n \"voltage\": 3.28,\n \"bias_current\": 6,\n \"tx\": 5.47,\n \"miro\": 0,\n \"maro\": 0,\n \"mero\": 0,\n \"dfro\": 0,\n \"mirp\": 0,\n \"marp\": 0,\n \"merp\": 0,\n \"dfrp\": 0,\n \"rx_pon_onu_warning\": 0,\n \"rx_pon_onu_critical\": 0,\n \"rx_pon_olt_warning\": 0,\n \"rx_pon_olt_critical\": 0,\n \"last_monitoring_update\": \"2025-09-08 23:59:54\",\n \"min_rx_activate\": 0,\n \"max_amount_onu\": 128,\n \"sfp_serial\": \"V5VC4010999 \",\n \"sfp_class\": \"C+\",\n \"sfp_vendor\": \"Hisense \",\n \"sfp_product_number\": \"LTE3680P-BC+ \",\n \"olt_name\": \"olt3-mva-se\",\n \"olt_id\": 123,\n \"slot\": 1,\n \"slot_id\": 1213\n }\n ]\n}"}],"_postman_id":"3d067d4e-3e87-4bd2-b7bc-2dc16e8ca49e"},{"name":"GET Impact Activity","id":"a7f08aad-04c9-471d-9bfc-53ffa51cd391","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/impact_activity/list","description":"This endpoint lists all scheduled or ongoing impact activities. It can be used in conjunction with the endpoint below, \"GET Impact Activity Clients\" to list all clients affected by an impact activity.
\n","urlObject":{"path":["api","v2","impact_activity","list"],"host":["https://your-instance.olt.com"],"query":[],"variable":[]}},"response":[{"id":"ea6257fa-4e3b-476e-b758-23afae66fd5e","name":"GET Impact Activity","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/impact_activity/list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 07 Oct 2024 15:31:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"173"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": true,\n \"total\": 1,\n \"results\": [\n {\n \"id\": 1,\n \"name\": \"reparo splitter\",\n \"type_of_activity\": \"manutenção splitter\",\n \"type_of_impact\": \"Impacto Parcial\",\n \"scheduled\": false,\n \"status\": \"Atividade Programada\",\n \"finished\": false,\n \"start_date\": \"2024-11-06T17:34:00\",\n \"end_date\": \"2024-11-13T17:34:00\",\n \"observations\": \"teste\",\n \"responsible\": \"Admin\",\n \"filters\": [\n {\n \"filter\": \"PON\",\n \"content\": \"PON: 7 - SLOT: 3 - OLT: 2510\"\n }\n ]\n }\n ]\n}"}],"_postman_id":"a7f08aad-04c9-471d-9bfc-53ffa51cd391"},{"name":"GET Impact Activity Clients","id":"e718c3bf-6f4b-46a8-a514-bce4f71d92d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/impact_activity/{id}/clients","description":"This endpoint lists all clients affected by an impact activity.
\n","urlObject":{"path":["api","v2","impact_activity","{id}","clients"],"host":["https://your-instance.olt.com"],"query":[],"variable":[]}},"response":[{"id":"6ac79df2-bca6-4a96-a4b5-0c5234d0c571","name":"GET Impact Activity Clients","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/impact_activity/{id}/clients"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Mon, 07 Oct 2024 15:31:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"173"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept, origin"},{"key":"Allow","value":"GET, HEAD, OPTIONS"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Cross-Origin-Opener-Policy","value":"same-origin"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": true,\n \"total\": 3,\n \"results\": {\n \"clients\": [\n {\n \"id\": 1074,\n \"client_name\": \"Diego\",\n \"client_pppoe\": \"diego\",\n \"sn_onu\": \"ITBSF33FB478\",\n \"contact\": \"(41) 99999-9999\",\n \"address\": \"R. Brasil, 212 - Curitiba - Paraná\",\n \"onu_vip\": false\n }\n ],\n \"onus\": [\n {\n \"id\": 1073,\n \"alias\": \"joao.silva\",\n \"sn_onu\": \"ITBSF13FB396\",\n \"client_id\": 14785,\n \"client_name\": \"JOAO SILVA\",\n \"client_pppoe\": \"joao.silva\",\n \"onu_vip\": true\n },\n {\n \"id\": 1076,\n \"alias\": \"joao.silva\",\n \"sn_onu\": \"ITBS3272338F\",\n \"client_id\": 24089,\n \"client_name\": \"ANA SILVA\",\n \"client_pppoe\": \"ana.silva\",\n \"onu_vip\": false\n }\n ]\n }\n}"}],"_postman_id":"e718c3bf-6f4b-46a8-a514-bce4f71d92d5"},{"name":"Check ONU state (Enable/Disable)","id":"d3fccc88-8327-4767-b1e8-b5972c266eea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/ftth/equipment/check_disable/{id}","description":"This endpoint is designed to check whether the ONU is enabled or disabled directly on the OLT
\n(functionality available only for Huawei and ZTE OLTs)
\n\n\n","urlObject":{"path":["api","v2","ftth","equipment","check_disable","{id}"],"host":["https://your-instance.olt.com"],"query":[],"variable":[]}},"response":[{"id":"b66310d0-1b8f-4afb-a000-542738e554f0","name":"Check ONU Status","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/ftth/equipment/check_disable/{id}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": true,\n \"disable\": true\n}"}],"_postman_id":"d3fccc88-8327-4767-b1e8-b5972c266eea"},{"name":"Enable/Disable ONU","id":"bb0bf184-340f-48c8-97cf-75b2e496479e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/ftth/equipment/toogle_disable/{id}/{onu_status}","description":"The ID can be obtained from the endpoint FTTH > List Equipments listed in this section of the documentation.
\n
This endpoint is used to change the ONU status on the OLT by enabling or disabling the ONU. To disable the ONU, send the value \"disable\" in the \"onu_status\" parameter, and to enable the ONU, send the value \"enable\".
(Functionality available only for Huawei and ZTE OLTs)
\n\n","urlObject":{"path":["api","v2","ftth","equipment","toogle_disable","{id}","{onu_status}"],"host":["https://your-instance.olt.com"],"query":[],"variable":[]}},"response":[{"id":"262fed0e-99c5-43d8-ae0f-40a474e7ab94","name":"Enable/Disable ONU","originalRequest":{"method":"POST","header":[],"url":"https://your-instance.olt.com/api/v2/ftth/equipment/toogle_disable/{id}/{onu_status}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": true,\n \"message\": \"ONU Successfully Disabled!\"\n}"}],"_postman_id":"bb0bf184-340f-48c8-97cf-75b2e496479e"},{"name":"Enable/Disable ONU CATV","id":"2bb73f08-44e4-4a98-86e9-e0e0bd7fc9bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"body":{"mode":"raw","raw":"{\n \"enable\": \"true\"\n}","options":{"raw":{"language":"json"}}},"url":"https://your-instance.olt.com/api/v2/ftth/equipment/{id}/catv/toogle","description":"The ID can be obtained from the endpoint FTTH > List Equipments listed in this section of the documentation.
\n
This endpoint is used to change the ONU port CATV status on the OLT by enabling or disabling the ONU CATV port.
(Functionality available only for Huawei OLTs)
\n\n","urlObject":{"path":["api","v2","ftth","equipment","{id}","catv","toogle"],"host":["https://your-instance.olt.com"],"query":[],"variable":[]}},"response":[{"id":"57ed2867-3284-4dcc-9bdf-c3856c8224ee","name":"Enable/Disable ONU CATV","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"port\": \"1\",\n \"enable\": \"true\"\n}","options":{"raw":{"language":"json"}}},"url":"https://your-instance.olt.com/api/v2/ftth/equipment/{id}/catv/toogle"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": true,\n \"message\": \"Operation carried out successfully\"\n}"}],"_postman_id":"2bb73f08-44e4-4a98-86e9-e0e0bd7fc9bf"},{"name":"Reboot ONU","id":"3af922e9-1cc6-49fe-a368-aa2c6427c735","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://your-instance.olt.com/api/v2/ftth/equipment/restart/{id_onu}","description":"The ID can be obtained from the endpoint FTTH > List Equipments listed in this section of the documentation.
\n
This endpoint is used to reboot the ONU .
\n\n\n","urlObject":{"path":["api","v2","ftth","equipment","restart","{id_onu}"],"host":["https://your-instance.olt.com"],"query":[],"variable":[]}},"response":[{"id":"5b03dea5-292c-42ce-b531-252e7e9cad1f","name":"200","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://your-instance.olt.com/api/v2/ftth/equipment/restart/{id_onu}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": true,\n \"message\": \"Command successfully sent!\"\n}"}],"_postman_id":"3af922e9-1cc6-49fe-a368-aa2c6427c735"},{"name":"LIST OLT Profiles and VLANs","id":"99936e6e-36f9-4822-aef2-78ef89279626","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://your-instance.olt.com/api/v2/ftth/olt/The ID can be obtained from the endpoint FTTH > List Equipments listed in this section of the documentation.
\n
List the existing VLANs and profiles on the OLT.
\nThe content of the \"profiles\" field may change its structure depending on the OLT manufacturer.
\n\n\nEndpoint available from version 1.9.3.82 onwards.
\n
\n\n","urlObject":{"path":["api","v2","ftth","olt","The value to be sent in the \"olt_id\" field can be obtained through the \"LIST OLTs\" endpoint.
\n
This endpoint returns the real-time status of ONUs connected to a specific PON port on an OLT.
\n","urlObject":{"path":["api","v2","ftth","equipment","realtime"],"host":["https://your-instance.olt.com"],"query":[{"key":"olt_id","value":"Triggers an on-demand, real-time poll of the SFP diagnostics for the specified PON port on the OLT and returns refreshed values. Useful for troubleshooting optical power, temperature, and transceiver health.
\n","urlObject":{"path":["api","v2","ftth","pons","pon_id (integer) — Target PON ID.Starts an asynchronous collection of RX signal levels for all ONUs on a specific PON. The request returns immediately confirming the job was triggered. When it finishes, the system sends a POST to the provided callback URL with the collection result.
\ncallback_url)Headers: Content-Type: application/json
Body (example):
\n{\n \"status\": true,\n \"message\": \"PON signal levels updated successfully\",\n \"olt\": \"OlT_ZTE_EST_CIPO\",\n \"olt_id\": 12,\n \"slot\": 1,\n \"slot_id\": 40,\n \"pon\": 2,\n \"pon_id\": 606\n}\n\nReturns a paginated list of isolated-attenuation records, one per affected ONU. An ONU appears here when its RX power deviates from the average of the other ONUs in its CTO and in its PON by more than the configured degradation threshold, while its RX values stay within a valid measurement range. This isolates drops with a localized optical problem from shared-infrastructure degradation.
\nResults are restricted to the OLTs the authenticated user is allowed to see (per-OLT ACL). Ordering is by internal record id.
\nAll fields below can be used as query filters. Text fields use a partial (case-insensitive) match by default. Id fields (olt_id, cto_id) use an exact match. Numeric RX fields (rx_onu, rx_olt, cto_avg_rx_onu, cto_avg_rx_olt, pon_avg_rx_onu, pon_avg_rx_olt) can be combined with the oper parameter (=, >, >=, <, <=) for range queries. The oper value applies to every filter in the same request. Sending a field that is not in the list returns 400 with the list of unavailable fields.
Each result object contains:
\nolt_id - OLT numeric id.olt_name - OLT name.client_name - full name of the client linked to the ONU.description - client login/PPPoE.cto_id - CTO numeric id.cto_name - CTO name.sn_onu - ONU serial number.rx_onu - RX optical power at the ONU (dBm).rx_olt - RX optical power at the OLT for this ONU (dBm).cto_avg_rx_onu - average ONU-side RX across the ONUs in the same CTO (dBm).cto_avg_rx_olt - average OLT-side RX across the ONUs in the same CTO (dBm).pon_avg_rx_onu - average ONU-side RX across the ONUs in the same PON (dBm).pon_avg_rx_olt - average OLT-side RX across the ONUs in the same PON (dBm).signal_reference - reference the isolated attenuation is measured against: CTO when the deviation from the CTO average crosses the threshold, otherwise PON.external_contract_id - external ERP contract id of the linked client, or null.slot/pon/onu_id - ONU position as slot/pon/onu_id (filter by it using the s_p_o query parameter).Returns a paginated list of per-PON attenuation summaries. Each record aggregates the RX signal of the ONUs on one GPON PON: the average RX on the ONU side and on the OLT side, and the number and percentage of ONUs that crossed the warning or critical thresholds on each side.
\nResults are restricted to the OLTs the authenticated user is allowed to see (per-OLT ACL). Ordering is by internal record id.
\nAll fields below can be used as query filters. Text fields use a partial (case-insensitive) match by default. olt_id uses an exact match. Numeric fields (onu_count, avg_rx_onu, avg_rx_pon, the warning/critical counts and percents) can be combined with the oper parameter (=, >, >=, <, <=) for range queries. The oper value applies to every filter in the same request. Sending a field that is not in the list returns 400 with the list of unavailable fields.
Each result object contains:
\nid - PON record id.description - PON description/label.observations - free-text observations saved on the PON.olt_id - OLT numeric id.olt_name - OLT name.onu_count - number of ONUs in the PON.avg_rx_onu - average ONU-side RX (dBm).avg_rx_pon - average OLT-side RX for the PON (dBm).rx_onu_warning_count - ONUs in warning on the ONU-side RX.rx_onu_warning_percent - share (%) of ONUs in warning on the ONU-side RX.rx_onu_critical_count - ONUs in critical on the ONU-side RX.rx_onu_critical_percent - share (%) of ONUs in critical on the ONU-side RX.rx_olt_warning_count - ONUs in warning on the OLT-side RX.rx_olt_warning_percent - share (%) of ONUs in warning on the OLT-side RX.rx_olt_critical_count - ONUs in critical on the OLT-side RX.rx_olt_critical_percent - share (%) of ONUs in critical on the OLT-side RX.slot/pon - PON position as slot/pon (filter by it using the slot_pon query parameter).Returns a paginated list of per-CTO (box) attenuation summaries. Each record aggregates the RX signal of the ONUs served by one CTO: the average RX on the ONU side and on the OLT side, and the number and percentage of ONUs that crossed the warning or critical thresholds on each side.
\nResults are restricted to the OLTs the authenticated user is allowed to see (per-OLT ACL). Ordering is by internal record id.
\nAll fields below can be used as query filters. Text fields use a partial (case-insensitive) match by default. Id fields (olt_id, pon_id) use an exact match. Numeric fields (onu_count, avg_rx_onu, avg_rx_cto, the warning/critical counts and percents) can be combined with the oper parameter (=, >, >=, <, <=) for range queries. The oper value applies to every filter in the same request. Sending a field that is not in the list returns 400 with the list of unavailable fields.
Each result object contains:
\nid - CTO record id.name - CTO name.observations - free-text observations saved on the CTO.olt_id - OLT numeric id.olt_name - OLT name.onu_count - number of ONUs in the CTO.avg_rx_onu - average ONU-side RX (dBm).avg_rx_cto - average OLT-side RX for the CTO (dBm).rx_onu_warning_count - ONUs in warning on the ONU-side RX.rx_onu_warning_percent - share (%) of ONUs in warning on the ONU-side RX.rx_onu_critical_count - ONUs in critical on the ONU-side RX.rx_onu_critical_percent - share (%) of ONUs in critical on the ONU-side RX.rx_olt_warning_count - ONUs in warning on the OLT-side RX.rx_olt_warning_percent - share (%) of ONUs in warning on the OLT-side RX.rx_olt_critical_count - ONUs in critical on the OLT-side RX.rx_olt_critical_percent - share (%) of ONUs in critical on the OLT-side RX.pon_id - parent PON numeric id.slot/pon - parent PON position as slot/pon (filter by it using the slot_pon query parameter).Adds a tag to the equipment.
\nRemoves an existing tag from ONU
\nReturns the status change history of a specific ONU, ordered from most recent to oldest. Enables analysis of outages, instability, and downtime periods.
\nParameters
\n","urlObject":{"path":["api","v2","ftth","equipment","{ID}","status_logs"],"host":["https://your-instance.olt.com"],"query":[],"variable":[]}},"response":[{"id":"23e00ec5-f21d-4557-af45-7f4a85498329","name":"ONU Status History Retrieval","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/ftth/equipment/11801/status_logs"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": true,\n \"results\": [\n {\n \"date\": \"2026-04-14 08:07:41\",\n \"status\": \"Online\"\n },\n {\n \"date\": \"2026-04-13 21:11:56\",\n \"status\": \"Sem Energia\"\n },\n {\n \"date\": \"2026-04-12 18:46:53\",\n \"status\": \"Online\"\n },\n {\n \"date\": \"2026-04-12 18:33:56\",\n \"status\": \"Sem Energia\"\n },\n {\n \"date\": \"2026-04-12 16:41:45\",\n \"status\": \"Online\"\n },\n {\n \"date\": \"2026-04-11 18:56:20\",\n \"status\": \"Sem Energia\"\n },\n {\n \"date\": \"2026-04-11 18:53:11\",\n \"status\": \"Online\"\n },\n {\n \"date\": \"2026-04-10 20:13:51\",\n \"status\": \"Sem Energia\"\n },\n {\n \"date\": \"2026-04-09 06:17:33\",\n \"status\": \"Online\"\n },\n {\n \"date\": \"2026-04-08 19:33:14\",\n \"status\": \"Sem Energia\"\n },\n {\n \"date\": \"2026-04-07 05:54:29\",\n \"status\": \"Online\"\n },\n {\n \"date\": \"2026-04-06 18:56:56\",\n \"status\": \"Sem Energia\"\n },\n {\n \"date\": \"2026-04-05 18:45:51\",\n \"status\": \"Online\"\n },\n {\n \"date\": \"2026-04-05 08:43:05\",\n \"status\": \"Sem Energia\"\n },\n {\n \"date\": \"2026-04-04 20:31:31\",\n \"status\": \"Online\"\n },\n {\n \"date\": \"2026-04-04 19:10:45\",\n \"status\": \"Sem Energia\"\n },\n {\n \"date\": \"2026-04-03 21:15:00\",\n \"status\": \"Online\"\n },\n {\n \"date\": \"2026-04-03 20:49:07\",\n \"status\": \"Sem Energia\"\n },\n {\n \"date\": \"2026-04-03 20:47:34\",\n \"status\": \"Online\"\n },\n {\n \"date\": \"2026-04-03 20:45:59\",\n \"status\": \"Sem Energia\"\n },\n {\n \"date\": \"2026-04-03 20:44:26\",\n \"status\": \"Online\"\n },\n {\n \"date\": \"2026-04-03 08:50:13\",\n \"status\": \"Sem Energia\"\n },\n {\n \"date\": \"2026-04-03 06:50:59\",\n \"status\": \"Online\"\n },\n {\n \"date\": \"2026-04-02 20:20:02\",\n \"status\": \"Sem Energia\"\n },\n {\n \"date\": \"2026-04-02 20:06:01\",\n \"status\": \"Online\"\n },\n {\n \"date\": \"2026-04-02 08:33:15\",\n \"status\": \"Sem Energia\"\n },\n {\n \"date\": \"2026-04-01 22:00:48\",\n \"status\": \"Online\"\n },\n {\n \"date\": \"2026-04-01 20:47:06\",\n \"status\": \"Sem Energia\"\n },\n {\n \"date\": \"2026-04-01 14:30:45\",\n \"status\": \"Online\"\n },\n {\n \"date\": \"2026-03-31 19:22:56\",\n \"status\": \"Sem Energia\"\n },\n {\n \"date\": \"2026-03-31 17:55:43\",\n \"status\": \"Online\"\n }\n ]\n}"}],"_postman_id":"bbcef1ee-4047-4aac-b1dd-d359e7ea6a04"}],"id":"1b234d0d-58b7-43a4-acdf-f2f2fb308b21","_postman_id":"1b234d0d-58b7-43a4-acdf-f2f2fb308b21","description":""},{"name":"ACS","item":[{"name":"Ping","item":[{"name":"Run Ping","id":"fbe38ae1-957b-4fd7-ae95-4fe1031a339c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"host\": \"8.8.8.8\",\n \"data_block_size\": 32,\n \"timeout\": 5000,\n \"number_of_repetitions\": 4,\n \"interface\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://your-instance.olt.com/api/v2/acs/{device_serial_number}/ping","description":"This endpoint starts a TR-069 IP Ping diagnostic on the CPE identified by the serial number in the URL. The operation is asynchronous: the response returns immediately with a ping id and status: \"Waiting\", and the actual ping is executed in background by the platform scheduler.
Any previous ping for the same device still in Waiting or Requested state is automatically cancelled when a new request is accepted. A new request for the same device is rejected with HTTP 429 if sent within 30 seconds after the previous one.
All body fields are optional. When omitted, the following defaults are used:
\nhost: \"8.8.8.8\" — destination address of the ping (IPv4, IPv6 or hostname).data_block_size: 32 — size in bytes of each ICMP packet. Allowed values: 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192.timeout: 5000 — timeout in milliseconds for each individual ping.number_of_repetitions: 4 — number of ICMP echo requests to send.interface: WAN interface to be used as the source of the ping. When omitted the device default is used.This endpoint returns the current state of a single ping diagnostic identified by its numeric id (returned by the Run Ping endpoint). It is intended to be polled by the client after starting a ping, until the status field leaves Waiting/Requested.
Possible values for status:
Waiting: enqueued, waiting for the worker to pick it up.Requested: command sent to the device, waiting for the response.Complete: ping finished successfully. The result fields are populated.Error_CannotResolveHostName: the device could not resolve the destination host.Error_CannotConnectToHost: the device could not reach the destination host.Error_Internal: internal error on the device.Error_Other: generic error or cancellation by a newer ping request.Error: failed to send the ping command to the device.This endpoint returns the paginated history of all pings executed on the device identified by the serial number in the URL, ordered from the most recent to the oldest. The pagination follows the same structure used by the other list endpoints (return, count, next, previous, results).
This endpoint starts a TR-069 Traceroute diagnostic on the CPE identified by the serial number in the URL. The operation is asynchronous: the response returns immediately with a traceroute id and status: \"Waiting\", and the actual traceroute is executed in background by the platform scheduler.
Any previous traceroute for the same device still in Waiting or Requested state is automatically cancelled when a new request is accepted. A new request for the same device is rejected with HTTP 429 if sent within 30 seconds after the previous one.
All body fields are optional. When omitted, the following defaults are used:
\nhost: \"8.8.8.8\" — destination address of the traceroute (IPv4, IPv6 or hostname).maxhops: 30 — maximum number of hops to probe. Allowed range: 1 to 64.This endpoint returns the current state of a single traceroute diagnostic identified by its numeric id (returned by the Run Traceroute endpoint). It is intended to be polled by the client after starting a traceroute, until the status field leaves Waiting/Requested.
The route field is keyed by hop number (1, 2, ...). Each hop contains the fields exposed by the device, typically HopHost, HopHostAddress, HopRTTimes (round trip times) and HopErrorCode.
Possible values for status:
Waiting: enqueued, waiting for the worker to pick it up.Requested: command sent to the device, waiting for the response.Complete: traceroute finished successfully.Error_MaxHopCountExceeded: destination not reached within maxhops.Error_CannotResolveHostName: the device could not resolve the destination host.Error_Internal: internal error on the device.Error_Other: generic error or cancellation by a newer traceroute request.Error: failed to send the traceroute command to the device.This endpoint returns the paginated history of all traceroutes executed on the device identified by the serial number in the URL, ordered from the most recent to the oldest. The pagination follows the same structure used by the other list endpoints (return, count, next, previous, results).
This endpoint starts a TR-069 Neighboring WiFi diagnostic on the CPE identified by the serial number in the URL. The diagnostic scans the surrounding 2.4 GHz and 5 GHz wireless networks visible to the device. The operation is asynchronous: the response returns immediately with a neighboring_wifi.id and status: \"Waiting\", and the actual scan is executed in background by the platform scheduler.
Support for this diagnostic depends on the device vendor and data model. The endpoint validates support before enqueuing the task: devices that do not support the scan are rejected with HTTP 400 and no record is created. Currently supported vendors include all TR-181 devices and the following TR-098 vendors: Huawei, ZTE, ALCL, Datacom and Intelbras.
\nAny previous scan for the same device still in Waiting or Requested state is automatically cancelled when a new request is accepted. A new request for the same device is rejected with HTTP 429 if sent within 30 seconds after the previous one.
This endpoint does not require any body parameters.
\n","urlObject":{"path":["api","v2","acs","{device_serial_number}","neighboring_wifi"],"host":["https://your-instance.olt.com"],"query":[],"variable":[]}},"response":[{"id":"dc780af3-d42a-42e2-a069-4095f93bfc5e","name":"Run Neighboring WiFi","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"https://your-instance.olt.com/api/v2/acs/{device_serial_number}/neighboring_wifi"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": true,\n \"neighboring_wifi\": {\n \"id\": 13,\n \"serial_number\": \"48575443DBA67CB4\",\n \"status\": \"Waiting\",\n \"current_channel_2_4\": null,\n \"current_band_2_4\": null,\n \"current_channel_5\": null,\n \"current_band_5\": null,\n \"channel_recomendation_2_4\": null,\n \"channel_recomendation_5\": null,\n \"networks_2_4\": 0,\n \"networks_5\": 0,\n \"chart_data\": [],\n \"start_time\": null,\n \"end_time\": null\n }\n}"},{"id":"c0d7326d-7a2c-40f3-a11a-5faa6c6390b5","name":"Not supported","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"https://your-instance.olt.com/api/v2/acs/{device_serial_number}/neighboring_wifi"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": false,\n \"error\": \"Neighboring WiFi diagnostic is not supported by this device\"\n}"},{"id":"21368cd5-c1d0-4a01-a2fb-7ce5f9d4e254","name":"Device not found","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"https://your-instance.olt.com/api/v2/acs/{device_serial_number}/neighboring_wifi"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": false,\n \"error\": \"Device not found\"\n}"},{"id":"94fcc558-97ad-4c66-9a31-5d19e01e5dcf","name":"Rate limited","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"https://your-instance.olt.com/api/v2/acs/{device_serial_number}/neighboring_wifi"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": false,\n \"error\": \"Wait 30s between neighboring wifi requests for the same device\"\n}"}],"_postman_id":"8f660b30-738b-44d5-a31e-927573ed3fa3"},{"name":"Get Neighboring WiFi Result","id":"11ce1526-a6a9-4575-8258-45f194add5b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/acs/neighboring_wifi/{neighboring_wifi_id}","description":"This endpoint returns the current state of a single Neighboring WiFi scan identified by its numeric id (returned by the Run Neighboring WiFi endpoint). It is intended to be polled by the client after starting a scan, until the status field leaves Waiting/Requested.
When the scan finishes, the following fields are populated:
\ncurrent_channel_2_4 / current_channel_5: channel currently used by the device on each band.current_band_2_4 / current_band_5: channel bandwidth currently in use on each band.channel_recomendation_2_4 / channel_recomendation_5: recommended channel for each band based on the scan (may be null when the device or vendor implementation does not provide a recommendation).networks_2_4 / networks_5: number of neighbor networks detected on each band.chart_data: per-band detail with the list of detected networks (ssid, bssid, channel, signal_dbm, frequency_band, channel_bandwidth).Possible values for status:
Waiting: enqueued, waiting for the worker to pick it up.Requested: command sent to the device, waiting for the response.Complete: scan finished successfully.Error_NotSupported: device returned the diagnostic but the result could not be processed.Error_Internal: internal error on the device.Error_Other: generic error or cancellation by a newer scan request.Error: failed to send the scan command to the device.This endpoint returns the paginated history of all Neighboring WiFi scans executed on the device identified by the serial number in the URL, ordered from the most recent to the oldest. The pagination follows the same structure used by the other list endpoints (return, count, next, previous, results).
Enqueues a bandwidth (speed) test on the ONU identified by sn.
All body fields are optional:
\ndownload_url / upload_url: measurement URLs. When omitted, fall back to the device configuration and then to the global TR-069 settings (speedtest_url / speedtest_upload_url).interface: WAN interface path used for the test (defaults to the device's active WAN).dscp: DSCP marking, 0–63 (default 0).ethernet_priority: 802.1p priority, 0–7 (default 0).number_of_connections: parallel connections, 1–16 (default 1).upload_test_file_length: upload payload in bytes, 1024–1073741824 (default 10485760).Returns 202 Accepted with the created record in Waiting. Poll Get Bandwidth Test Result with the returned id to follow progress and read download_mbps / upload_mbps.
Returns a single bandwidth test by its id. Use it to poll a running test until status is terminal and to read the measured download_mbps / upload_mbps, transferred bytes and durations.
Lists the bandwidth tests of the ONU identified by sn, most recent first (ordered by start_time descending). Paginated with the standard count/next/previous/results envelope.
Page number (default 1).
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"Items per page (default 100, max 1000).
\n","type":"text/plain"},"key":"page_size","value":"100"}],"variable":[]}},"response":[{"id":"601480fc-84be-4a41-8108-c29087fe5626","name":"200 OK - History page","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ..."}],"url":{"raw":"https://your-instance.olt.com/api/v2/acs/{{sn}}/bandwidth_test/history?page=1&page_size=100","host":["https://your-instance.olt.com"],"path":["api","v2","acs","{{sn}}","bandwidth_test","history"],"query":[{"key":"page","value":"1"},{"key":"page_size","value":"100"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": true,\n \"count\": 2,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": 512,\n \"serial_number\": \"ALCLB0A1C2D3\",\n \"interface\": \"InternetGatewayDevice.WANDevice.1.WANConnectionDevice.1.WANIPConnection.1\",\n \"dscp\": 0,\n \"ethernet_priority\": 0,\n \"number_of_connections\": 1,\n \"status\": \"Complete\",\n \"download_url\": \"http://speedtest.example.com/download\",\n \"download_status\": \"Completed\",\n \"download_bytes\": 118325248,\n \"download_duration_ms\": 5000,\n \"download_mbps\": 189.32,\n \"download_rom_time\": \"2026-07-14T18:20:01.000000Z\",\n \"download_bom_time\": \"2026-07-14T18:20:01.200000Z\",\n \"download_eom_time\": \"2026-07-14T18:20:06.200000Z\",\n \"upload_url\": \"http://speedtest.example.com/upload\",\n \"upload_test_file_length\": 10485760,\n \"upload_status\": \"Completed\",\n \"upload_bytes\": 10485760,\n \"upload_duration_ms\": 4200,\n \"upload_mbps\": 19.97,\n \"upload_rom_time\": \"2026-07-14T18:20:07.000000Z\",\n \"upload_bom_time\": \"2026-07-14T18:20:07.100000Z\",\n \"upload_eom_time\": \"2026-07-14T18:20:11.300000Z\",\n \"start_time\": \"2026-07-14 18:20:00\",\n \"end_time\": \"2026-07-14 18:20:11\"\n },\n {\n \"id\": 498,\n \"serial_number\": \"ALCLB0A1C2D3\",\n \"interface\": null,\n \"dscp\": 0,\n \"ethernet_priority\": 0,\n \"number_of_connections\": 1,\n \"status\": \"Error_CannotConnectToHost\",\n \"download_url\": \"http://speedtest.example.com/download\",\n \"download_status\": \"Error\",\n \"download_bytes\": 0,\n \"download_duration_ms\": 0,\n \"download_mbps\": 0.0,\n \"download_rom_time\": null,\n \"download_bom_time\": null,\n \"download_eom_time\": null,\n \"upload_url\": \"http://speedtest.example.com/upload\",\n \"upload_test_file_length\": 10485760,\n \"upload_status\": null,\n \"upload_bytes\": 0,\n \"upload_duration_ms\": 0,\n \"upload_mbps\": 0.0,\n \"upload_rom_time\": null,\n \"upload_bom_time\": null,\n \"upload_eom_time\": null,\n \"start_time\": \"2026-07-14 17:02:11\",\n \"end_time\": \"2026-07-14 17:02:19\"\n }\n ]\n}"},{"id":"8c356aae-92db-4dfe-ad0c-e3e81ffdff51","name":"400 Bad Request - Device not found","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ..."}],"url":"https://your-instance.olt.com/api/v2/acs/{{sn}}/bandwidth_test/history"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": false,\n \"error\": \"Device not found\"\n}"}],"_postman_id":"e5cf6f8a-5bdf-45c4-a585-0a8df07de5e6"}],"id":"e007876c-ec6e-458f-8eff-ded9af198daf","description":"Speed test (download/upload) run directly on a TR-069 ONU.
\nThe test is asynchronous: POST enqueues it and returns 202 Accepted with a record in Waiting; poll the detail endpoint by id until status reaches a terminal value (Complete or an Error_* state). Speedtest URLs fall back device → TR-069 settings when not provided in the body; if neither is configured the request fails with 400. A per-device Redis lock (30s TTL) throttles requests with 429.
This endpoint is used to retrieve all devices registered in TR-069.
Below are the fields that can be used to filter the device search.
This endpoint is used to modify the SSID and Wi-Fi password data of devices.
\nNone of the fields exemplified below are mandatory. If you do not wish to change a field or if your device does not have a 5.8GHz Wi-Fi network, you do not need to send the parameters.
\n","urlObject":{"path":["api","v2","acs","{device_serial_number}","config_wifi"],"host":["https://your-instance.olt.com"],"query":[],"variable":[]}},"response":[{"id":"86ab629e-e828-44b5-b424-d73030279cf9","name":"Update Wifi info","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ssid\": \"\",\n \"wifi_pass\": \"\",\n \"ssid_5\": \"\",\n \"wifi_pass_5\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://your-instance.olt.com/api/v2/acs/{device_serial_number}/config_wifi"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": true,\n \"msg\": \"Commands successfully sent to the device\"\n}"},{"id":"d7ccd165-71ba-48fe-bc70-1d15ad5b6fb9","name":"Update Wifi info error","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"body":{"mode":"raw","raw":"{\n \"ssid\": \"\",\n \"wifi_pass\": \"\",\n \"ssid_5\": \"\",\n \"wifi_pass_5\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://your-instance.olt.com/api/v2/acs/{device_serial_number}/config_wifi"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": false,\n \"msg\": \"Error sending commands to the device\"\n}"}],"_postman_id":"b388e234-01c5-49e6-becb-72629a042536"},{"name":"Get Device Parameters","id":"005c2f46-964e-4c26-8709-392a0362e824","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/acs/{device_serial_number}/parameters","description":"This endpoint serves to list all the device's parameters with their respective values and information on which fields allow value writing. Editable parameters have the field \"wr\" = true.
\nIf the \"xsi:type\" field has the value \"xsd:boolean\", caution is required when modifying this field. Some device models interpret false values as \"0\" and true values as \"1\", while others literally use the string values \"false\" or \"true\".
\n","urlObject":{"path":["api","v2","acs","{device_serial_number}","parameters"],"host":["https://your-instance.olt.com"],"query":[],"variable":[]}},"response":[{"id":"e308361b-bc28-410a-ba9a-c664ad2f41dc","name":"Get device parameters","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/acs/{device_serial_number}/parameters"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": true,\n \"parameters\": [\n \t{\n \"Name\": \"Device.WiFi.SSID.1.SSID\",\n \"Value\": {\n \"wr\": true,\n \"value\": \"CPE_SSID_NAME\",\n \"klass\": {\n \"xsi:type\": \"xsd:string\"\n }\n }\n }\n {\n \"Name\": \"Device.DeviceInfo.Manufacturer\",\n \"Value\": {\n \"wr\": false,\n \"value\": \"TP-Link\",\n \"klass\": {\n \"xsi:type\": \"xsd:string\"\n }\n }\n },\n {\n \"Name\": \"Device.DeviceInfo.ManufacturerOUI\",\n \"Value\": {\n \"wr\": false,\n \"value\": \"482254\",\n \"klass\": {\n \"xsi:type\": \"xsd:string\"\n }\n }\n },\n {\n \"Name\": \"Device.DeviceInfo.ModelName\",\n \"Value\": {\n \"wr\": false,\n \"value\": \"EC220-G5\",\n \"klass\": {\n \"xsi:type\": \"xsd:string\"\n }\n }\n },\n {\n \"Name\": \"Device.DeviceInfo.Description\",\n \"Value\": {\n \"wr\": false,\n \"value\": \"AC1300 MU-MIMO Wi-Fi Router\",\n \"klass\": {\n \"xsi:type\": \"xsd:string\"\n }\n }\n },\n {\n \"Name\": \"Device.DeviceInfo.ProductClass\",\n \"Value\": {\n \"wr\": false,\n \"value\": \"EC220-G5\",\n \"klass\": {\n \"xsi:type\": \"xsd:string\"\n }\n }\n },\n {\n \"Name\": \"Device.DeviceInfo.SerialNumber\",\n \"Value\": {\n \"wr\": false,\n \"value\": \"2232366001429\",\n \"klass\": {\n \"xsi:type\": \"xsd:string\"\n }\n }\n },\n {\n \"Name\": \"Device.DeviceInfo.HardwareVersion\",\n \"Value\": {\n \"wr\": false,\n \"value\": \"EC220-G5 3.0\",\n \"klass\": {\n \"xsi:type\": \"xsd:string\"\n }\n }\n },\n {\n \"Name\": \"Device.DeviceInfo.SoftwareVersion\",\n \"Value\": {\n \"wr\": false,\n \"value\": \"1.12.0 Build 220820 Rel.52419n(4252)\",\n \"klass\": {\n \"xsi:type\": \"xsd:string\"\n }\n }\n }\n ]\n}"}],"_postman_id":"005c2f46-964e-4c26-8709-392a0362e824"},{"name":"Set Device Parameters","id":"11d263ff-6dfd-45d3-917b-784ad79ec3e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-auth-token","value":"token","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"name\": \"Device.WiFi.SSID.1.SSID\",\n \"value\": \"NEW_SSID_NAME\"\n },\n {\n \"name\": \"Device.WiFi.SSID.3.SSID\",\n \"value\": \"NEW_SSID_NAME_5G\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://your-acs-instance.com:7995/api/set/{device_serial_number}","description":"This endpoint is used to set new values for the device's parameters. To check which parameters can be edited and the type of values they accept, refer to the \"Get device parameters\" endpoint available in this section of the API.
When sending the parameters to be changed, the API will return a code that should be used to check the progress of the requested change. Send the response key returned as per the instructions in the \"Check Response\" endpoint listed in this section of the documentation.
\n\n","urlObject":{"protocol":"https","port":"7995","path":["api","set","{device_serial_number}"],"host":["your-acs-instance","com"],"query":[],"variable":[]}},"response":[{"id":"05a3eb29-e785-46b9-98ff-d10c300ffa66","name":"Set device parameters","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"name\": \"Device.WiFi.SSID.1.SSID\",\n \"value\": \"NEW_SSID_NAME\"\n },\n {\n \"name\": \"Device.WiFi.SSID.3.SSID\",\n \"value\": \"NEW_SSID_NAME_5G\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"https://your-acs-instance.com:7995/api/set/{device_serial_number}"},"code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": \"2232366001429:set:00802d179a\"\n}"}],"_postman_id":"11d263ff-6dfd-45d3-917b-784ad79ec3e6"},{"name":"Check Response","id":"b6de5156-b770-4eda-a135-df262bfcffe1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"x-auth-token","value":"token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"response\": \"223266000142:set:8c9244f64\"\n}","options":{"raw":{"language":"json"}}},"url":"https://your-acs-instance.com:7995/api/response","description":"Remember that to use this endpoint, you must use the ACS service URL as the base URL and the authentication method as instructed in the introduction of this topic in the documentation.
\n
This endpoint is used to check a data change request submitted through the \"Set device parameters\" endpoint. The expected response from this endpoint, once the change has been applied, is the return of all the device's parameters and values. If the key has already expired at the time of the query or if there was an error in the format of the submitted request, a 404 status code will be returned.
After processing a change, the key containing the device's values will be available for query for 5 minutes. After this period, the key will no longer be valid for consultation.
After the key is successfully queried and returned, it is deleted. Therefore, once you obtain the response, if you use the returned values for any validation, this response must be stored, as it will no longer be available for query through the response check key.
\n\n\n","urlObject":{"protocol":"https","port":"7995","path":["api","response"],"host":["your-acs-instance","com"],"query":[],"variable":[]}},"response":[{"id":"394e067d-b19e-4aae-a2a9-b37d5bb29676","name":"Check response","originalRequest":{"method":"POST","header":[{"key":"x-auth-token","value":"token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"response\": \"223266000142:set:8c9244f64\"\n}","options":{"raw":{"language":"json"}}},"url":"https://your-acs-instance.com:7995/api/response"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"Device.WiFi.SSID.1.SSID\": {\n \"wr\": true,\n \"value\": \"CPE_SSID_NAME\",\n \"klass\": {\n \"xsi:type\": \"xsd:string\"\n }\n },\n \"Device.DeviceInfo.Manufacturer\": {\n \"wr\": false,\n \"value\": \"TP-Link\",\n \"klass\": {\n \"xsi:type\": \"xsd:string\"\n }\n },\n \"Device.DeviceInfo.ModelName\": {\n \"wr\": false,\n \"value\": \"EC220-G5\",\n \"klass\": {\n \"xsi:type\": \"xsd:string\"\n }\n }\n}"},{"id":"aa8e498c-af2a-44d3-94d2-2403246fe206","name":"Check response error","originalRequest":{"method":"POST","header":[{"key":"x-auth-token","value":"token","type":"text"}],"body":{"mode":"raw","raw":"{\n \"response\": \"223266000142:set:8c9244f64\"\n}","options":{"raw":{"language":"json"}}},"url":"https://your-acs-instance.com:7995/api/response"},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"b6de5156-b770-4eda-a135-df262bfcffe1"},{"name":"Get Device Parameters by MAC","id":"0c9024cf-3155-4f60-99e6-62929fcea82b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://your-instance.olt.com/api/v2/acs/mac/{{mac}}/parameters","description":"Remember that to use this endpoint, you must use the ACS service URL as the base URL and the authentication method as instructed in the introduction of this topic in the documentation.
\n
This endpoint serves to list all the device's parameters with their respective values and information on which fields allow value writing. Editable parameters have the field \"wr\" = true.
\nIf the \"xsi:type\" field has the value \"xsd:boolean\", caution is required when modifying this field. Some device models interpret false values as \"0\" and true values as \"1\", while others literally use the string values \"false\" or \"true\".
\n","urlObject":{"path":["api","v2","acs","mac","{{mac}}","parameters"],"host":["https://your-instance.olt.com"],"query":[{"disabled":true,"description":{"content":"When this parameter is provided, the data is collected immediately from the device. If the parameter is not provided, the information from the last collection will be returned (the time of the last collection is indicated in the 'last_update' field).
\n","type":"text/plain"},"key":"force","value":"1"}],"variable":[]}},"response":[{"id":"bcf8bcaa-5856-4f39-b6bb-a999233f1a42","name":"Get Device Parameters by MAC","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://your-instance.olt.com/api/v2/acs/mac/14:36:0E:8D:F8:C3/parameters"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"return\": true,\n \"device\": {\n \"id\": 4244,\n \"client_name\": null,\n \"login\": \"martins.queiroz@889.com.br\",\n \"vendor\": \"ZYXEL\",\n \"serial_number\": \"S240Y37150419\",\n \"gpon_serial_number\": null,\n \"online\": true,\n \"hardware_version\": \"PX3321-T1\",\n \"software_version\": \"V5.44(ACHK.0.2)C0\",\n \"last_updated\": \"2025-06-11 14:11:51\",\n \"ips\": [\n \"100.69.24.87\"\n ]\n },\n \"parameters\": [\n {\n \"Name\": \"Device.\",\n \"Value\": {\n \"wr\": false\n }\n },\n {\n \"Name\": \"Device.RootDataModelVersion\",\n \"Value\": {\n \"wr\": false,\n \"value\": \"2.0\",\n \"klass\": {\n \"xsi:type\": \"xsd:string\"\n }\n }\n },\n {\n \"Name\": \"Device.DeviceSummary\",\n \"Value\": {\n \"wr\": false,\n \"value\": \"Device:2.0[](DownloadTCP:1,UploadTCP:1,UDPEcho:1,UDPEchoPlus:1,MemoryStatus:1,ProcessStatus:1,NAT:1,UDPConnReq:1,IPPing:1,TraceRoute:1),VoiceService:1[](Endpoint:1,SIPEndpoint:1,TAEndpoint:1,)\",\n \"klass\": {\n \"xsi:type\": \"xsd:string\"\n }\n }\n },\n {\n \"Name\": \"Device.InterfaceStackNumberOfEntries\",\n \"Value\": {\n \"wr\": false,\n \"value\": \"0\",\n \"klass\": {\n \"xsi:type\": \"xsd:unsignedInt\"\n }\n }\n },\n {\n \"Name\": \"Device.Services.\",\n \"Value\": {\n \"wr\": false\n }\n },\n {\n \"Name\": \"Device.Services.VoiceServiceNumberOfEntries\",\n \"Value\": {\n \"wr\": false,\n \"value\": \"1\",\n \"klass\": {\n \"xsi:type\": \"xsd:unsignedInt\"\n }\n }\n },\n {\n \"Name\": \"Device.Services.VoiceService.\",\n \"Value\": {\n \"wr\": false\n }\n },\n {\n \"Name\": \"Device.Services.VoiceService.1.\",\n \"Value\": {\n \"wr\": false\n }\n },\n {\n \"Name\": \"Device.Services.VoiceService.1.VoiceProfileNumberOfEntries\",\n \"Value\": {\n \"wr\": false,\n \"value\": \"1\",\n \"klass\": {\n \"xsi:type\": \"xsd:unsignedInt\"\n }\n }\n },\n {\n \"Name\": \"Device.Services.VoiceService.1.X_ZYXEL_LoggingLevel\",\n \"Value\": {\n \"wr\": true,\n \"value\": \"0\",\n \"klass\": {\n \"xsi:type\": \"xsd:unsignedInt\"\n }\n }\n },\n {\n \"Name\": \"Device.Services.VoiceService.1.Capabilities.\",\n \"Value\": {\n \"wr\": false\n }\n },\n {\n \"Name\": \"Device.Services.VoiceService.1.Capabilities.MaxProfileCount\",\n \"Value\": {\n \"wr\": false,\n \"value\": \"2\",\n \"klass\": {\n \"xsi:type\": \"xsd:unsignedInt\"\n }\n }\n },\n {\n \"Name\": \"Device.Services.VoiceService.1.Capabilities.MaxLineCount\",\n \"Value\": {\n \"wr\": false,\n \"value\": \"8\",\n \"klass\": {\n \"xsi:type\": \"xsd:unsignedInt\"\n }\n }\n },\n {\n \"Name\": \"Device.Services.VoiceService.1.Capabilities.MaxSessionsPerLine\",\n \"Value\": {\n \"wr\": false,\n \"value\": \"2\",\n \"klass\": {\n \"xsi:type\": \"xsd:unsignedInt\"\n }\n }\n },\n {\n \"Name\": \"Device.Services.VoiceService.1.Capabilities.MaxSessionCount\",\n \"Value\": {\n \"wr\": false,\n \"value\": \"10\",\n \"klass\": {\n \"xsi:type\": \"xsd:unsignedInt\"\n }\n }\n },\n {\n \"Name\": \"Device.Services.VoiceService.1.Capabilities.SignalingProtocols\",\n \"Value\": {\n \"wr\": false,\n \"value\": \"SIP\",\n \"klass\": {\n \"xsi:type\": \"xsd:string\"\n }\n }\n },\n {\n \"Name\": \"Device.Services.VoiceService.1.Capabilities.Regions\",\n \"Value\": {\n \"wr\": false,\n \"value\": \"AE,AR,AU,AT,BE,BG,BA,BR,CH,CL,CN,CO,CZ,DE,DK,ES,XE,FI,FR,GB,GR,HR,HU,IN,IE,IT,JP,NL,NO,NZ,PK,PL,RO,RU,SA,RS,SK,SI,SE,XT,TH,TR,TW,UA,US,VN\",\n \"klass\": {\n \"xsi:type\": \"xsd:string\"\n }\n }\n },\n {\n \"Name\": \"Device.Services.VoiceService.1.Capabilities.RTCP\",\n \"Value\": {\n \"wr\": false,\n \"value\": \"1\",\n \"klass\": {\n \"xsi:type\": \"xsd:boolean\"\n }\n }\n },\n {\n \"Name\": \"Device.Services.VoiceService.1.Capabilities.SRTP\",\n \"Value\": {\n \"wr\": false,\n \"value\": \"1\",\n \"klass\": {\n \"xsi:type\": \"xsd:boolean\"\n }\n }\n },\n {\n \"Name\": \"Device.Services.VoiceService.1.Capabilities.SRTPKeyingMethods\",\n \"Value\": {\n \"wr\": false,\n \"value\": \"SDP\",\n \"klass\": {\n \"xsi:type\": \"xsd:string\"\n }\n }\n },\n {\n \"Name\": \"Device.Services.VoiceService.1.Capabilities.SRTPEncryptionKeySizes\",\n \"Value\": {\n \"wr\": false,\n \"value\": \"240\",\n \"klass\": {\n \"xsi:type\": \"xsd:string\"\n }\n }\n },\n {\n \"Name\": \"Device.Services.VoiceService.1.Capabilities.RTPRedundancy\",\n \"Value\": {\n \"wr\": false,\n \"value\": \"0\",\n \"klass\": {\n \"xsi:type\": \"xsd:boolean\"\n }\n }\n },\n {\n \"Name\": \"Device.Services.VoiceService.1.Capabilities.DSCPCoupled\",\n \"Value\": {\n \"wr\": false,\n \"value\": \"0\",\n \"klass\": {\n \"xsi:type\": \"xsd:boolean\"\n }\n }\n },\n {\n \"Name\": \"Device.Services.VoiceService.1.Capabilities.EthernetTaggingCoupled\",\n \"Value\": {\n \"wr\": false,\n \"value\": \"0\",\n \"klass\": {\n \"xsi:type\": \"xsd:boolean\"\n }\n }\n },\n {\n \"Name\": \"Device.Services.VoiceService.1.Capabilities.PSTNSoftSwitchOver\",\n \"Value\": {\n \"wr\": false,\n \"value\": \"0\",\n \"klass\": {\n \"xsi:type\": \"xsd:boolean\"\n }\n }\n },\n {\n \"Name\": \"Device.Services.VoiceService.1.Capabilities.FaxT38\",\n \"Value\": {\n \"wr\": false,\n \"value\": \"1\",\n \"klass\": {\n \"xsi:type\": \"xsd:boolean\"\n }\n }\n },\n {\n \"Name\": \"Device.Services.VoiceService.1.Capabilities.FaxPassThrough\",\n \"Value\": {\n \"wr\": false,\n \"value\": \"1\",\n \"klass\": {\n \"xsi:type\": \"xsd:boolean\"\n }\n }\n },\n {\n \"Name\": \"Device.Services.VoiceService.1.Capabilities.ModemPassThrough\",\n \"Value\": {\n \"wr\": false,\n \"value\": \"0\",\n \"klass\": {\n \"xsi:type\": \"xsd:boolean\"\n }\n }\n },\n {\n \"Name\": \"Device.Services.VoiceService.1.Capabilities.ToneGeneration\",\n \"Value\": {\n \"wr\": false,\n \"value\": \"0\",\n \"klass\": {\n \"xsi:type\": \"xsd:boolean\"\n }\n }\n },\n {\n \"Name\": \"Device.Services.VoiceService.1.Capabilities.ToneDescriptionsEditable\",\n \"Value\": {\n \"wr\": false,\n \"value\": \"0\",\n \"klass\": {\n \"xsi:type\": \"xsd:boolean\"\n }\n }\n },\n {\n \"Name\": \"Device.Services.VoiceService.1.Capabilities.PatternBasedToneGeneration\",\n \"Value\": {\n \"wr\": false,\n \"value\": \"0\",\n \"klass\": {\n \"xsi:type\": \"xsd:boolean\"\n }\n }\n }\n ]\n}"}],"_postman_id":"0c9024cf-3155-4f60-99e6-62929fcea82b"},{"name":"Reboot Device","id":"cba6c9a1-fb8e-473b-9115-fa4dc43b2d80","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://your-instance.olt.com/api/v2/acs/{device_serial_number}/reboot","description":"This endpoint triggers a remote reboot of a CPE (Customer Premises Equipment) device via the TR-069 protocol. When called, the system sends a Reboot command to the device, instructing it to restart. This action is typically used for maintenance purposes, remote troubleshooting, or applying configuration changes that require a reboot.
Contains data on the Wi-Fi signal quality of devices connected to the router.
\ndevices (object)A list of connected Wi-Fi devices, indexed by MAC address. Each item includes:
\nmean: average RSSI value of the device
values: list of individual signal measurements, each with time, value (RSSI), ssid, and band
ssid: Wi-Fi network name
band: frequency band used (e.g., \"2.4GHz\", \"5GHz\")
hostname: device hostname
online: whether the device is currently connected
history (array)Consolidated measurement history per timestamp. Each item includes:
\nrssi_mean: average RSSI at the given time
cok: number of devices with regular signal
cbad: number of devices with poor signal
dcount: total connected devices
cok_mean, cbad_mean, dcount_mean: historical averages of each metric
time: timestamp of the measurement
Returns a paginated list of RSSI research records, one per TR-069 device. Each record summarizes the Wi-Fi signal quality of the client devices connected to that equipment.
\nThe ACS module must be enabled on the installation; otherwise the endpoint returns 400 with ACS module is required for ACS endpoints.
All fields below can be used as query filters. Text fields use a partial (case-insensitive) match by default. Numeric fields (mean_rssi, historical_mean_rssi, connected_devices, regular_signal_devices, bad_signal_devices) can be combined with the oper parameter (=, >, >=, <, <=) for range queries. Sending a field that is not in the list returns 400 with the list of unavailable fields.
Each result object contains:
\nequipment_model - device model.mac - device MAC address.serial_number - device serial number.login - login/PPPoE of the linked client.online - whether the device is currently online.mean_rssi - current mean RSSI (dBm) across connected devices.historical_mean_rssi - historical mean RSSI (dBm).connected_devices - number of connected client devices.regular_signal_devices - number of connected devices with acceptable signal.bad_signal_devices - number of connected devices with poor signal.rssi_verified - whether the RSSI was verified.last_updated - last full update timestamp (YYYY-MM-DD HH:MM:SS), or null.Returns the attributes of a TR-069 device grouped exactly as they appear on the internal device details page. The data is served from the cached parameters by default; pass force to query the device live before returning.
\nQuery parameters
\n","urlObject":{"path":["api","v2","acs","{device_serial_number}","info"],"host":["https://your-instance.olt.com"],"query":[],"variable":[]}},"response":[{"id":"6875f9b0-8285-4dbb-9ab1-fad89ed7df90","name":"GET Device Info","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/acs/{device_serial_number}/info"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"return\": true,\n \"device\": {\n \"id\": 69881,\n \"client_name\": \"Thiago Santos\",\n \"login\": \"thiago.santos\",\n \"vendor\": \"TP-Link\",\n \"model\": \"XX530vV2\",\n \"serial_number\": \"TPLGD11FD918\",\n \"gpon_serial_number\": null,\n \"mac\": \"50:3D:D1:1F:D9:1B\",\n \"online\": true,\n \"hardware_version\": \"XX530vV2 v2.0 00000000\",\n \"software_version\": \"0.5.0 3.1.10 v60dc.0 Build 250930 Rel.44551n\",\n \"last_updated\": \"2026-07-21 20:25:06\",\n \"ips\": [\n \"100.80.43.141\"\n ],\n \"wifi_devices\": 5,\n \"wifi_devices_mean\": 3,\n \"regular_signal_wifi_devices\": 0,\n \"regular_signal_wifi_devices_mean\": 0,\n \"bad_signal_wifi_devices\": 0,\n \"bad_signal_wifi_devices_mean\": 0,\n \"device_type\": \"ONU/ONT\"\n },\n \"groups\": [\n {\n \"group\": \"Roteador\",\n \"fields\": [\n {\n \"type\": \"field\",\n \"param\": \"Device.DeviceInfo.ModelName\",\n \"title\": \"None\",\n \"value\": \"XX530vV2\",\n \"display_value\": \"XX530vV2\",\n \"writable\": false,\n \"options\": null\n },\n {\n \"type\": \"field\",\n \"param\": \"Device.DeviceInfo.HardwareVersion\",\n \"title\": \"None\",\n \"value\": \"XX530vV2 v2.0 00000000\",\n \"display_value\": \"XX530vV2 v2.0 00000000\",\n \"writable\": false,\n \"options\": null\n },\n {\n \"type\": \"field\",\n \"param\": \"Device.DeviceInfo.SoftwareVersion\",\n \"title\": \"None\",\n \"value\": \"0.5.0 3.1.10 v60dc.0 Build 250930 Rel.44551n\",\n \"display_value\": \"0.5.0 3.1.10 v60dc.0 Build 250930 Rel.44551n\",\n \"writable\": false,\n \"options\": null\n },\n {\n \"type\": \"field\",\n \"param\": \"Device.DeviceInfo.UpTime\",\n \"title\": \"None\",\n \"value\": \"202\",\n \"display_value\": \"202\",\n \"writable\": false,\n \"options\": null\n },\n {\n \"type\": \"field\",\n \"param\": \"Device.DeviceInfo.ProcessStatus.CPUUsage\",\n \"title\": \"None\",\n \"value\": \"18\",\n \"display_value\": \"18\",\n \"writable\": false,\n \"options\": null\n },\n {\n \"type\": \"field\",\n \"param\": \"Device.DeviceInfo.MemoryStatus.Total\",\n \"title\": \"None\",\n \"value\": \"215704\",\n \"display_value\": \"215704\",\n \"writable\": false,\n \"options\": null\n },\n {\n \"type\": \"field\",\n \"param\": \"Device.DeviceInfo.MemoryStatus.Free\",\n \"title\": \"None\",\n \"value\": \"81048\",\n \"display_value\": \"81048\",\n \"writable\": false,\n \"options\": null\n },\n {\n \"type\": \"field\",\n \"param\": \"Device.WiFi.X_TP_BandSteering.Enable\",\n \"title\": \"None\",\n \"value\": \"1\",\n \"display_value\": \" Habilitado\",\n \"writable\": true,\n \"options\": [\n [\n \"0\",\n \" Desabilitado\"\n ],\n [\n \"1\",\n \" Habilitado\"\n ]\n ]\n },\n {\n \"type\": \"field\",\n \"param\": \"Device.DHCPv4.Server.Enable\",\n \"title\": \"None\",\n \"value\": \"1\",\n \"display_value\": \" Habilitado\",\n \"writable\": true,\n \"options\": [\n [\n \"0\",\n \" Desabilitado\"\n ],\n [\n \"1\",\n \" Habilitado\"\n ]\n ]\n }\n ]\n },\n {\n \"group\": \"WiFi 2.4\",\n \"fields\": [\n {\n \"type\": \"field\",\n \"param\": \"Device.WiFi.SSID.1.Enable\",\n \"title\": \"None\",\n \"value\": \"1\",\n \"display_value\": \" Sim\",\n \"writable\": true,\n \"options\": [\n [\n \"1\",\n \" Sim\"\n ],\n [\n \"0\",\n \" Não\"\n ]\n ]\n },\n {\n \"type\": \"field\",\n \"param\": \"Device.WiFi.SSID.1.Status\",\n \"title\": \"None\",\n \"value\": \"Up\",\n \"display_value\": \" Up\",\n \"writable\": false,\n \"options\": [\n [\n \"Down\",\n \" Down\"\n ],\n [\n \"Up\",\n \" Up\"\n ]\n ]\n },\n {\n \"type\": \"field\",\n \"param\": \"Device.WiFi.Radio.1.Channel\",\n \"title\": \"None\",\n \"value\": \"2\",\n \"display_value\": \"2\",\n \"writable\": true,\n \"options\": [\n \"1\",\n \"2\",\n \"3\",\n \"4\",\n \"5\",\n \"6\",\n \"7\",\n \"8\",\n \"9\",\n \"10\",\n \"11\",\n \"12\",\n \"13\"\n ]\n },\n {\n \"type\": \"field\",\n \"param\": \"Device.WiFi.Radio.1.AutoChannelEnable\",\n \"title\": \"None\",\n \"value\": \"1\",\n \"display_value\": \" Sim\",\n \"writable\": true,\n \"options\": [\n [\n \"1\",\n \" Sim\"\n ],\n [\n \"0\",\n \" Não\"\n ]\n ]\n },\n {\n \"type\": \"field\",\n \"param\": \"Device.WiFi.SSID.1.SSID\",\n \"title\": \"None\",\n \"value\": \"Thiago\",\n \"display_value\": \"Thiago\",\n \"writable\": true,\n \"options\": null\n },\n {\n \"type\": \"field\",\n \"param\": \"Device.WiFi.AccessPoint.1.Security.KeyPassphrase\",\n \"title\": \"None\",\n \"value\": null,\n \"display_value\": null,\n \"writable\": true,\n \"options\": null\n },\n {\n \"type\": \"field\",\n \"param\": \"Device.WiFi.Radio.1.OperatingStandards\",\n \"title\": \"None\",\n \"value\": \"b,g,n,ax\",\n \"display_value\": \"b,g,n,ax\",\n \"writable\": false,\n \"options\": [\n [\n \"n\",\n \"802.11n only\"\n ],\n [\n \"g,n\",\n \"802.11gn mixed\"\n ],\n [\n \"b,g,n\",\n \"802.11bgn mixed\"\n ]\n ]\n },\n {\n \"type\": \"field\",\n \"param\": \"Device.WiFi.Radio.1.TransmitPower\",\n \"title\": \"None\",\n \"value\": \"100\",\n \"display_value\": \"Alta\",\n \"writable\": true,\n \"options\": [\n [\n \"25\",\n \"Baixa\"\n ],\n [\n \"50\",\n \"Média\"\n ],\n [\n \"100\",\n \"Alta\"\n ]\n ]\n }\n ]\n },\n {\n \"group\": \"WiFi 5.8\",\n \"fields\": [\n {\n \"type\": \"field\",\n \"param\": \"Device.WiFi.SSID.3.Enable\",\n \"title\": \"None\",\n \"value\": \"1\",\n \"display_value\": \" Sim\",\n \"writable\": true,\n \"options\": [\n [\n \"1\",\n \" Sim\"\n ],\n [\n \"0\",\n \" Não\"\n ]\n ]\n },\n {\n \"type\": \"field\",\n \"param\": \"Device.WiFi.SSID.3.Status\",\n \"title\": \"None\",\n \"value\": \"Up\",\n \"display_value\": \" Up\",\n \"writable\": false,\n \"options\": [\n [\n \"Down\",\n \" Down\"\n ],\n [\n \"Up\",\n \" Up\"\n ]\n ]\n },\n {\n \"type\": \"field\",\n \"param\": \"Device.WiFi.Radio.2.Channel\",\n \"title\": \"None\",\n \"value\": \"40\",\n \"display_value\": \"40\",\n \"writable\": true,\n \"options\": [\n \"36\",\n \"40\",\n \"44\",\n \"48\",\n \"52\",\n \"56\",\n \"60\",\n \"64\",\n \"149\",\n \"153\",\n \"157\",\n \"161\",\n \"100\",\n \"104\",\n \"108\",\n \"112\",\n \"116\",\n \"120\",\n \"124\",\n \"128\",\n \"132\",\n \"136\",\n \"140\",\n \"144\",\n \"165\"\n ]\n },\n {\n \"type\": \"field\",\n \"param\": \"Device.WiFi.Radio.2.AutoChannelEnable\",\n \"title\": \"None\",\n \"value\": \"1\",\n \"display_value\": \" Sim\",\n \"writable\": true,\n \"options\": [\n [\n \"1\",\n \" Sim\"\n ],\n [\n \"0\",\n \" Não\"\n ]\n ]\n },\n {\n \"type\": \"field\",\n \"param\": \"Device.WiFi.SSID.3.SSID\",\n \"title\": \"None\",\n \"value\": \"Thiago\",\n \"display_value\": \"Thiago\",\n \"writable\": true,\n \"options\": null\n },\n {\n \"type\": \"field\",\n \"param\": \"Device.WiFi.AccessPoint.3.Security.KeyPassphrase\",\n \"title\": \"None\",\n \"value\": null,\n \"display_value\": null,\n \"writable\": true,\n \"options\": null\n },\n {\n \"type\": \"field\",\n \"param\": \"Device.WiFi.Radio.2.OperatingStandards\",\n \"title\": \"None\",\n \"value\": \"a,n,ac,ax\",\n \"display_value\": \"a,n,ac,ax\",\n \"writable\": false,\n \"options\": [\n [\n \"ac\",\n \"802.11ac only\"\n ],\n [\n \"n,ac\",\n \"802.11ac/n mixed\"\n ],\n [\n \"a,n,ac\",\n \"802.11a/n/ac mixed\"\n ]\n ]\n },\n {\n \"type\": \"field\",\n \"param\": \"Device.WiFi.Radio.2.TransmitPower\",\n \"title\": \"None\",\n \"value\": \"100\",\n \"display_value\": \"Alta\",\n \"writable\": true,\n \"options\": [\n [\n \"25\",\n \"Baixa\"\n ],\n [\n \"50\",\n \"Média\"\n ],\n [\n \"100\",\n \"Alta\"\n ]\n ]\n }\n ]\n },\n {\n \"group\": \"WAN PPPoE\",\n \"fields\": [\n {\n \"type\": \"table\",\n \"title\": \"None\",\n \"columns\": [\n \"Nome\",\n \"Exclude\",\n \"Ativo\",\n \"Login\",\n \"Senha\",\n \"VLAN\",\n \"Serviço\",\n \"Uptime\",\n \"IP\",\n \"Status\",\n \"Ações\"\n ],\n \"rows\": [\n {\n \"Nome\": \"ppp1\",\n \"Exclude\": \"Device.Ethernet.VLANTermination.2.\",\n \"Ativo\": \"1\",\n \"Login\": \"thiago.r.santos@fenix\",\n \"Senha\": \"\",\n \"VLAN\": \"400\",\n \"Serviço\": \"Internet\",\n \"Uptime\": \"143\",\n \"IP\": \"100.80.36.247\",\n \"Status\": \"Connected\",\n \"Ações\": \"\"\n }\n ]\n }\n ]\n },\n {\n \"group\": \"WAN IP\",\n \"fields\": [\n {\n \"type\": \"table\",\n \"title\": \"None\",\n \"columns\": [\n \"Nome\",\n \"Exclude\",\n \"Aquisição\",\n \"Habilitar\",\n \"IP\",\n \"Mascara\",\n \"Uptime\",\n \"Status\",\n \"Ações\"\n ],\n \"rows\": []\n }\n ]\n },\n {\n \"group\": \"Portas LAN\",\n \"fields\": [\n {\n \"type\": \"table\",\n \"title\": \"None\",\n \"columns\": [\n \"Porta\",\n \"Ativa\",\n \"Status\",\n \"Velocidade\",\n \"Duplex\"\n ],\n \"rows\": [\n {\n \"Porta\": \"LAN1\",\n \"Ativa\": \"1\",\n \"Status\": \"Up\",\n \"Velocidade\": \"-1\",\n \"Duplex\": \"Auto\"\n },\n {\n \"Porta\": \"LAN2\",\n \"Ativa\": \"1\",\n \"Status\": \"Up\",\n \"Velocidade\": \"-1\",\n \"Duplex\": \"Auto\"\n },\n {\n \"Porta\": \"LAN3\",\n \"Ativa\": \"1\",\n \"Status\": \"Up\",\n \"Velocidade\": \"-1\",\n \"Duplex\": \"Auto\"\n },\n {\n \"Porta\": \"LAN4\",\n \"Ativa\": \"1\",\n \"Status\": \"Up\",\n \"Velocidade\": \"1000\",\n \"Duplex\": \"Full\"\n }\n ]\n }\n ]\n },\n {\n \"group\": \"Dispositivos Conectados\",\n \"fields\": [\n {\n \"type\": \"table\",\n \"title\": \"None\",\n \"columns\": [\n \"Conexão\",\n \"MAC\",\n \"CT\",\n \"Dispositivo\",\n \"IP\",\n \"IP Aquisição\"\n ],\n \"rows\": [\n {\n \"Conexão\": \"Ethernet\",\n \"MAC\": \"28:87:BA:21:57:E2\",\n \"CT\": \"0\",\n \"Dispositivo\": \"HC220-G5_57E2\",\n \"IP\": {\n \"param\": \"Device.Hosts.Host.*.IPv4Address.1.IPAddress\",\n \"title\": \"IP\",\n \"b_param\": \"Device.Hosts.Host.*.IPv4Address.1.IPAddress\",\n \"hidden\": true\n },\n \"IP Aquisição\": \"DHCP\"\n },\n {\n \"Conexão\": \"Wi-Fi\",\n \"MAC\": \"06:ED:B3:15:0B:98\",\n \"CT\": \"1\",\n \"Dispositivo\": \"Unknown\",\n \"IP\": {\n \"param\": \"Device.Hosts.Host.*.IPv4Address.1.IPAddress\",\n \"title\": \"IP\",\n \"b_param\": \"Device.Hosts.Host.*.IPv4Address.1.IPAddress\",\n \"hidden\": true\n },\n \"IP Aquisição\": \"Static\"\n }\n ]\n }\n ]\n },\n {\n \"group\": \"SIP\",\n \"fields\": [\n {\n \"type\": \"field\",\n \"param\": \"Device.Services.VoiceService.1.VoiceProfile.1.Line.1.Enable\",\n \"title\": \"None\",\n \"value\": \"Enabled\",\n \"display_value\": \" Sim\",\n \"writable\": true,\n \"options\": [\n [\n \"Enabled\",\n \" Sim\"\n ],\n [\n \"Disabled\",\n \" Não\"\n ]\n ]\n },\n {\n \"type\": \"field\",\n \"param\": \"Device.Services.VoiceService.1.VoiceProfile.1.Line.1.SIP.URI\",\n \"title\": \"None\",\n \"value\": null,\n \"display_value\": null,\n \"writable\": true,\n \"options\": null\n },\n {\n \"type\": \"field\",\n \"param\": \"Device.Services.VoiceService.1.VoiceProfile.1.Line.1.SIP.AuthUserName\",\n \"title\": \"None\",\n \"value\": null,\n \"display_value\": null,\n \"writable\": true,\n \"options\": null\n },\n {\n \"type\": \"field\",\n \"param\": \"Device.Services.VoiceService.1.VoiceProfile.1.Line.1.SIP.AuthPassword\",\n \"title\": \"None\",\n \"value\": null,\n \"display_value\": null,\n \"writable\": true,\n \"options\": null\n },\n {\n \"type\": \"field\",\n \"param\": \"Device.Services.VoiceService.1.VoiceProfile.1.SIP.RegistrarServer\",\n \"title\": \"None\",\n \"value\": \"0.0.0.0\",\n \"display_value\": \"0.0.0.0\",\n \"writable\": true,\n \"options\": null\n },\n {\n \"type\": \"field\",\n \"param\": \"Device.Services.VoiceService.1.VoiceProfile.1.SIP.RegistrarServerPort\",\n \"title\": \"None\",\n \"value\": \"5060\",\n \"display_value\": \"5060\",\n \"writable\": true,\n \"options\": null\n }\n ]\n },\n {\n \"group\": \"Acesso Remoto (Superuser)\",\n \"fields\": [\n {\n \"type\": \"field\",\n \"param\": \"Device.X_TP_AppCfg.SuperHttpCfg.SHttpRemoteEnabled\",\n \"title\": \"None\",\n \"value\": \"1\",\n \"display_value\": \" Sim\",\n \"writable\": true,\n \"options\": [\n [\n \"1\",\n \" Sim\"\n ],\n [\n \"0\",\n \" Não\"\n ]\n ]\n },\n {\n \"type\": \"field\",\n \"param\": \"Device.X_TP_AppCfg.SuperHttpCfg.SHttpRemotePort\",\n \"title\": \"None\",\n \"value\": \"55090\",\n \"display_value\": \"55090\",\n \"writable\": true,\n \"options\": null\n },\n {\n \"type\": \"field\",\n \"param\": \"Device.X_TP_AppCfg.SuperHttpCfg.SHttpsRemoteEnabled\",\n \"title\": \"None\",\n \"value\": \"0\",\n \"display_value\": \" Não\",\n \"writable\": true,\n \"options\": [\n [\n \"1\",\n \" Sim\"\n ],\n [\n \"0\",\n \" Não\"\n ]\n ]\n },\n {\n \"type\": \"field\",\n \"param\": \"Device.X_TP_AppCfg.SuperHttpCfg.SHttpsRemotePort\",\n \"title\": \"None\",\n \"value\": \"443\",\n \"display_value\": \"443\",\n \"writable\": true,\n \"options\": null\n }\n ]\n },\n {\n \"group\": \"Acesso Remoto\",\n \"fields\": [\n {\n \"type\": \"field\",\n \"param\": \"Device.X_TP_AppCfg.HttpCfg.HttpRemoteEnabled\",\n \"title\": \"None\",\n \"value\": \"1\",\n \"display_value\": \" Sim\",\n \"writable\": true,\n \"options\": [\n [\n \"1\",\n \" Sim\"\n ],\n [\n \"0\",\n \" Não\"\n ]\n ]\n },\n {\n \"type\": \"field\",\n \"param\": \"Device.X_TP_AppCfg.HttpCfg.HttpRemotePort\",\n \"title\": \"None\",\n \"value\": \"55090\",\n \"display_value\": \"55090\",\n \"writable\": true,\n \"options\": null\n },\n {\n \"type\": \"field\",\n \"param\": \"Device.X_TP_AppCfg.HttpCfg.HttpsRemoteEnabled\",\n \"title\": \"None\",\n \"value\": \"0\",\n \"display_value\": \" Não\",\n \"writable\": true,\n \"options\": [\n [\n \"1\",\n \" Sim\"\n ],\n [\n \"0\",\n \" Não\"\n ]\n ]\n },\n {\n \"type\": \"field\",\n \"param\": \"Device.X_TP_AppCfg.HttpCfg.HttpsRemotePort\",\n \"title\": \"None\",\n \"value\": \"443\",\n \"display_value\": \"443\",\n \"writable\": true,\n \"options\": null\n }\n ]\n },\n {\n \"group\": \"SIP Codecs\",\n \"fields\": [\n {\n \"type\": \"table\",\n \"title\": \"None\",\n \"columns\": [\n \"Codec\",\n \"Ativo\",\n \"Supressão de Silêncio\",\n \"Packet Time\",\n \"Prioridade\",\n \"Editar\"\n ],\n \"rows\": [\n {\n \"Codec\": \"G.711MuLaw\",\n \"Ativo\": \"1\",\n \"Supressão de Silêncio\": \"1\",\n \"Packet Time\": \"20\",\n \"Prioridade\": \"1\",\n \"Editar\": \"1\"\n },\n {\n \"Codec\": \"G.711ALaw\",\n \"Ativo\": \"1\",\n \"Supressão de Silêncio\": \"1\",\n \"Packet Time\": \"20\",\n \"Prioridade\": \"2\",\n \"Editar\": \"1\"\n },\n {\n \"Codec\": \"G.729a/b\",\n \"Ativo\": \"1\",\n \"Supressão de Silêncio\": \"1\",\n \"Packet Time\": \"20\",\n \"Prioridade\": \"3\",\n \"Editar\": \"1\"\n },\n {\n \"Codec\": \"G.726_32\",\n \"Ativo\": \"1\",\n \"Supressão de Silêncio\": \"1\",\n \"Packet Time\": \"20\",\n \"Prioridade\": \"4\",\n \"Editar\": \"1\"\n },\n {\n \"Codec\": \"G.722\",\n \"Ativo\": \"1\",\n \"Supressão de Silêncio\": \"1\",\n \"Packet Time\": \"20\",\n \"Prioridade\": \"5\",\n \"Editar\": \"1\"\n },\n {\n \"Codec\": \"X_TP_T38\",\n \"Ativo\": \"1\",\n \"Supressão de Silêncio\": \"1\",\n \"Packet Time\": \"20\",\n \"Prioridade\": \"6\",\n \"Editar\": \"1\"\n }\n ]\n }\n ]\n },\n {\n \"group\": \"DHCP Server\",\n \"fields\": [\n {\n \"type\": \"table\",\n \"title\": \"None\",\n \"columns\": [\n \"Ativo\",\n \"IP Inicial\",\n \"IP Final\",\n \"Mascara\",\n \"DNS\",\n \"Lease Time\",\n \"Editar\"\n ],\n \"rows\": [\n {\n \"Ativo\": \"1\",\n \"IP Inicial\": \"192.168.1.2\",\n \"IP Final\": \"192.168.1.249\",\n \"Mascara\": \"255.255.255.0\",\n \"DNS\": \"8.8.8.8,1.1.1.1\",\n \"Lease Time\": \"7200\",\n \"Editar\": \"1\"\n }\n ]\n }\n ]\n }\n ]\n}"}],"_postman_id":"b8305e08-220b-48c3-856a-d7df7dd3e21d"},{"name":"Check Bidirectional Communication","id":"78429563-115a-42bb-8fa1-5f328b72f35c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/acs/{{sn}}/check_bidirectional","description":"Checks whether TR-069 communication with the ONU identified by sn is bidirectional.
Bidirectional means both directions are proven to work:
\nonline;The check fires a real Connection Request and queues no RPC on the device, so nothing is applied or changed on the ONU. The result is written back to the device record, which means GET /api/v2/acs/{sn}/info reflects it immediately after this call.
Synchronous: there is no polling, the response already carries the verdict.
\nforceA successful Connection Request makes the ONU open a CWMP session and find an empty queue — that round trip is the test. Because of that the check is throttled per device by a 60s cooldown: calling it again within the window returns the stored value with cached: true, without touching the device.
To skip the cooldown and force a live probe, send force=1 as a query parameter:
POST https://your-instance.olt.com/api/v2/acs/{{sn}}/check_bidirectional?force=1
The forced call always answers with cached: false. Use it sparingly — each one makes the ONU open a CWMP session.
bidirectional: true only when both directions work.online: whether Informs are arriving from the device.connection_request: whether the ACS managed to reach the device. null when the value came from cache.reason: why the check is not bidirectional — connection_request_failed, device_offline or no_connection_url. null when bidirectional is true.cached: true when the cooldown was active and no Connection Request was sent.A failed check never marks the device offline: online is fed by Informs, and a diagnostic must not corrupt that state.
Optional. Bypasses the 60s per-device cooldown and always fires a live Connection Request. Omit it to reuse the stored result while the cooldown is active.
\n","type":"text/plain"},"key":"force","value":"1"}],"variable":[]}},"response":[{"id":"997de917-79f9-4404-a3b5-f410559f4427","name":"200 OK - Bidirectional","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ..."}],"url":{"raw":"https://your-instance.olt.com/api/v2/acs/{{sn}}/check_bidirectional","host":["https://your-instance.olt.com"],"path":["api","v2","acs","{{sn}}","check_bidirectional"],"query":[{"key":"force","value":"1","description":"Optional. Bypasses the 60s per-device cooldown and always fires a live Connection Request. Omit it to reuse the stored result while the cooldown is active.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": true,\n \"sn\": \"ALCLB0A1C2D3\",\n \"bidirectional\": true,\n \"online\": true,\n \"connection_request\": true,\n \"reason\": null,\n \"cached\": false\n}"},{"id":"1984c55b-3217-4ed4-88b3-bc1fa8b88c0b","name":"200 OK - Connection Request failed","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ..."}],"url":{"raw":"https://your-instance.olt.com/api/v2/acs/{{sn}}/check_bidirectional","host":["https://your-instance.olt.com"],"path":["api","v2","acs","{{sn}}","check_bidirectional"],"query":[{"key":"force","value":"1","description":"Optional. Bypasses the 60s per-device cooldown and always fires a live Connection Request. Omit it to reuse the stored result while the cooldown is active.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": true,\n \"sn\": \"ALCLB0A1C2D3\",\n \"bidirectional\": false,\n \"online\": true,\n \"connection_request\": false,\n \"reason\": \"connection_request_failed\",\n \"cached\": false\n}"},{"id":"502ade60-aaba-4b6f-822b-ac01a3a53ebe","name":"200 OK - Device not sending Informs","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ..."}],"url":{"raw":"https://your-instance.olt.com/api/v2/acs/{{sn}}/check_bidirectional","host":["https://your-instance.olt.com"],"path":["api","v2","acs","{{sn}}","check_bidirectional"],"query":[{"key":"force","value":"1","description":"Optional. Bypasses the 60s per-device cooldown and always fires a live Connection Request. Omit it to reuse the stored result while the cooldown is active.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": true,\n \"sn\": \"ALCLB0A1C2D3\",\n \"bidirectional\": false,\n \"online\": false,\n \"connection_request\": true,\n \"reason\": \"device_offline\",\n \"cached\": false\n}"},{"id":"09f22c9a-e622-48bc-888d-0129abf803c5","name":"200 OK - No Connection Request URL","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ..."}],"url":{"raw":"https://your-instance.olt.com/api/v2/acs/{{sn}}/check_bidirectional","host":["https://your-instance.olt.com"],"path":["api","v2","acs","{{sn}}","check_bidirectional"],"query":[{"key":"force","value":"1","description":"Optional. Bypasses the 60s per-device cooldown and always fires a live Connection Request. Omit it to reuse the stored result while the cooldown is active.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": true,\n \"sn\": \"ALCLB0A1C2D3\",\n \"bidirectional\": false,\n \"online\": true,\n \"connection_request\": false,\n \"reason\": \"no_connection_url\",\n \"cached\": false\n}"},{"id":"3bc84850-1f17-4d11-b073-888368845a91","name":"200 OK - Cached (cooldown active, send force=1 to probe again)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ..."}],"url":{"raw":"https://your-instance.olt.com/api/v2/acs/{{sn}}/check_bidirectional","host":["https://your-instance.olt.com"],"path":["api","v2","acs","{{sn}}","check_bidirectional"],"query":[{"key":"force","value":"1","description":"Optional. Bypasses the 60s per-device cooldown and always fires a live Connection Request. Omit it to reuse the stored result while the cooldown is active.","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": true,\n \"sn\": \"ALCLB0A1C2D3\",\n \"bidirectional\": true,\n \"online\": true,\n \"connection_request\": null,\n \"reason\": null,\n \"cached\": true\n}"},{"id":"a457df04-f23a-4034-ab14-a202cd4a9d4f","name":"400 Bad Request - Device not found","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ..."}],"url":{"raw":"https://your-instance.olt.com/api/v2/acs/{{sn}}/check_bidirectional","host":["https://your-instance.olt.com"],"path":["api","v2","acs","{{sn}}","check_bidirectional"],"query":[{"key":"force","value":"1","description":"Optional. Bypasses the 60s per-device cooldown and always fires a live Connection Request. Omit it to reuse the stored result while the cooldown is active.","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": false,\n \"error\": \"Device not found\"\n}"},{"id":"6c4144aa-ce3d-4c8b-93a9-26e8f9647006","name":"400 Bad Request - ACS module disabled","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ..."}],"url":{"raw":"https://your-instance.olt.com/api/v2/acs/{{sn}}/check_bidirectional","host":["https://your-instance.olt.com"],"path":["api","v2","acs","{{sn}}","check_bidirectional"],"query":[{"key":"force","value":"1","description":"Optional. Bypasses the 60s per-device cooldown and always fires a live Connection Request. Omit it to reuse the stored result while the cooldown is active.","disabled":true}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": false,\n \"error\": \"ACS module is required for ACS endpoints\"\n}"},{"id":"e62b6294-1e7d-4c73-b894-71ed47ed6561","name":"502 Bad Gateway - ACS unreachable","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ..."}],"url":{"raw":"https://your-instance.olt.com/api/v2/acs/{{sn}}/check_bidirectional","host":["https://your-instance.olt.com"],"path":["api","v2","acs","{{sn}}","check_bidirectional"],"query":[{"key":"force","value":"1","description":"Optional. Bypasses the 60s per-device cooldown and always fires a live Connection Request. Omit it to reuse the stored result while the cooldown is active.","disabled":true}]}},"status":"Bad Gateway","code":502,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": false,\n \"error\": \"HTTPConnectionPool(host='acs.example.com', port=80): Read timed out. (read timeout=35)\"\n}"}],"_postman_id":"78429563-115a-42bb-8fa1-5f328b72f35c"}],"id":"71014809-c42f-43b4-b2ba-0affd8fa59a8","description":"Here you will find the main information and instructions to use our TR-069 solution via API.
\nThe base URL for the ACS services API can be obtained internally in the system under the menu Network > TR-069 > Management.
The authentication required for the ACS server endpoints, referred to in the documentation as \"https://your-acs-instance.com\" is done using a token that must be included in the header of requests sent to the 'Set device parameters' and 'Check Response' endpoints. This token is generated internally in the system under the menu Network > TR-069 > Management and must be sent as the \"x-auth-token\" parameter in the request header.
Activates the user identified by {user_id} in the URL, setting is_active to true so the account can authenticate again. No request body is required.
The requester must be allowed to manage the target user. On OLT Cloud installations a non-superuser can only act on users from its own access group; when the user is not found or not within the requester's scope the response is 404 with User not found.
Returns the updated user object on success. If the user is already active the request fails with 400.
Deactivates the user identified by {user_id} in the URL, setting is_active to false so the account can no longer authenticate. No request body is required.
The requester must be allowed to manage the target user; users outside the requester's access group return 404 with User not found.
Deactivation is rejected with 400 when:
User already inactive);Cannot deactivate the current user);Cannot deactivate).Returns the updated user object on success.
\n","urlObject":{"path":["api","v2","users","{user_id}","deactivate"],"host":["https://your-instance.olt.com"],"query":[],"variable":[]}},"response":[{"id":"9e0863ab-8c4f-45ad-adc6-54aac5bd45e3","name":"Deactivate User","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/users/{user_id}/deactivate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": true,\n \"user\": {\n \"id\": 5,\n \"username\": \"noc.operator\",\n \"email\": \"noc.operator@example.com\",\n \"name\": \"NOC Operator\",\n \"is_active\": false,\n \"is_staff\": false,\n \"is_superuser\": false,\n \"date_joined\": \"2025-01-15 09:30:00\",\n \"last_login\": \"2026-06-18 14:22:10\"\n }\n}"},{"id":"7094f54f-7116-4978-8884-7e82de4539ba","name":"User already inactive","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/users/{user_id}/deactivate"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": false,\n \"error\": \"User already inactive\"\n}"},{"id":"033304fe-121c-4ca2-9673-924c4fe6346c","name":"Cannot deactivate current user","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/users/{user_id}/deactivate"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": false,\n \"error\": \"Cannot deactivate the current user\"\n}"},{"id":"5d2ea3d2-ec57-46fc-8a4b-a239bab03a5e","name":"Cannot deactivate staff or superuser","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/users/{user_id}/deactivate"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": false,\n \"error\": \"Cannot deactivate\"\n}"},{"id":"a58a53fc-45d4-471f-8c2e-93e143352362","name":"User not found","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/users/{user_id}/deactivate"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"return\": false,\n \"error\": \"User not found\"\n}"},{"id":"3d334a9b-79bc-4ea6-bc40-2076f65f97bc","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/users/{user_id}/deactivate"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"Authentication credentials were not provided.\"\n}"}],"_postman_id":"f943beae-5028-4748-8b73-958620f178d2"},{"name":"List Users","id":"243fe4b9-769d-4963-95be-2f6f46592e21","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ...","type":"text"}],"url":"https://your-instance.olt.com/api/v2/users","description":"Returns the list of platform users visible to the authenticated user.
\nOLT Cloud internal superusers are never included. On OLT Cloud installations, a non-superuser only sees users that belong to the same access group (grupo de acesso), unless the requester's group is allowed to manage all companies. A superuser sees every user.
This endpoint is not paginated: all visible users are returned in a single users array ordered by id.
Each user object contains:
\nid - numeric user identifier.username - login name.email - user email.name - display name (first name).is_active - whether the user can authenticate.is_staff - whether the user has staff privileges.is_superuser - whether the user has superuser privileges.date_joined - account creation timestamp (YYYY-MM-DD HH:MM:SS).last_login - last successful login timestamp (YYYY-MM-DD HH:MM:SS), or null if the user never logged in.Public endpoint to verify that the application is up and able to reach its core dependencies (database and Redis). Intended for load balancers, uptime monitors, or manual checks.
\nReturns 200 OK when the application and all dependencies are healthy, or 503 Service Unavailable when any dependency is down. The body always reports the status of each component individually.
\nField reference
\nRate limiting
\nTo protect the database, this endpoint is rate limited per client IP (default: 60 requests per minute). Requests over the limit receive 429 Too Many Requests before any dependency is queried.
\n","urlObject":{"path":["api","health"],"host":["https://your-instance.olt.com"],"query":[],"variable":[]}},"response":[{"id":"beeb896e-89ab-45cc-bbb0-c503c326685d","name":"Health check - 200","originalRequest":{"method":"GET","header":[],"url":"https://your-instance.olt.com/api/health"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"status\": \"ok\",\n \"checks\": {\n \"database\": \"ok\",\n \"redis\": \"ok\"\n }\n}"},{"id":"1cd21c77-24a6-43be-88d7-a263d0e88068","name":"Health check - 503 Service Unavailable","originalRequest":{"method":"GET","header":[],"url":"https://your-instance.olt.com/api/health"},"status":"Service Unavailable","code":503,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"checks\": {\n \"database\": \"ok\",\n \"redis\": \"error\"\n }\n}\n"},{"id":"d821a90d-0337-41c5-8668-2404c3daa496","name":"Health check - 429 Too Many Requests","originalRequest":{"method":"GET","header":[],"url":"https://your-instance.olt.com/api/health"},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"detail\": \"Request was throttled. Expected available in 60 seconds.\"\n}"}],"_postman_id":"29b2b862-7f0d-470b-8ffa-9b45baea2589"}],"id":"34729ffa-e0e9-4d58-98dc-6036d107bbfd","_postman_id":"34729ffa-e0e9-4d58-98dc-6036d107bbfd","description":""}],"event":[{"listen":"prerequest","script":{"id":"2c6a5434-e739-4b2a-89ee-2d7845760009","type":"text/javascript","requests":{},"exec":[""]}},{"listen":"test","script":{"id":"66eb74c5-9fb9-4d3c-914f-e9a43f5eacfa","type":"text/javascript","requests":{},"exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://your-instance.olt.com"},{"key":"username","value":"user"},{"key":"password","value":"password"},{"key":"token","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ..."},{"key":"refreshToken","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ..."},{"key":"clientID","value":"1"},{"key":"boxID","value":"100"},{"key":"onuID","value":"1000"}]}