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.oltcloud.co/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
\nIf no operator is specified, the search will be done by proximity.
\nBy 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.oltcloud.co/api/token","urlObject":{"path":["api","token"],"host":["https://your-instance.oltcloud.co"],"query":[],"variable":[]}},"response":[{"id":"051e863a-3aa6-4827-a13b-e1cb26e9004b","name":"GET Token","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"username\": \"user\",\n \"password\": \"password\"\n}\n","options":{"raw":{"language":"json"}}},"url":"https://your-instance.oltcloud.co/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.oltcloud.co/api/token/refresh","urlObject":{"path":["api","token","refresh"],"host":["https://your-instance.oltcloud.co"],"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.oltcloud.co/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.oltcloud.co/api/v2/client/list","protocol":"https","host":["your-instance","oltcloud","co"],"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.oltcloud.co/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.oltcloud.co/api/v2/company/list","urlObject":{"path":["api","v2","company","list"],"host":["https://your-instance.oltcloud.co"],"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.oltcloud.co/api/v2/plan/list","urlObject":{"path":["api","v2","plan","list"],"host":["https://your-instance.oltcloud.co"],"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.oltcloud.co/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.oltcloud.co/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.oltcloud.co"],"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.oltcloud.co/api/v2/client/device_alert?id=55789","host":["https://your-instance.oltcloud.co"],"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.oltcloud.co/api/v2/box/{box_id}","urlObject":{"path":["api","v2","box","{box_id}"],"host":["https://your-instance.oltcloud.co"],"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.oltcloud.co/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.oltcloud.co/api/v2/box/list","urlObject":{"path":["api","v2","box","list"],"host":["https://your-instance.oltcloud.co"],"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":"OLT linked to the service box/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":["OLT linked to the service box"],"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.oltcloud.co/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.oltcloud.co/api/v2/box/create","description":"Required fields:
\nname
\nports
\ncoordinates
\nstatus: 0 = Enable; 1 = Projected
\nOptional fields:
\nolt_id
\nolt_external_id
\nslot
\npon
\ninitial_rx
\nstreet
\nnumber
\nneighborhood
\ncity
\nstate
\nzip_code
\naddress_reference
\ndescription
\nexternal_id
\n\n\n","urlObject":{"path":["api","v2","box","create"],"host":["https://your-instance.oltcloud.co"],"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.oltcloud.co/api/v2/box/{box_id}","description":"The \"olt_id\" field refers to the internal ID of the OLT within the system. The IDs can be obtained from the existing OLTs listing endpoint in the \"FTTH > OLTs\" module. It is also possible to use the external OLT ID from your main ERP system by utilizing the \"olt_external_id\" field. For this, it is necessary that the \"External ID\" field in the OLT registration in the system has been filled with the internal OLT ID from your ERP.
\n
Required fields:
\nname
\nports
\ncoordinates
\nstatus: 0 = Enable; 1 = Projected
\nOptional fields:
\nolt_id
\nolt_external_id
\nslot
\npon
\ninitial_rx
\nstreet
\nnumber
\nneighborhood
\ncity
\nstate
\nzip_code
\naddress_reference
\ndescription
\nexternal_id
\n\n\n","urlObject":{"path":["api","v2","box","{box_id}"],"host":["https://your-instance.oltcloud.co"],"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.oltcloud.co/api/v2/box/availability","description":"The \"olt_id\" field refers to the internal ID of the OLT within the system. The IDs can be obtained from the existing OLTs listing endpoint in the \"FTTH > OLTs\" module. It is also possible to use the external OLT ID from your main ERP system by utilizing the \"olt_external_id\" field. For this, it is necessary that the \"External ID\" field in the OLT registration in the system has been filled with the internal OLT ID from your ERP.
\n
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.oltcloud.co"],"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.oltcloud.co/api/v2/box/availability?lat=-26.18375287156119&lng=-48.61538034832132&radius=1000","protocol":"https","host":["your-instance","oltcloud","co"],"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.oltcloud.co/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.oltcloud.co"],"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.oltcloud.co/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.oltcloud.co/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.oltcloud.co"],"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.oltcloud.co/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.oltcloud.co/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.oltcloud.co"],"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.oltcloud.co/api/v2/ftth/alert/list","host":["https://your-instance.oltcloud.co"],"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.oltcloud.co/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.oltcloud.co"],"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.oltcloud.co/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.oltcloud.co/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.oltcloud.co"],"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.oltcloud.co/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.oltcloud.co/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.oltcloud.co"],"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.oltcloud.co/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.oltcloud.co"],"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.oltcloud.co/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":"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.oltcloud.co/api/v2/ftth/equipment/{id}","description":"\n\n","urlObject":{"path":["api","v2","ftth","equipment","{id}"],"host":["https://your-instance.oltcloud.co"],"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.oltcloud.co/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.oltcloud.co/api/v2/ftth/equipment/list","urlObject":{"path":["api","v2","ftth","equipment","list"],"host":["https://your-instance.oltcloud.co"],"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.oltcloud.co/api/v2/ftth/equipment/list","protocol":"https","host":["your-instance","oltcloud","co"],"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.oltcloud.co/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.oltcloud.co/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.oltcloud.co"],"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.oltcloud.co/api/v2/ftth/pons?olt_id=123&slot=1","host":["https://your-instance.oltcloud.co"],"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.oltcloud.co/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.oltcloud.co"],"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.oltcloud.co/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.oltcloud.co/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.oltcloud.co"],"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.oltcloud.co/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.oltcloud.co/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.oltcloud.co"],"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.oltcloud.co/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.oltcloud.co/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.oltcloud.co"],"query":[],"variable":[]}},"response":[{"id":"262fed0e-99c5-43d8-ae0f-40a474e7ab94","name":"Enable/Disable ONU","originalRequest":{"method":"POST","header":[],"url":"https://your-instance.oltcloud.co/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.oltcloud.co/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.oltcloud.co"],"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.oltcloud.co/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.oltcloud.co/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.oltcloud.co"],"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.oltcloud.co/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.oltcloud.co/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.oltcloud.co"],"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\nThis endpoint returns a list of isolated attenuations detected by the OLT Cloud system.
\nAn isolated attenuation occurs when an ONU shows an optical signal level that is significantly lower than the average level of its PON or CTO, indicating a possible fiber degradation, loose connection, or individual customer issue.
\nThe list is paginated and provides detailed information for each ONU, including optical power values received by the ONU (rx_onu) and by the OLT (rx_olt), as well as average reference levels for the corresponding PON and CTO.
This endpoint returns the PONs identified by the system as attenuated, based on the monitoring rules and optical power thresholds configured in the platform.
\nThe result is paginated and, for each PON, includes information about the associated OLT, the total number of ONUs, the average optical receive levels, and the distribution of warning and critical alarms both from the ONU and OLT perspectives.
\n","urlObject":{"path":["api","v2","ftth","pons","attenuations"],"host":["https://your-instance.oltcloud.co"],"query":[],"variable":[]}},"response":[{"id":"40e10a59-76a1-406a-aeaa-8dde0d26977d","name":"LIST PON Attenuations","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.oltcloud.co/api/v2/ftth/pons/attenuations?id=1060","host":["https://your-instance.oltcloud.co"],"path":["api","v2","ftth","pons","attenuations"],"query":[{"key":"id","value":"1060"}]}},"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 \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": 1060,\n \"description\": null,\n \"observations\": null,\n \"olt_id\": 63,\n \"olt_name\": \"OLT Taruca\",\n \"onu_count\": 51,\n \"avg_rx_onu\": -20.99,\n \"avg_rx_pon\": -25.73,\n \"rx_onu_warning_count\": 3,\n \"rx_onu_warning_percent\": 6.0,\n \"rx_onu_critical_count\": 0,\n \"rx_onu_critical_percent\": 0.0,\n \"rx_olt_warning_count\": 30,\n \"rx_olt_warning_percent\": 59.0,\n \"rx_olt_critical_count\": 3,\n \"rx_olt_critical_percent\": 6.0,\n \"slot/pon\": \"0/4\"\n }\n ]\n}"}],"_postman_id":"4fc3ae82-d168-450d-b3ca-bd18edbb3485"},{"name":"LIST CTO Attenuations","id":"652a22b9-ce59-424d-a004-dd17e7cb8077","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.oltcloud.co/api/v2/box/attenuations","description":"This endpoint returns the CTOs identified by the system as attenuated, based on the monitoring rules and optical power thresholds configured in the platform.
\nThe result is paginated and, for each CTO, includes information about the associated OLT and PON, the total number of ONUs connected to that box, the average optical receive levels, and the distribution of warning and critical states, both from the ONU perspective and from the readings performed on the OLT.
\n","urlObject":{"path":["api","v2","box","attenuations"],"host":["https://your-instance.oltcloud.co"],"query":[],"variable":[]}},"response":[{"id":"c5df64af-5e12-4b2b-9391-bbc5b6226f41","name":"LIST CTO Attenuations","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.oltcloud.co/api/v2/box/attenuations?id=300","host":["https://your-instance.oltcloud.co"],"path":["api","v2","box","attenuations"],"query":[{"key":"id","value":"300"}]}},"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 \"count\": 1,\n \"next\": null,\n \"previous\": null,\n \"results\": [\n {\n \"id\": 300,\n \"name\": \"FNE 08 E7\",\n \"observations\": null,\n \"olt_id\": 31,\n \"olt_name\": \"MOL-OLT-ZTE\",\n \"onu_count\": 2,\n \"avg_rx_onu\": -18.76,\n \"avg_rx_cto\": -21.33,\n \"rx_onu_warning_count\": 0,\n \"rx_onu_warning_percent\": 0.0,\n \"rx_onu_critical_count\": 0,\n \"rx_onu_critical_percent\": 0.0,\n \"rx_olt_warning_count\": 1,\n \"rx_olt_warning_percent\": 50.0,\n \"rx_olt_critical_count\": 0,\n \"rx_olt_critical_percent\": 0.0,\n \"pon_id\": 741,\n \"slot/pon\": \"2/15\"\n }\n ]\n}\n"}],"_postman_id":"652a22b9-ce59-424d-a004-dd17e7cb8077"},{"name":"Add tag to equipment","id":"49ff3d14-5626-4c29-b0ca-4c51029e953c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"tag\": \"priority\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://your-instance.oltcloud.co/api/v2/ftth/equipment/{id}/tags","description":"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.oltcloud.co"],"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.oltcloud.co/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.oltcloud.co/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.oltcloud.co"],"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.oltcloud.co/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.oltcloud.co/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.oltcloud.co/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.oltcloud.co/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.oltcloud.co/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).
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.oltcloud.co"],"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.oltcloud.co/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.oltcloud.co/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.oltcloud.co/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.oltcloud.co"],"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.oltcloud.co/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.oltcloud.co/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.oltcloud.co"],"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.oltcloud.co/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.oltcloud.co/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
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.