Netbrain REST API Documentation

Version 11.1a
To view details about integration workflows with other platforms, view "Platform Integration Documentation". These include workflows like Trigger Diagnosis where NetBrain is triggered from ticketing and monitoring tools to generate map URLs. Integration Workflows also incliudes 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, see "Golden Use Case Templates".
To see the list of all REST APIs view "REST APIs Documentation".

New APIs in this version

1. TAF (Triggered Automation Framework)
   
2. API Server Management-Get All API Servers Configured in Domain.md
   
3. Tenants and Domains Management-Update License info on each API
   
4. AWS Account Management
   
5. Authentication and Authorization-Get All Accessible Domains API
   
6. Authentication and Authorization-Get All Accessible Tenants API
   
7. Device Group Management-Add Device Group
   
8. Devices Management-Get Device Group API
   
9. Devices Management-Get Group Devices API
   
10. Shared Device Setting Management-To support 11 separate locks.
    

Section 1) Golden Use Case Templates

1. Get Path Detail Information 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 Embed Map

Section 2) REST APIs Documentation

API Server Management

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
   

Audit Logs

1. Audit Logs REST API Design
   

Authentication and Authorization

1. Login API
   
2. Get All Accessible Tenants API
   
3. Get All Accessible Domains API
   
4. Specify A Working Domain API
   
5. Logout API
6. Get Product Version API
   

Benchmark Task Management

1. Add Benchmark Task API
   
2. Delete Benchmark Task API
   
3. Get Benchmark Task Runs API
   
4. Get Benchmark Task Status API
   
5. Run Benchmark Task Now API
   
6. Update Benchmark Task API

Change Analysis Report

1. Create Export Task For Change Analysis Report API
   
2. Check Export Task Status API
   
3. Download Change Analysis Report API

Devices Access Control

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 Policis 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
   

Device Group Management

1. Add Device Group API
   
2. Add devices to Group API
   
3. Delete Device Group API
   
4. Delete devices from Group API
   
5. Get devices of Group API
   
6. Get Device Groups API
   

Device Interfaces Management

1. Create Interface Attribute API
   
2. Delete Interface Attribute API
   
3. Get All Interfaces of A Device API
   
4. Get Connected Switch Port API
   
5. Get Interface Attributes API
   
6. Set Interface Attributes API

Devices Management

1. Create Devices Attribute API
   
2. Delete Devices Attribute API
   
3. Delete Devices API
   
4. Get Device Attributes API
   
5. Get Device API
   
6. Get Front Server of A Device API
   
7. Get Group Devices API
   
8. Set Device Attribute API
   
9. Get Device Configuration API
   
10. Get the connected switch ports of an end system API
    
11. Get Device Raw Data API
    
12. Get Device API Version_1
    
13. Modify NetBrain API Server Credential API

Discovery Task Management

1. Create Schedule Discovery Task API
   
2. Edit Scheduled Discovery Task API
   
3. Delete Scheduled Discovery Task AP
   
4. Add Seed IPs to Discovery Task API
   
5. Delete Seed IPs to 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

Map Management

1. Delete Map API
   
2. Export Map API
3. Get Files List API

Module Management

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

Network Setting

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

Path Management

1. Resolve Device Gateway API
   
2. Calculate Path API
   
3. Get Path Calculation Result API
4. Stop A PAth API

User Roles Management

1. Add Role API
   
2. Delete Role API
   
3. Update Role API
4. Get Role Information API

Site Management

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

Shared Device Setting Management

1. Get device API server settings API
   
2. Get device CLI 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
   

TAF (Triggered Automation Framework)

1. Create IT System Data Model API
2. Auto Trigger API
3. Get Trigger Result API
4. Get Trigger Diagnosis Definition API
5. Manually Trigger API
6. Update Incident Message API
7. Get Temporary Incident Portal Access Token API
8. Verify User Permission API

Tenants and Domains Management

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. Update Domain API
   
9. Update Tenant API
   
10. License Node Information API
    
11. Get Domain License Template
    
12. Get Tenant License Template
    

Topology Management

1. Build L2 Topology API
   
2. Build L3 Topology API
   
3. Get Connected Switch Port API
   
4. Get Device Neighbors by Topology Type API
   
5. Get Topology Build Task Status API
6. Get One Ip Table API
7. Get Device Neighbors by Topology Type API Version_1
8. Get Connected Switch Port API
   

Trigger Diagnosis API

1. Map Device and Its Neighbors
2. Open Site Map of The Device
3. Trigger An Existing Map
4. Map A Path
5. Open Map by Qapp
6. Open Multi devices map
7. Open Empty Map
8. Context Map Of Cisco ACI Device
9. Context Map Of Legacy Device
10. Entire Trigger API Variables

User Management

1. Add User API
   
2. Delete User API
   
3. Get Usage Report of Users API
   
4. Get Detail Usage Report of Users API
   
5. Update User API
   
6. Get Users API
7. Sync AD & LADP Users API

Event Console Management

1. Get Event Console API
   
2. Acknowledge/close Event Alert API
   
3. Delete Event Alert API
   

Change Ticket Management

1. Binding 3rd Party Ticket with Runbook API
   
2. Approve Change Management Request API

Change Ticket Management Scheduled Task

1. Create Change Management Scheduled Task REST API
   
2. Get Change Management Scheduled Task REST API
   
3. Update Change Management Scheduled Task REST API
   
4. Delete Change Management Scheduled Task REST API
   

Tune Devices Access

1. Create Tune Devices Access Task ID API
   
2. Get Tune Devices Access Task Result API
   

Event Trigger API Design

1. Create triggered event API
   
2. Get triggered event running status API
   

Audit Logs Design

1. Audit Logs API