Skip to content

NetBrainAPI/NetBrain-REST-API-R12.1

Repository files navigation

Netbrain REST API Documentation

Version 12.1
To view details about Integration Workflows with other platforms, please refer to Platform Integration Documentation. Integration Workflow includes workflows such as Trigger Diagnosis, where NetBrain is triggered from ticketing and monitoring tools to generate map URLs, and Single Panel of Glass, where data from ticketing and monitoring tools is overalyed on NetBrain Map.
To view details about use cases which can be implemented with NetBrain REST APIs, please refer to Golden Use Case Templates.
To view the full list of all REST APIs, please refer to REST APIs Documentation.

New APIs in this version

  1. Login API (Updated methods)
  2. Get Device's Current Baseline Data Table
  3. Update CLI Login Credential API
  4. ADT (Automation Data Table) APIs
  5. AAM (Application Assurance Module) APIs
  6. Data Center Operation APIs

Section 1) Golden Use Case Templates

  1. Get Path By Calling APIs
  2. Sites Management by Calling APIs
  3. Calling Trigger Diagnosis API
  4. Discovery and Devices Management by Calling APIs
  5. CMDB Synchronized by Calling APIs
  6. Logic of API Calling for Embeded Map

Section 2) REST APIs Documentation

  1. Add Multiple Application Paths in Batches
  2. Add Path to Application
  3. Create New Application
  4. Delete Application Path
  5. Delete Application
  6. Delete Batches of Application Paths
  7. Get AAM Report
  8. Get Application Information
  9. Get Path Information
  10. Update Application Path
  11. Update Application
  1. Add Columns to ADT Table
  2. Add Rows to ADT Table
  3. Create New ADT Table
  4. Delete ADT Table
  5. Delete Columns of ADT Table
  6. Delete Rows of ADT Table
  7. Get ADT Table
  8. Lock ADT Table
  9. Unlock ADT Table
  10. Update Rows of ADT Table
  1. Delete Tech Instance API
  2. Get All API Servers Configured in Domain API
  3. Update API Server Credential API
  4. AWS Account Management-Add AWS Account API
  5. AWS Account Management-Delete AWS Account API
  6. AWS Account Management-Get AWS Account API
  7. AWS Account Management-Get AWS Accounts API
  8. AWS Account Management-Patch AWS Account API
  9. Azure Account Management-Get Azure Accounts
  10. Azure Account Management-Patch Azure Account
  1. Audit Logs REST API Design
  1. Get Product Version API
  2. Login API
  3. Logout API
  4. Specify A Working Domain API
  1. Add Benchmark Task API
  2. Delete Benchmark Task API
  3. Get Benchmark Run Result Device Details API
  4. Get Benchmark Run Device List by Filter API
  5. Get Benchmark Task Runs API
  6. Get Benchmark Task Status API
  7. Run Benchmark Task Now API
  8. Update Benchmark Task API
  1. Check Export Task Status API
  2. Create Export Task For Change Analysis Report API
  3. Download Change Analysis Report API
  4. Change Analysis Report Sample Code
  1. Create Change Management Scheduled Task API
  2. Delete Change Management Scheduled Task API
  3. Get Change Management Scheduled Task API
  4. Update Change Management Scheduled Task API
  5. _Change Management Approval Process API Design - Binding Runbook
  6. _Change Management Approval Process API Design - Change State
  1. Migrate Tenants to New FSC
  2. Switch Data Center Status
  3. Transfer Tenants from One FSC to Another

Note: If customer want to use the Devices Access Control APIs, please go to the System Management -> Advanced Settings -> Device Access Policy then check the "Enable device access policy".

  1. Add Device Access Policy API
  2. Assign Device Access Policies to User API
  3. Delete Device Access Policy API
  4. Get Device Access Policies API
  5. Get User Device Access Policy API
  6. Get Users of One Device Access Policy API
  7. Remove Device Access Policies from User API
  8. Set User Device Access Policy API
  9. Update Device Access Policy API
  1. Add Device Group API
  2. Add Devices to Group API
  3. Delete Device Group API
  4. Delete Devices from Group API
  5. Get Device Group API
  6. Get Devices of Group API
  1. Create Interface Attribute API
  2. Delete Interface Attribute API
  3. Get All Interfaces of A Device API
  4. Get Interface Attributes API
  5. Set Interface Attributes API
  1. Create Devices Attribute API

  2. Delete Devices API

  3. Delete Devices Attribute API

  4. Get Connected Switch Ports of an End System API

  5. Get Device Attributes API

  6. Get Device Configuration API

  7. Get Device Raw Data API

  8. Get Device's Current Baseline Data Table

  9. Get Devices API

  10. Get Front Server of A Device API

  11. Get Group Devices API

  12. Modify NetBrain API Server Credential API

  13. Set Device Attribute API

  1. Add Seed IPs to Discovery Task API
  2. Create Schedule Discovery Task API
  3. Delete Scheduled Discovery Task AP
  4. Delete Seed IPs to Discovery Task API
  5. Edit Scheduled Discovery Task API
  6. Get All Discovery Tasks API
  7. Get All Seed IPs from Discovery Task API
  8. Get Discovery Task Live Access Log API
  9. Get Discovery Tasks Result API
  10. Get Discovery Tasks Status API
  11. Run Discovery Task Now API
  1. Acknowledge/close Event Alert API
  2. Delete Event Alert API
  3. Get Event Console API
  1. Create Triggered Event API
  2. Get Triggered Event Status API
  3. Event Template Sample Code
  1. Export API Triggered Task Report API
  1. Delete Map API
  2. Export Map API
  1. Applicable Module Attributes Table
  2. Create Module Attribute API
  3. Delete Module Attribute API
  4. Get All Modules of A Device API
  5. Get Module Attributes API
  6. Set Module Attributes API
  1. Add Network Settings API
  2. Delete Network Settings API
  3. Get Check Device Count in Network Setting API
  4. Get Devices of a Network Setting API
  5. Get Network Settings API
  6. Update Device Count in Network Setting API
  7. Update Network Settings API
  1. Get Saved Paths
  1. Calculate Path API
  2. Get Path Calculation Result API
  3. Get Path Calculation Status API
  4. Path Calculation API
  5. Resolve Device Gateway API
  6. Stop A Path API
  1. Get Search Results API
  1. Get Device API Server Settings API
  2. Get Device CLI Server Settings API
  3. Get Device SNMP Settings API
  4. Get Shared Device Settings API
  5. Update Device API Server Settings API
  6. Update Device CLI Settings API
  7. Update Device SNMP Settings API
  8. Update Device Basic Settings API
  1. Add Site Devices API
  2. Commit Site Transaction API
  3. Create A Leaf Site API
  4. Create A Parent Site API
  5. Create A Site Transaction API
  6. Create Dynamic Search API
  7. Create Site API
  8. Delete A Site API
  9. Delete Site Devices API
  10. Get Child Site API
  11. Get Site Devices API
  12. Get Site Info API
  13. Get Site Properties API
  14. Remove Site Transaction API
  15. Replace Site Devices API
  16. Site Transaction Heartbeat API
  17. Update Site Properties API
  1. 1 - Create IT System Data Model API
  2. 2 - Auto Trigger API
  3. 3 - Get Trigger Result API
  4. 4 - Get Trigger Diagnosis Definition API
  5. 5 - Manually Trigger API
  6. 6 - Update Incident Message API
  7. 7 - Get Temporary Incident Portal Access Token API
  8. 8 - Verify User Permission API
  9. 9 - Run Diagnosis API
  10. TAF User Guide
  1. 1 - Trigger Run Task API
  2. 2 - Get Running Status of Trigger Task and Running ResultID of NI API
  3. 3 - Get NI running results of Trigger Task API
  4. 4 - Get ADT Data API
  5. 5 - Download API
  6. 6 - Get the Latest Execution Results from NI API
  1. Add Domain API
  2. Add Tenant API
  3. Assign Users to Domain API
  4. Assign Users to Tenant API
  5. Delete Domain API
  6. Delete Tenant API
  7. Delete Users From Domain API
  8. Get All Accessible Domains API
  9. Get All Accessible Tenants API
  10. Get Domain License Template
  11. Get Domain License Usage Summary API
  12. Get Tenant License Template
  13. License Node Information API
  14. Share Tenant Automation Resources
  15. Update Domain API
  16. Update Tenant API
  1. Build L2 Topology API
  2. Build L3 Topology API
  3. Get Connected Switch Port API
  4. Get Device Neighbors by Topology Type API Version_1
  5. Get Device Neighbors by Topology Type API
  6. Get One IP Table API
  7. Get Topology Build Task Status API
  1. Open Context Map Of Cisco ACI Device
  2. Open Context Map Of Legacy Device
  3. Open Device and Neighbor Map
  4. Open Empty Map
  5. Open Existing Map
  6. Open Map by Qapp
  7. Open Multi Devices Map
  8. Open Path Map
  9. Open Site Map
  10. Trigger Qapp Create Map
  11. Trigget Well-Known Map
  12. Trigger Input Parameter For Verify Application Node
  13. Trigger by Qapp
  1. Create Tune Devices Access Task ID API
  2. Get Tune Devices Access Task Result API
  1. Add User API
  2. Delete User API
  3. Get Detail Usage Report of Users API
  4. Get Usage Report of Users API
  5. Get Users API
  6. Sync AD & LADP Users API
  7. Update User API
  1. Add Role API
  2. Delete Role API
  3. Get Role Information API
  4. Update Role API

  1. Get File List API

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors