{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"e08a1983-324c-4326-9de2-0688c13d9958","name":"Mosaic CP API Guide","description":"## Introduction\n\nThis guide describes the process of Operations Support System (OSS) provisioning of the ADTRAN® Mosaic Cloud Platform (Mosaic CP). An OSS consists of application(s) software that operates within a carrier’s management network and allows their systems to perform network management functions for a variety of operational support systems. This guide provides a dictionary of supported Application Programming Interface (API) commands used to complete Mosaic CP provisioning.\n\nThe Mosaic CP RESTCONF Northbound Interface (NBI) provides a programmable interface between the OSS and the associated network elements. Integration with the Mosaic CP API provides operators with a consistent and repeatable command structure across a multitude of deployment architectures.\n\nThe figure below illustrates the interactions between the OSS and Mosaic CP. The network elements will vary according to the deployment.\n\n<img src=\"https://i.ibb.co/VC9F1tD/Screen-Shot-2020-12-17-at-5-47-55-PM.png\">\n\nThe main sections that make up this guide are as follows:\n\n- **Administration**: covers tasks expected to be performed by an administrator, such as how to get an API token, add/remove users, reset passwords, add device credentials, setup policies and more.\n    \n- **Events**: covers APIs to retrieve events from the system and forward events to external systems such as a Kafka listener.\n    \n- **Jobs**: using Mosaic CP to create, run, and check the status of jobs.\n    \n- **Platform Details**: get the status of Mosaic CP as well as information about software versions and enabled features.\n    \n- **Orchestration Objects**: this section covers using Mosaic CP as an SDN orchestrator.\n    \n- **Search and Filter**: how to search for objects on the system and filter those searches based on various attributes of those objects.\n    \n\n## Updates\n\n### 22.9\n\n- Added APIs for SPD feature under Orchestration Objects.\n    \n\n### 22.8\n\n- Added Api for Removing Vlan Name Profile under Orchestration Objects > Profiles > Vlan Name Profile\n    \n- Added Api for Clearing Vlan Name setting under Administration > Admin Settings > VLAN Name Settings.\n    \n\n### 22.7\n\n- Added APIs for Autonaming Devices and Services functionality under Orchestration Objects > Autonaming API\n    \n- Added APIs for the Alarm Overload Protection feature under Platform Details > Clear Overload Alarm\n    \n- Added \"Get Inventory Tree for Short Name Interface\" and \"Get Inventory Tree for Short Name Device\" APIs under Orchestration Objects > Inventory > Get Inventory Tree. These APIs are for the Shorter names for object in Inventory Tree feature.\n    \n- Added APIs for Single Sign On functionality under Administration > Single Sign On\n    \n\n### 22.2\n\n- Added \"Job Run - Reboot Device\"\n    \n- Deleted \"Query Interface Inspect Inventory-status\" and \"Query Device Insepct Inventory-status\" in favor of modeled inspect\n    \n- Updated the response body for \"Run Job - Reflow Interface\"\n    \n- Added an example request \"Run Job with Parameters - Backup Device Configuration\"\n    \n- Added an example request \"Job Run with Parameters - Restore Device Configuration\"\n    \n- Added an example request \"Job Run - Resynchronize NETCONF Alarms Job\"\n    \n- Added an example request \"Run Job - Ethernet Loopback\"\n    \n\n### 21.1\n\n- Added Orchestration API support for the Content Provider and Bundle Objects. This allows for these objects to be activated in a single API call without having to perform configure, deploy, activate actions.\n    \n\n### 21.2\n\n- Added secure credential flag (set to false by default). To enable it, create/edit user.conf and set com.adtran.firefly.firefly-aaa.secure-credentials=true. This flag will be enabled by default in 21.3.\n    \n- Added an additional permission called read-hidden-adtn-cld-pfrm-crdls (given to admins by default). When the secure credential flag is enabled and the user has this permission the user is able to see the password/key of an existing credential in plain text from the API. If the user does not have this permission a fixed number of asterisks will be returned for the password/key of the credential.\n    \n\n### 21.4\n\n- Added support to Configure Device with IPv6 or IPv4\n    \n- Added Modeled-Inspect support for Provisioning and Deleting Objects, and Inspecting an Interface or Device\n    \n- Added support to Get all Compatible Model Names based on a requested model name\n    \n\n### 21.5\n\n- Updated Get Users and Get All Users with user-type\n    \n- Added Modeled-Inspect Query Depth support for Interfaces and Devices","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":true,"owner":"2389999","collectionId":"e08a1983-324c-4326-9de2-0688c13d9958","publishedId":"TVsrGVaa","public":true,"publicUrl":"https://documenter-api.postman.tech/view/2389999/TVsrGVaa","privateUrl":"https://go.postman.co/documentation/2389999-e08a1983-324c-4326-9de2-0688c13d9958","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.1","publishDate":"2024-10-04T06:45:18.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[{"name":"API Guide Public Environment","id":"44886c73-b22a-44d0-9828-abe3754158ec","owner":"29093391","values":[{"key":"mcp-address","value":"mcp-ip-or-domain-name","enabled":true,"type":"default"},{"key":"basic-auth-username","value":"ADMIN","enabled":true,"type":"default"},{"key":"basic-auth-password","value":"P@ssw0rd","enabled":true,"type":"default"},{"key":"poll-time-ms","value":"500","enabled":true,"type":"default"},{"key":"max_response_time_ms","value":"10000","enabled":true,"type":"default"},{"key":"api_test_type","value":"","enabled":true,"type":"default"},{"key":"compareCode","value":"","enabled":true,"type":"default"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/7e3146b64664b501b540d3513919b7d528bd21c5326c0e4df136280f669e3da6","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"API Guide Public Environment","value":"29093391-44886c73-b22a-44d0-9828-abe3754158ec"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/TVsrGVaa"}