REST API for Unified Assurance Core

All REST Endpoints

AAA/Authentication Types

Use for managing authentication types.

Get an Authentication Type by ID: Method: get
Path: /api/AAA/AuthTypes/{id}
Get Authentication Types: Method: get
Path: /api/AAA/AuthTypes
Get Authentication Types for Combo Boxes and Item Selectors: Method: get
Path: /api/AAA/AuthTypes/readForSelect
Update an Authentication Type: Method: put
Path: /api/AAA/AuthTypes/{id}

AAA/Permissions

Use for managing permissions, primarily for custom packages. Roles are assigned permissions so the related groups and users can access the UIs and APIs.

Get a Permission by ID: Method: get
Path: /api/AAA/Permissions/{id}
Get Permissions: Method: get
Path: /api/AAA/Permissions
Get Permissions for Combo Boxes and Item Selectors: Method: get
Path: /api/AAA/Permissions/readForSelect

AAA/Preferences

Use for managing preferences assigned to users or user groups. Preferences typically handle default settings like theme or page size.

Create a Preference: Method: post
Path: /api/AAA/Preferences
Delete a Preference: Method: delete
Path: /api/AAA/Preferences/{id}
Get a Preference by ID: Method: get
Path: /api/AAA/Preferences/{id}
Get Preferences: Method: get
Path: /api/AAA/Preferences
Get Preferences for Combo Boxes and Item Selectors: Method: get
Path: /api/AAA/Preferences/readForSelect
Update a Preference: Method: put
Path: /api/AAA/Preferences/{id}

AAA/Roles

Use for managing roles.

Create a Role: Method: post
Path: /api/AAA/Roles
Delete a Role: Method: delete
Path: /api/AAA/Roles/{id}
Get a Role by ID: Method: get
Path: /api/AAA/Roles/{id}
Get Roles: Method: get
Path: /api/AAA/Roles
Get Roles for Combo Boxes and Item Selectors: Method: get
Path: /api/AAA/Roles/readForSelect
Update a Role: Method: put
Path: /api/AAA/Roles/{id}

AAA/User Group Properties

Use for managing user group properties.

Create a User Group Property: Method: post
Path: /api/AAA/UserGroupProperties
Delete a User Group Property: Method: delete
Path: /api/AAA/UserGroupProperties/{id}
Get a User Group Property by ID: Method: get
Path: /api/AAA/UserGroupProperties/{id}
Get User Group Properties: Method: get
Path: /api/AAA/UserGroupProperties
Get User Group Properties for Combo Boxes and Item Selectors: Method: get
Path: /api/AAA/UserGroupProperties/readForSelect
Update a User Group Property: Method: put
Path: /api/AAA/UserGroupProperties/{id}

AAA/User Groups

Use for managing user groups.

Create a User Group: Method: post
Path: /api/AAA/UserGroups
Delete a User Group: Method: delete
Path: /api/AAA/UserGroups/{id}
Get a User Group by ID: Method: get
Path: /api/AAA/UserGroups/{id}
Get User Groups: Method: get
Path: /api/AAA/UserGroups
Get User Groups for Combo Boxes and Item Selectors: Method: get
Path: /api/AAA/UserGroups/readForSelect
Update a User Group: Method: put
Path: /api/AAA/UserGroups/{id}

AAA/User Profiles

Use for managing user profiles.

Get a User Profile by ID: Method: get
Path: /api/AAA/UserProfiles/{id}
Update a User Profile: Method: put
Path: /api/AAA/UserProfiles/{id}

AAA/User Properties

Use for managing user properties.

Create a User Property: Method: post
Path: /api/AAA/UserProperties
Delete a User Property: Method: delete
Path: /api/AAA/UserProperties/{id}
Get a User Property by ID: Method: get
Path: /api/AAA/UserProperties/{id}
Get User Properties: Method: get
Path: /api/AAA/UserProperties
Get User Properties for Combo Boxes and Item Selectors: Method: get
Path: /api/AAA/UserProperties/readForSelect
Update a User Property: Method: put
Path: /api/AAA/UserProperties/{id}

AAA/Users

Use for managing users.

Create a User: Method: post
Path: /api/AAA/Users
Delete a User: Method: delete
Path: /api/AAA/Users/{id}
Get a User by ID: Method: get
Path: /api/AAA/Users/{id}
Get Users: Method: get
Path: /api/AAA/Users
Get Users for Combo Boxes and Item Selectors: Method: get
Path: /api/AAA/Users/readForSelect
Update a User: Method: put
Path: /api/AAA/Users/{id}

Broker Control/Application Config Types

Use for managing application configuration types.

Create an Application Configuration Type: Method: post
Path: /api/broker/ApplicationConfigTypes
Delete an Application Configuration Type: Method: delete
Path: /api/broker/ApplicationConfigTypes/{id}
Get an Application Configuration Type by ID: Method: get
Path: /api/broker/ApplicationConfigTypes/{id}
Get Application Configuration Types: Method: get
Path: /api/broker/ApplicationConfigTypes
Update an Application Configuration Type: Method: put
Path: /api/broker/ApplicationConfigTypes/{id}

Broker Control/Broker Services

Use for managing broker services.

Create a Broker Service: Method: post
Path: /api/broker/Services
Delete a Broker Service: Method: delete
Path: /api/broker/Services/{id}
Get a Broker Service by ID: Method: get
Path: /api/broker/Services/{id}
Get Broker Service States: Method: get
Path: /api/broker/Services/readStates
Get Broker Services: Method: get
Path: /api/broker/Services
Get Broker Services for Combo Boxes and Item Selectors: Method: get
Path: /api/broker/Services/readForSelect
Reload Service Configuration: Method: get
Path: /api/broker/Services/executeReloadConfig
Restart a Service: Method: get
Path: /api/broker/Services/executeRestart
Start a Service: Method: get
Path: /api/broker/Services/executeStart
Stop a Service: Method: get
Path: /api/broker/Services/executeStop
Update a Broker Service: Method: put
Path: /api/broker/Services/{id}

Broker Control/Failover Service States

Use for viewing broker component failover states.

Get Details of All Failover Service States: Method: get
Path: /api/broker/FailoverStates

Broker Control/Jobs

Use for managing jobs.

Create a Job: Method: post
Path: /api/broker/Jobs
Delete a Job: Method: delete
Path: /api/broker/Jobs/{id}
Get a Job by ID: Method: get
Path: /api/broker/Jobs/{id}
Get Job States: Method: get
Path: /api/broker/Jobs/readStates
Get Jobs: Method: get
Path: /api/broker/Jobs
Get Jobs for Combo Boxes and Item Selectors: Method: get
Path: /api/broker/Jobs/readForSelect
Start a Job: Method: get
Path: /api/broker/Jobs/executeStart
Update a Job: Method: put
Path: /api/broker/Jobs/{id}

Broker Control/Render Types

Use for managing render types. Broker render types describe how a particular form field should be rendered and where the contents come from. Some render types are static, such as Boolean with values true/false. Others use APIs to get the values, such as the treecombo which pulls from /api/topology/menus/readForTree.

Get a Render Type by ID: Method: get
Path: /api/broker/renderTypes/{id}
Get Render Types: Method: get
Path: /api/broker/renderTypes
Get Render Types for Combo Boxes and Item Selectors: Method: get
Path: /api/broker/RenderTypes/readForSelect

Broker Control/Servers

Use for managing broker servers.

Delete a Broker Server: Method: delete
Path: /api/broker/Servers/{id}
Get a Broker Server by ID: Method: get
Path: /api/broker/Servers/{id}
Get Acceptance of EULA: Method: get
Path: /api/broker/Servers/readEULAAcceptance
Get Available Versions of Unified Assurance Package: Method: get
Path: /api/broker/Servers/readVersions
Get Broker Servers: Method: get
Path: /api/broker/Servers
Get Broker Servers for Combo Boxes and Item Selectors: Method: get
Path: /api/broker/Servers/readForSelect
Get Install Status of Server Roles: Method: get
Path: /api/broker/Servers/readInstallStatus
Get States of Broker Servers: Method: get
Path: /api/broker/Servers/readStates
Update a Broker Server: Method: put
Path: /api/broker/Servers/{id}
Update Acceptance of EULA: Method: put
Path: /api/broker/Servers/updateEULAAcceptance
Update Server Roles: Method: post
Path: /api/broker/Servers/updateServerRoles
Update Server Version: Method: post
Path: /api/broker/Servers/updateServers

Core/API Batches

Use for running APIs in batches.

Run APIs in Batches: Method: post
Path: /api/core/Batch/execute

Core/Certificate Warning

Use for getting the global settings for certificate warnings.

Get Global Setting for Certificate Warning: Method: get
Path: /api/core/CertificateWarning

Core/Global Properties

Use for managing global properties.

Get a Global Property by ID: Method: get
Path: /api/core/GlobalProperties/{id}
Get Global Properties: Method: get
Path: /api/core/GlobalProperties
Update a Global Property: Method: put
Path: /api/core/GlobalProperties/{id}

Core/Icons

Use for managing icons.

Create an Icon: Method: post
Path: /api/core/Icons
Get Icons for Combo Boxes and Item Selectors: Method: get
Path: /api/core/Icons/readForSelect

Core/Locales

Use for reading locales and translation text.

Get Locale Information: Method: get
Path: /api/core/Locales/read
Get Locales for Combo Boxes and Item Selectors: Method: get
Path: /api/core/Locales/readForSelect

Core/Themes

Use for getting themes.

Get Themes for Combo Boxes and Item Selectors: Method: get
Path: /api/core/Themes/readForSelect

Core/Time Zones

Use for getting time zones.

Get Database Time Zones for Combo Boxes and Item Selectors: Method: get
Path: /api/core/Timezones/readForSelect

Core/User Sessions

Use for managing user sessions, including logging in and out, getting session details, and changing passwords.

Change a Password: Method: post
Path: /api/core/ChangePassword/executeChangePassword
Get Session Data: Method: get
Path: /api/core/Login/readSessionInfo
Get Session Data as JSON File: Method: get
Path: /api/core/Login/readSessionInfoJs
Log a User Out: Method: post
Path: /api/core/Login/executeLogout
Log In and Authenticate a User: Method: post
Path: /api/core/Login/executeLogin

Dashboard/Dashboard Groups

Use for managing dashboard groups.

Create a Dashboard Group: Method: post
Path: /api/dashboard/DashboardGroups
Delete a Dashboard Group: Method: delete
Path: /api/dashboard/DashboardGroups/{id}
Get a Dashboard Group by ID: Method: get
Path: /api/dashboard/DashboardGroups/{id}
Get Dashboard Groups for Tree Grids: Method: get
Path: /api/dashboard/DashboardGroups/readForTree
Get Dashboard Groups for Tree Grids or Form Grids: Method: get
Path: /api/dashboard/DashboardGroups
Move Dashboard Groups to a Different Parent: Method: put
Path: /api/dashboard/DashboardGroups/updateMove
Move or Copy Dashboards to a Different Group: Method: put
Path: /api/dashboard/DashboardGroups/updateDashboards
Update a Dashboard Group: Method: put
Path: /api/dashboard/DashboardGroups/{id}

Dashboard/Dashboard Navigation

Use for viewing dashboard configurations and groups.

Get Dashboards and Dashboard Groups Under a Specific Node: Method: get
Path: /api/dashboardNavigation/Dashboards/readForTree

Dashboard/Dashboards

Use for managing dashboards.

Create a Dashboard: Method: post
Path: /api/dashboard/Dashboards
Create a Dashboard from a JSON File: Method: post
Path: /api/dashboard/Dashboards/createImportDashboard
Delete a Dashboard: Method: delete
Path: /api/dashboard/Dashboards/{id}
Get a Dashboard by ID: Method: get
Path: /api/dashboard/Dashboards/{id}
Get a JSON String Representation of a Dashboard: Method: get
Path: /api/dashboard/Dashboards/readExportDashboard
Get Dashboard Part Configurations: Method: get
Path: /api/dashboard/Dashboards/readParts
Get Dashboards: Method: get
Path: /api/dashboard/Dashboards
Get Dashboards for Combo Boxes and Item Selectors: Method: get
Path: /api/dashboard/Dashboards/readForSelect
Update a Dashboard: Method: put
Path: /api/dashboard/Dashboards/{id}

Database/Database Queries

Use for managing saved database queries.

Create a Query: Method: post
Path: /api/database/Queries
Delete a Query: Method: delete
Path: /api/database/Queries/{id}
Get a Query by ID: Method: get
Path: /api/database/Queries/{id}
Get All Tokens of a Query: Method: get
Path: /api/database/Queries/readTokens
Get Queries: Method: get
Path: /api/database/Queries
Get Queries for Combo Boxes and Item Selectors: Method: get
Path: /api/database/Queries/readForSelect
Update a Query: Method: put
Path: /api/database/Queries/{id}

Database/Database Query Tools

Use for executing queries.

Run a Query: Method: post
Path: /api/database/QueryTools/executeQuery

Database/Databases

Use for managing databases.

Create a Database: Method: post
Path: /api/database/Databases
Delete a Database: Method: delete
Path: /api/database/Databases/{id}
Get a Database by ID: Method: get
Path: /api/database/Databases/{id}
Get Database Schemas for Combo Boxes and Item Selectors: Method: get
Path: /api/database/Databases/readSchemasForSelect
Get Databases: Method: get
Path: /api/database/Databases
Get Databases for Combo Boxes and Item Selectors: Method: get
Path: /api/database/Databases/readForSelect
Get States of Databases Based on DatabaseWatchdog: Method: get
Path: /api/database/Databases/readStates
Update a Database: Method: put
Path: /api/database/Databases/{id}

Device Catalog/Device Groups

Use for managing device groups.

Create a Device Group: Method: post
Path: /api/device/Groups
Delete a Device Group: Method: delete
Path: /api/device/Groups/{id}
Get a Device Group by ID: Method: get
Path: /api/device/Groups/{id}
Get a Device Group or Children of a Device Group: Method: get
Path: /api/device/Groups
Get Device Groups for Tree Combos: Method: get
Path: /api/device/Groups/readForTreeCombo
Get Device Groups for Tree Grids: Method: get
Path: /api/device/Groups/readForTree
Move Device Groups to a Different Parent: Method: put
Path: /api/device/Groups/updateMove
Move or Copy Devices to a Different Group: Method: put
Path: /api/device/Groups/updateDevices
Update a Device Group: Method: put
Path: /api/device/Groups/{id}

Device Catalog/Device Maintenance Windows

Use for managing device maintenance windows.

Create a Device Maintenance Window: Method: post
Path: /api/device/Windows
Delete a Device Maintenance Window: Method: delete
Path: /api/device/Windows/{id}
Get a Device Maintenance Window by ID: Method: get
Path: /api/device/Windows/{id}
Get Device Maintenance Windows: Method: get
Path: /api/device/Windows
Get Device Maintenance Windows for Combo Boxes and Item Selectors: Method: get
Path: /api/device/Windows/readForSelect
Update a Device Maintenance Window: Method: put
Path: /api/device/Windows/{id}

Device Catalog/Device Management

Use for managing multiple devices.

Delete Multiple Devices: Method: post
Path: /api/device/DeviceManagement/deleteDevice
Update Device Priority ID: Method: post
Path: /api/device/DeviceManagement/updatePriority
Update Device Shard ID: Method: post
Path: /api/device/DeviceManagement/updateShard
Update Device State ID: Method: post
Path: /api/device/DeviceManagement/updateDiscovery
Update Device State ID to Unmanage a Device: Method: post
Path: /api/device/DeviceManagement/updateUnmanageDevice
Update Device Type Category by ID: Method: post
Path: /api/device/DeviceManagement/updateCategory
Update Device Zone ID: Method: post
Path: /api/device/DeviceManagement/updateZone

Device Catalog/Device Metadata

Use for managing device metadata.

Get Device Metadata for Combo Boxes and Item Selectors: Method: get
Path: /api/device/MetaData/readForSelect

Device Catalog/Device Metatypes

Use for managing device metatypes.

Create a Device Metatype: Method: post
Path: /api/device/MetaTypes
Delete a Device Metatype: Method: delete
Path: /api/device/MetaTypes/{id}
Get a Device Metatype by ID: Method: get
Path: /api/device/MetaTypes/{id}
Get Active Device Metatypes for Combo Boxes and Item Selectors: Method: get
Path: /api/device/MetaTypes/readForSelectActive
Get Assigned Device Metatypes for Combo Boxes and Item Selectors: Method: get
Path: /api/device/MetaTypes/readAssignedForSelect
Get Device Metatypes: Method: get
Path: /api/device/MetaTypes
Get Device Metatypes for Combo Boxes and Item Selectors: Method: get
Path: /api/device/MetaTypes/readForSelect
Update a Device Metatype: Method: put
Path: /api/device/MetaTypes/{id}

Device Catalog/Device Navigation

Use for getting information about device organization and state.

Get Availability, Event, and Metric Threshold States of Devices: Method: get
Path: /api/deviceNavigation/Devices/readStates
Get Device Availability Details: Method: get
Path: /api/deviceNavigation/Devices/readStatesAvailability
Get Device Event Details: Method: get
Path: /api/deviceNavigation/Devices/readStatesEvent
Get Device Groups and Devices in Tree Representation: Method: get
Path: /api/deviceNavigation/Devices/readForTree
Get Device Threshold Details: Method: get
Path: /api/deviceNavigation/Devices/readStatesThresholds
Get Device Vertex in Graph Database: Method: get
Path: /api/deviceNavigation/Devices/readDeviceVertex
Get Devices for Combo Boxes and Item Selectors: Method: get
Path: /api/deviceNavigation/Devices/readForSelect
Get Network Inventory Status of Devices: Method: get
Path: /api/deviceNavigation/Devices/readStatesNetworks

Device Catalog/Device Remote

Use for establishing session connections to remote devices with Guacamole.

Authenticate with Apache Guacamole: Method: post
Path: /api/device/Remote

Device Catalog/Device Type Categories

Use for managing device type categories.

Create a Device Type Category: Method: post
Path: /api/device/Categories
Delete a Device Type Category: Method: delete
Path: /api/device/Categories/{id}
Delete Multiple Device Type Categories: Method: post
Path: /api/device/Categories/delete
Get a Device Type Category by ID: Method: get
Path: /api/device/Categories/{id}
Get Device Type Categories: Method: get
Path: /api/device/Categories
Get Device Type Categories for Combo Boxes and Item Selectors: Method: get
Path: /api/device/Categories/readForSelect
Update a Device Type Category: Method: put
Path: /api/device/Categories/{id}

Device Catalog/Device Type Vendors

Use for managing device type vendors.

Create a Device Type Vendor: Method: post
Path: /api/device/Vendors
Delete a Device Type Vendor: Method: delete
Path: /api/device/Vendors/{id}
Get a Device Type Vendor by ID: Method: get
Path: /api/device/Vendors/{id}
Get Device Type Vendors: Method: get
Path: /api/device/Vendors
Get Device Type Vendors for Combo Boxes and Item Selectors: Method: get
Path: /api/device/Vendors/readForSelect
Update a Device Type Vendor: Method: put
Path: /api/device/Vendors/{id}

Device Catalog/Device Types

Use for managing device types.

Create a Device Type: Method: post
Path: /api/device/Types
Delete a Device Type: Method: delete
Path: /api/device/Types/{id}
Get a Device Type by ID: Method: get
Path: /api/device/Types/{id}
Get Device Types: Method: get
Path: /api/device/Types
Get Device Types for Combo Boxes and Item Selectors: Method: get
Path: /api/device/Types/readForSelect
Update a Device Type: Method: put
Path: /api/device/Types/{id}

Device Catalog/Device Views

Use for retrieving device details.

Get Device Details: Method: get
Path: /api/device/DeviceViews

Device Catalog/Device Zones

Use for managing device zones.

Create a Device Zone: Method: post
Path: /api/device/Zones
Delete a Device Zone: Method: delete
Path: /api/device/Zones/{id}
Get a Device Zone by ID: Method: get
Path: /api/device/Zones/{id}
Get Device Zones: Method: get
Path: /api/device/Zones
Get Device Zones for Combo Boxes and Item Selectors: Method: get
Path: /api/device/Zones/readForSelect
Update a Device Zone: Method: put
Path: /api/device/Zones/{id}

Device Catalog/Devices

Use for managing devices.

Create a Device: Method: post
Path: /api/device/Devices
Delete a Device: Method: delete
Path: /api/device/Devices/{id}
Get a Device by ID: Method: get
Path: /api/device/Devices/{id}
Get an IP Address for a DNS Name: Method: get
Path: /api/device/Devices/readIpForDns
Get Devices: Method: get
Path: /api/device/Devices
Get Devices for Combo Boxes and Item Selectors: Method: get
Path: /api/device/Devices/readForSelect
Update a Device: Method: put
Path: /api/device/Devices/{id}

Device Configuration/Device Configuration Actions

Use for managing Topology Configuration Agent (TCA) actions.

Create a Device Configuration Action: Method: post
Path: /api/config/Actions
Delete a Device Configuration Action: Method: delete
Path: /api/config/Actions/{id}
Get a Device Configuration Action by ID: Method: get
Path: /api/config/Actions/{id}
Get Device Configuration Actions: Method: get
Path: /api/config/Actions
Get Device Configuration Actions for Combo Boxes and Item Selectors: Method: get
Path: /api/config/Actions/readForSelect
Update a Device Configuration Action: Method: put
Path: /api/config/Actions/{id}

Device Configuration/Device Configuration Collections

Use for managing Topology Configuration Agent (TCA) collections.

Create a Device Configuration Collection: Method: post
Path: /api/config/Collections
Delete a Device Configuration Collection: Method: delete
Path: /api/config/Collections/{id}
Get a Device Configuration Collection by ID: Method: get
Path: /api/config/Collections/{id}
Get Device Configuration Collections: Method: get
Path: /api/config/Collections
Get Device Configuration Collections for Combo Boxes and Item Selectors: Method: get
Path: /api/config/Collections/readForSelect
Start Config Gatherer Job for a Device: Method: get
Path: /api/config/Collections/executeRun
Update a Device Configuration Collection: Method: put
Path: /api/config/Collections/{id}

Device Configuration/Device Configuration Policies

Use for managing Topology Configuration Agent (TCA) policies.

Create a Device Configuration Policy: Method: post
Path: /api/config/Policies
Delete a Device Configuration Policy: Method: delete
Path: /api/config/Policies/{id}
Get a Device Configuration Policy by ID: Method: get
Path: /api/config/Policies/{id}
Get Device Configuration Policies: Method: get
Path: /api/config/Policies
Get Device Configuration Policies for Combo Boxes and Item Selectors: Method: get
Path: /api/config/Policies/readForSelect
Update a Device Configuration Policy: Method: put
Path: /api/config/Policies/{id}

Device Configuration/Device Configuration Profiles

Use for managing Topology Configuration Agent (TCA) profiles.

Create a Device Configuration Profile: Method: post
Path: /api/config/Profiles
Delete a Device Configuration Profile: Method: delete
Path: /api/config/Profiles/{id}
Get a Device Configuration Profile by ID: Method: get
Path: /api/config/Profiles/{id}
Get Device Configuration Profiles: Method: get
Path: /api/config/Profiles
Get Device Configuration Profiles for Combo Boxes and Item Selectors: Method: get
Path: /api/config/Profiles/readForSelect
Update a Device Configuration Profile: Method: put
Path: /api/config/Profiles/{id}

Device Configuration/Device Configurations

Use for viewing device configuration details.

Get Collected Device Configuration Names for Combo Boxes and Item Selectors: Method: get
Path: /api/config/ViewConfigs/readForSelect
Get Difference between Specified Files or Revisions: Method: get
Path: /api/config/ViewConfigs/readDiff
Get File Contents for Specified Configuration: Method: get
Path: /api/config/ViewConfigs/readFile
Get Logs for a Device: Method: get
Path: /api/config/ViewConfigs/readView
Get Revision History of a File: Method: get
Path: /api/config/ViewConfigs/readRevisionHistory

Device Discovery/Discovery

Use for executing remote discovery.

Get Jobs Associated with Specified Server and Job Program: Method: get
Path: /api/discovery/Discover/readDiscoveryJobJobs
Get Servers Supporting Auto Discovery for Combo Boxes and Item Selectors: Method: get
Path: /api/discovery/Discover/readServers
Get Servers with Specified Package and Job Configuration: Method: get
Path: /api/discovery/Discover/readDiscoveryJobs
Gets Servers with Specified Package: Method: get
Path: /api/discovery/Discover/readDiscoveryJobServers
Start an Auto Discovery or SNMP Discovery Job: Method: get
Path: /api/discovery/Discover/executeRun

Device Discovery/Exclusion Profiles

Use for managing discovery exclusion profiles.

Create an Exclusion Profile: Method: post
Path: /api/discovery/Excludes
Delete an Exclusion Profile: Method: delete
Path: /api/discovery/Excludes/{id}
Get an Exclusion Profile by ID: Method: get
Path: /api/discovery/Excludes/{id}
Get Discovery Exclusion Profiles: Method: get
Path: /api/discovery/Excludes
Get Discovery Exclusion Profiles for Combo Boxes and Item Selectors: Method: get
Path: /api/discovery/Excludes/readForSelect
Update an Exclusion Profile: Method: put
Path: /api/discovery/Excludes/{id}

Device Discovery/Inclusion Profiles

Use for managing discovery inclusion profiles.

Create an Inclusion Profile: Method: post
Path: /api/discovery/Includes
Delete an Inclusion Profile: Method: delete
Path: /api/discovery/Includes/{id}
Get an Inclusion Profile by ID: Method: get
Path: /api/discovery/Includes/{id}
Get Discovery Inclusion Profiles: Method: get
Path: /api/discovery/Includes
Get Discovery Inclusion Profiles for Combo Boxes and Item Selectors: Method: get
Path: /api/discovery/Includes/readForSelect
Update an Inclusion Profile: Method: put
Path: /api/discovery/Includes/{id}

Device Discovery/SNMP Access

Use for managing discovery SNMP access Profiles.

Create an SNMP Access Profile: Method: post
Path: /api/discovery/Snmp
Delete an SNMP Access Profile: Method: delete
Path: /api/discovery/Snmp/{id}
Get an SNMP Access Profile by ID: Method: get
Path: /api/discovery/Snmp/{id}
Get Discovery SNMP Access Profiles: Method: get
Path: /api/discovery/Snmp
Get Discovery SNMP Access Profiles for Combo Boxes and Item Selectors: Method: get
Path: /api/discovery/Snmp/readForSelect
Update an SNMP Access Profile: Method: put
Path: /api/discovery/Snmp/{id}
Update Priority Order of SNMP Access: Method: get
Path: /api/discovery/Snmp/updateOrder

Diagrams/Diagram Groups

Use for managing diagram groups.

Create a Diagram Group: Method: post
Path: /api/diagram/DiagramGroups
Delete a Diagram Group: Method: delete
Path: /api/diagram/DiagramGroups/{id}
Get a Diagram Group by ID: Method: get
Path: /api/diagram/DiagramGroups/{id}
Get Diagram Groups: Method: get
Path: /api/diagram/DiagramGroups
Get Diagram Groups for Tree Combos: Method: get
Path: /api/diagram/DiagramGroups/readForTreeCombo
Get Diagram Groups for Tree Grids: Method: get
Path: /api/diagram/DiagramGroups/readForTree
Move Diagram Groups to a Different Parent: Method: put
Path: /api/diagram/DiagramGroups/updateMove
Move or Copy Diagrams to a Different Group: Method: put
Path: /api/diagram/DiagramGroups/updateDiagrams
Update a Diagram Group: Method: put
Path: /api/diagram/DiagramGroups/{id}

Diagrams/Diagram Menus

Use for managing diagram menus.

Create a Diagram Menu: Method: post
Path: /api/diagram/Menus
Delete a Diagram Menu: Method: delete
Path: /api/diagram/Menus/{id}
Get a Diagram Menu by ID: Method: get
Path: /api/diagram/Menus/{id}
Get Diagram Menus: Method: get
Path: /api/diagram/Menus
Get Menus for Combo Boxes and Item Selectors: Method: get
Path: /api/diagram/Menus/readForSelect
Get Menus for Diagram Menu: Method: get
Path: /api/diagram/Menus/readForMenu
Move a Diagram Menu to a Different Parent: Method: put
Path: /api/diagram/Menus/updateMove
Move or Copy Diagram Menu Tools to a New Menu: Method: put
Path: /api/diagram/Menus/updateTools
Update a Diagram Menu: Method: put
Path: /api/diagram/Menus/{id}

Diagrams/Diagram Navigation

Use for viewing diagrams and groups.

Get Diagrams and Groups Under a Specific Node: Method: get
Path: /api/diagramNavigation/Diagrams/readForTree

Diagrams/Diagram Tools

Use for managing diagram tools.

Create a Diagram Menu Tool: Method: post
Path: /api/diagram/Tools
Delete a Diagram Menu Tool: Method: delete
Path: /api/diagram/Tools/{id}
Get a Diagram Menu Tool by ID: Method: get
Path: /api/diagram/Tools/{id}
Get Diagram Menu Tools: Method: get
Path: /api/diagram/Tools
Get Diagram Tools for Combo Boxes and Item Selectors: Method: get
Path: /api/diagram/Tools/readForSelect
Run a View Tool: Method: get
Path: /api/diagram/Tools/executeViewTool/{id}
Update a Diagram Menu Tool: Method: put
Path: /api/diagram/Tools/{id}

Diagrams/Diagram Types

Use for managing diagram types.

Get Diagram Types for Combo Boxes and Item Selectors: Method: get
Path: /api/diagram/Types/readForSelect

Diagrams/Diagrams

Use for managing diagrams.

Create a Diagram: Method: post
Path: /api/diagram/Diagrams
Delete a Diagram: Method: delete
Path: /api/diagram/Diagrams/{id}
Get a Diagram by ID: Method: get
Path: /api/diagram/Diagrams/{id}
Get a Diagram's SVG: Method: get
Path: /api/diagram/Diagrams/readSVG
Get a New Diagram's SVG: Method: get
Path: /api/diagram/Diagrams/readNewSVG
Get Diagram Revisions for Combo Boxes and Item Selectors: Method: get
Path: /api/diagram/Diagrams/readRevisionForSelect
Get Diagram SVG File: Method: get
Path: /api/diagram/Diagrams/executeDownload
Get Diagrams: Method: get
Path: /api/diagram/Diagrams
Get Diagrams for Combo Boxes and Item Selectors: Method: get
Path: /api/diagram/Diagrams/readForSelect
Get the Uploaded SVG Content: Method: post
Path: /api/diagram/Diagrams/readBack
Revert a Diagram to a Specified Revision: Method: post
Path: /api/diagram/Diagrams/updateRevision
Update a Diagram: Method: put
Path: /api/diagram/Diagrams/{id}

Diagrams/Widgets

Use for viewing diagram widgets.

Get Event Widget Status: Method: post
Path: /api/diagram/Widgets/readEventStatus
Get Metric Widget Status: Method: post
Path: /api/diagram/Widgets/readMetricStatus
Get Widgets: Method: get
Path: /api/diagram/Widgets

Event/CAPE Nodes

Use for managing event CAPE nodes.

Check Syntax for a CAPE Node: Method: post
Path: /api/event/Nodes/executeCheckSyntax
Create a CAPE Node: Method: post
Path: /api/event/Nodes
Delete a CAPE Node: Method: delete
Path: /api/event/Nodes/{id}
Get a CAPE Node by ID: Method: get
Path: /api/event/Nodes/{id}
Get CAPE Nodes: Method: get
Path: /api/event/Nodes
Get CAPE Nodes for Combo boxes and Item Selectors: Method: get
Path: /api/event/Nodes/readForSelect
Update a CAPE Node: Method: put
Path: /api/event/Nodes/{id}

Event/CAPE Policies

Use for managing event CAPE policies.

Create a CAPE Policy: Method: post
Path: /api/event/Policies
Delete a CAPE Policy: Method: delete
Path: /api/event/Policies/{id}
Get a CAPE Policy by ID: Method: get
Path: /api/event/Policies/{id}
Get CAPE Policies: Method: get
Path: /api/event/Policies
Get CAPE Policies for Combo Boxes and Item Selectors: Method: get
Path: /api/event/Policies/readForSelect
Update a CAPE Policy: Method: put
Path: /api/event/Policies/{id}

Event/Conversions

Use for managing event display conversions

Create an Event Display Conversion: Method: post
Path: /api/event/DisplayConversions
Delete an Event Display Conversion: Method: delete
Path: /api/event/DisplayConversions/{id}
Get an Event Display Conversion by Field Name: Method: get
Path: /api/event/DisplayConversions/{id}
Get Conversions for a Specific Field for Combo Boxes and Item Selectors: Method: get
Path: /api/event/DisplayConversions/readForSelect
Get Event Display Conversions: Method: get
Path: /api/event/DisplayConversions
Get Event Fields from Events for Combo Boxes: Method: get
Path: /api/event/DisplayConversions/readFieldsForSelect
Update an Event Display Conversion: Method: put
Path: /api/event/DisplayConversions/{id}

Event/Displays

Use for managing event displays.

Create an Event Display: Method: post
Path: /api/event/Displays
Delete an Event Display: Method: delete
Path: /api/event/Displays/{id}
Get All Columns for New Displays: Method: get
Path: /api/event/Displays/readAllColumns
Get an Event Display by ID: Method: get
Path: /api/event/Displays/{id}
Get Event Displays: Method: get
Path: /api/event/Displays
Get Event Displays for Combo Boxes and Item Selectors: Method: get
Path: /api/event/Displays/readForSelect
Update an Event Display: Method: put
Path: /api/event/Displays/{id}

Event/Event Filter Groups

Use for managing event filter groups.

Create an Event Filter Group: Method: post
Path: /api/event/FilterGroups
Delete an Event Filter Group: Method: delete
Path: /api/event/FilterGroups/{id}
Get an Event Filter Group by ID: Method: get
Path: /api/event/FilterGroups/{id}
Get an Event Filter Group or Children of an Event Filter Group: Method: get
Path: /api/event/FilterGroups
Get Event Filter Groups for Combo Boxes and Item Selectors: Method: get
Path: /api/event/FilterGroups/readForSelect
Get Event Filter Groups for Tree Combos: Method: get
Path: /api/event/FilterGroups/readForTreeCombo
Get Event Filter Groups for Tree Grids: Method: get
Path: /api/event/FilterGroups/readForTree
Move Event Filter Groups to a Different Parent: Method: put
Path: /api/event/FilterGroups/updateMove
Move or Copy Event Filters to a Different Group: Method: put
Path: /api/event/FilterGroups/updateFilters
Update an Event Filter Group: Method: put
Path: /api/event/FilterGroups/{id}

Event/Event Filters

Use for managing event filters.

Create an Event Filter: Method: post
Path: /api/event/Filters
Delete an Event Filter: Method: delete
Path: /api/event/Filters/{id}
Get an Event Filter by ID: Method: get
Path: /api/event/Filters/{id}
Get Event Filters: Method: get
Path: /api/event/Filters
Get Event Filters for Combo Boxes and Item Selectors: Method: get
Path: /api/event/Filters/readForSelect
Update an Event Filter: Method: put
Path: /api/event/Filters/{id}

Event/Event Menus

Use for managing event menus.

Create an Event Menu: Method: post
Path: /api/event/Menus
Delete an Event Menu: Method: delete
Path: /api/event/Menus/{id}
Get an Event Menu by ID: Method: get
Path: /api/event/Menus/{id}
Get Event Menus: Method: get
Path: /api/event/Menus
Get Event Menus for Tree Grids: Method: get
Path: /api/event/Menus/readForTree
Get Menu Items of an Event Menu: Method: get
Path: /api/event/Menus/readForMenu
Move an Event Menu to a Different Parent: Method: put
Path: /api/event/Menus/updateMove
Move or Copy Event Menu Tools to a Different Menu: Method: put
Path: /api/event/Menus/updateTools
Update an Event Menu: Method: put
Path: /api/event/Menus/{id}

Event/Event Navigation

Use for managing event navigation.

Get Event Filters under a Specific Node: Method: get
Path: /api/eventNavigation/Events/readForTree
Get Severity States and Summary Count of Event Filters: Method: get
Path: /api/eventNavigation/Events/readStates

Event/Event Tools

Use for managing event tools.

Create an Event Tool: Method: post
Path: /api/event/Tools/
Delete an Event Tool: Method: delete
Path: /api/event/Tools/{id}
Get a Event Tool by ID: Method: get
Path: /api/event/Tools/{id}
Get Event Tools: Method: get
Path: /api/event/Tools/
Get Event Tools for Combo Boxes and Item Selectors: Method: get
Path: /api/event/Tools/readForSelect
Update an Event Tool: Method: put
Path: /api/event/Tools/{id}

Event/Events

Use for managing events.

Create an Event: Method: post
Path: /api/event/Events
Delete an Event: Method: delete
Path: /api/event/Events/{id}
Get an Event by ID: Method: get
Path: /api/event/Events/{id}
Get Event Filter Fields: Method: get
Path: /api/event/Events/readFields
Get Event Severities: Method: get
Path: /api/event/Events/readSeverities
Get Events: Method: get
Path: /api/event/Events
Get Fields Associated to Events Table in Event Schema: Method: get
Path: /api/event/Events/readFieldsForSelect
Update an Event: Method: put
Path: /api/event/Events/{id}

Event/Forensic Views

Use for managing forensic views.

Get Possible Values for a Field from the Events Table: Method: get
Path: /api/event/ForensicViews/readFilterOptions

Event/Journals

Use to read and add new event journal entries.

Create a Journal Entry: Method: post
Path: /api/event/EventJournals
Get Journal Entries: Method: get
Path: /api/event/EventJournals

Event/Mechanizations

Use for managing event mechanizations.

Create an Event Mechanization: Method: post
Path: /api/event/Mechanizations/
Delete an Event Mechanization: Method: delete
Path: /api/event/Mechanizations/{id}
Get an Event Mechanization by ID: Method: get
Path: /api/event/Mechanizations/{id}
Get Event Mechanizations: Method: get
Path: /api/event/Mechanizations/
Get Event Mechanizations for Combo Boxes and Item Selectors: Method: get
Path: /api/event/Mechanizations/readForSelect
Update an Event Mechanization: Method: put
Path: /api/event/Mechanizations/{id}

Event/Meta Events

Use for managing meta events.

Create a Meta Events: Method: post
Path: /api/event/MetaEvents/
Delete a Meta Events: Method: delete
Path: /api/event/MetaEvents/{id}
Get a Meta Event by ID: Method: get
Path: /api/event/MetaEvents/{id}
Get All Fields from the Events Table: Method: get
Path: /api/event/MetaEvents/readFields
Get Meta Events: Method: get
Path: /api/event/MetaEvents/
Get Meta Events for Combo Boxes and Item Selectors: Method: get
Path: /api/event/MetaEvents/readForSelect
Update a Meta Events: Method: put
Path: /api/event/MetaEvents/{id}

Event/Supervised Correlations

Use to correlate events to a root cause and manage symptom events.

Create an Event Supervised Correlation Policy: Method: post
Path: /api/event/SupervisedCorrelations/
Delete an Event Supervised Correlation Policy: Method: delete
Path: /api/event/SupervisedCorrelations/{id}
Get an Event Supervised Correlation Policy by ID: Method: get
Path: /api/event/SupervisedCorrelations/{id}
Get Event Keys for Combo Boxes and Item Selectors: Method: get
Path: /api/event/SupervisedCorrelations/readKeysForSelect
Get Event Supervised Correlation Policies: Method: get
Path: /api/event/SupervisedCorrelations/
Update an Event Supervised Correlation Policy: Method: put
Path: /api/event/SupervisedCorrelations/{id}

Event/Watcher Policies

Use for managing event watcher policies.

Create an Event Watcher Policy: Method: post
Path: /api/event/WatcherPolicies
Delete an Event Watcher Policy: Method: delete
Path: /api/event/WatcherPolicies/{id}
Get an Event Watcher Policy by ID: Method: get
Path: /api/event/WatcherPolicies/{id}
Get Event Watcher Policies: Method: get
Path: /api/event/WatcherPolicies
Get Event Watcher Policies for Combo Boxes and Item Selectors: Method: get
Path: /api/event/WatcherPolicies/readForSelect
Get Events Table Fields: Method: get
Path: /api/event/WatcherPolicies/readFieldsForSelect
Update an Event Watcher Policy: Method: put
Path: /api/event/WatcherPolicies/{id}

File/File Types

Use for managing file types.

Add a File Type: Method: post
Path: /api/file/FileTypes
Delete a File Type: Method: delete
Path: /api/file/FileTypes/{id}
Get a File Type by ID: Method: get
Path: /api/file/FileTypes/{id}
Get File Types: Method: get
Path: /api/file/FileTypes
Get File Types for Combo Boxes and Item Selectors: Method: get
Path: /api/file/FileTypes/readForSelect
Update a File Type: Method: put
Path: /api/file/FileTypes/{id}

File/Files

Use for managing files.

Delete a File: Method: delete
Path: /api/file/Files/{id}
Download a File: Method: get
Path: /api/file/Files/executeDownload/{id}
Get a File by ID: Method: get
Path: /api/file/Files/{id}
Get Files: Method: get
Path: /api/file/Files
Get Files for Combo Boxes and Item Selectors: Method: get
Path: /api/file/Files/readForSelect
Return a File Based on ID or File Name: Method: get
Path: /api/file/Files/readContent
Update a File: Method: put
Path: /api/file/Files/{id}
Upload a File: Method: post
Path: /api/file/Files

Gateway/Gateway Elements

Use for managing elements.

Create an Element Vertex: Method: post
Path: /api/gateway/Elements
Delete an Element Vertex: Method: delete
Path: /api/gateway/Elements/{id}
Get an Element by ID: Method: get
Path: /api/gateway/Elements/{id}
Get Element Objects: Method: get
Path: /api/gateway/Elements
Get Element Vertices for Combo Boxes and Item Selectors: Method: get
Path: /api/gateway/Elements/readForSelect
Update an Element Vertex: Method: put
Path: /api/gateway/Elements/{id}

Gateway/Gateways

Use for managing gateways.

Create a Gateway Vertex: Method: post
Path: /api/gateway/Gateways
Delete a Gateway Vertex: Method: delete
Path: /api/gateway/Gateways/{id}
Get Gateway Objects: Method: get
Path: /api/gateway/Gateways
Get Gateway Objects by ID: Method: get
Path: /api/gateway/Gateways/{id}
Get Gateway Vertices for Combo Boxes and Item Selectors: Method: get
Path: /api/gateway/Gateways/readForSelect
Update a Gateway Vertex: Method: put
Path: /api/gateway/Gateways/{id}

Graph/Edge Types

Use for managing graph edge types.

Create an Edge Type: Method: post
Path: /api/graph/EdgeTypes
Delete an Edge Type: Method: delete
Path: /api/graph/EdgeTypes/{id}
Get an Edge Type by ID: Method: get
Path: /api/graph/EdgeTypes/{id}
Get Edge Types: Method: get
Path: /api/graph/EdgeTypes
Get Edge Types for Combo Boxes and Item Selectors: Method: get
Path: /api/graph/EdgeTypes/readForSelect
Update an Edge Type: Method: put
Path: /api/graph/EdgeTypes/{id}

Graph/Edges

Use for managing graph edges.

Create an Edge: Method: post
Path: /api/graph/Edges
Delete an Edge: Method: delete
Path: /api/graph/Edges/{id}
Get an Edge by ID: Method: get
Path: /api/graph/Edges/{id}
Get Edges: Method: get
Path: /api/graph/Edges
Get Property Values by Edge Type and Property: Method: get
Path: /api/graph/Edges/readProperties
Update an Edge: Method: put
Path: /api/graph/Edges/{id}

Graph/Graphs

Use to gather topology node and edge data.

Get Topology Vertices and Edges: Method: get
Path: /api/graph/Graphs/read
Get Topology Vertices and Edges in a Hierarchical Array: Method: get
Path: /api/graph/Graphs/readForDirectionalTree

Graph/Node Details

Use for gathering graph node and edge details like availability and status.

Get the Status of a Topology Widget: Method: post
Path: /api/graph/NodeDetails/read

Graph/Property Types

Use for managing property types.

Create a Property Type: Method: post
Path: /api/graph/PropertyTypes
Delete a Property Type: Method: delete
Path: /api/graph/PropertyTypes/{id}
Get a Property Type by ID: Method: get
Path: /api/graph/PropertyTypes/{id}
Get Objects for Combo Boxes and Item Selectors: Method: get
Path: /api/graph/PropertyTypes/readForSelect
Get Property Types: Method: get
Path: /api/graph/PropertyTypes
Update a Property Type: Method: put
Path: /api/graph/PropertyTypes/{id}

Graph/Vertex Types

Use for managing vertex types.

Create a Vertex Type: Method: post
Path: /api/graph/VertexTypes
Delete a Vertex Type: Method: delete
Path: /api/graph/VertexTypes/{id}
Get a Vertex Type by ID: Method: get
Path: /api/graph/VertexTypes/{id}
Get Vertex Types: Method: get
Path: /api/graph/VertexTypes
Gets Objects for Combo Boxes and Item Selectors: Method: get
Path: /api/graph/VertexTypes/readForSelect
Update a Vertex Type: Method: put
Path: /api/graph/VertexTypes/{id}

Graph/Vertices

Use for managing vertices.

Create a Vertex: Method: post
Path: /api/graph/Vertices
Delete a Vertex: Method: delete
Path: /api/graph/Vertices/{id}
Delete Multiple Vertices: Method: post
Path: /api/graph/Vertices/Delete
Get a Vertex by ID: Method: get
Path: /api/graph/Vertices/{id}
Get Device Vertices: Method: get
Path: /api/graph/Vertices/readDevicesForSelect
Get Objects for Combo Boxes and Item Selectors: Method: get
Path: /api/graph/Vertices/readForSelect
Get Property Values by Vertex Type and Property: Method: get
Path: /api/graph/Vertices/readProperties
Get Vertices: Method: get
Path: /api/graph/Vertices
Update a Vertex: Method: put
Path: /api/graph/Vertices/{id}

Link/Link Groups

Use for managing link groups.

Create a Link Group: Method: post
Path: /api/link/LinkGroups/
Delete a Link Group: Method: delete
Path: /api/link/LinkGroups/{id}
Get a Link Group: Method: get
Path: /api/link/LinkGroups/{id}
Get Link Groups for Tree Grids: Method: get
Path: /api/link/LinkGroups/readForTree
Get Link Groups for Tree Grids or Form Grids: Method: get
Path: /api/link/LinkGroups/
Move Link Groups to a Different Parent: Method: put
Path: /api/link/LinkGroups/updateMove
Move or Copy Links to a Different Group: Method: put
Path: /api/link/LinkGroups/updateLinks
Update a Link Group: Method: put
Path: /api/link/LinkGroups/{id}

Link/Link Navigation

Use for managing link navigation.

Get Links and Link Groups Under a Specific Node: Method: get
Path: /api/link/LinkNavigation/readForTree

Link/Links

Use for managing links.

Create a Link: Method: post
Path: /api/link/Links/
Delete a Link: Method: delete
Path: /api/link/Links/{id}
Get a Link by ID: Method: get
Path: /api/link/Links/{id}
Get Links: Method: get
Path: /api/link/Links/
Get Links for Combo Boxes and Item Selectors: Method: get
Path: /api/link/Links/readForSelect
Update a Link: Method: put
Path: /api/link/Links/{id}

Metrics/Abnormal Profiles

Use for managing the profiles used by the Abnormal Thresholds and the Metric Abnormal Threshold Engine.

Create an Abnormal Profile: Method: post
Path: /api/metric/AbnormalProfiles
Delete an Abnormal Profile: Method: delete
Path: /api/metric/AbnormalProfiles/{id}
Get Abnormal Profiles: Method: get
Path: /api/metric/AbnormalProfiles
Get Abnormal Profiles for Combo Boxes and Item Selectors: Method: get
Path: /api/metric/AbnormalProfiles/readForSelect
Get an Abnormal Profile by ID: Method: get
Path: /api/metric/AbnormalProfiles/{id}
Update an Abnormal Profile: Method: put
Path: /api/metric/AbnormalProfiles/{id}

Metrics/All Metrics Overview

Use for viewing selected metrics and the associated data.

Get Metrics for an Instance: Method: get
Path: /api/metric/AllMetricsOverview

Metrics/Calculations

Use for managing metric post-collection calculations.

Check Syntax for a Calculation Policy: Method: post
Path: /api/metric/Calculations/executeCheckSyntax
Create a Calculation Policy: Method: post
Path: /api/metric/Calculations
Delete a Calculation Policy: Method: delete
Path: /api/metric/Calculations/{id}
Get a Calculation Policy by ID: Method: get
Path: /api/metric/Calculations/{id}
Get Calculation Policies: Method: get
Path: /api/metric/Calculations
Get Calculation Policies for Combo Boxes and Item Selectors: Method: get
Path: /api/metric/Calculations/readForSelect
Update a Calculation Policy: Method: put
Path: /api/metric/Calculations/{id}

Metrics/Display Instances

Use for managing display instances which can be used to show a custom name for a metric instance, or for associating a metric instance on a physical device to a virtual device.

Create a Metric Display Instance: Method: post
Path: /api/metric/DisplayInstances
Delete a Metric Display Instance: Method: delete
Path: /api/metric/DisplayInstances/{id}
Get a Metric Display Instance: Method: get
Path: /api/metric/DisplayInstances/{id}
Get Metric Display Instances: Method: get
Path: /api/metric/DisplayInstances
Show Metric Display Instances for Combo Boxes and Item Selectors: Method: get
Path: /api/metric/DisplayInstances/readForSelect
Update a Metric Display Instance: Method: put
Path: /api/metric/DisplayInstances/{id}

Metrics/Measurements

Use for managing metric measurements.

Get a Measurement by ID: Method: get
Path: /api/metric/Measurements/{id}
Get Measurements: Method: get
Path: /api/metric/Measurements

Metrics/Metric Availability Data

Use for managing availability data for metrics of an instance.

Get a Summary of Availability Information for an Instance: Method: get
Path: /api/metric/AvailabilityData/readSummary
Get Availability Data for the Metrics of an Instance: Method: get
Path: /api/metric/AvailabilityData/read

Metrics/Metric Categories

Use for managing metric DDO categories that can be used in dashboards.

Create a Metric Category: Method: post
Path: /api/metric/Categories
Delete a Metric Category: Method: delete
Path: /api/metric/Categories/{id}
Get a Metric Category by ID: Method: get
Path: /api/metric/Categories/{id}
Get Metric Categories: Method: get
Path: /api/metric/Categories
Get Metric Categories for Combo Boxes and Item Selectors: Method: get
Path: /api/metric/Categories/readForSelect
Get the Metric Tabs for a Device: Method: get
Path: /api/metric/Categories/readMetricTabs
Update a Metric Category: Method: put
Path: /api/metric/Categories/{id}
Update the Order of Metric Tabs: Method: put
Path: /api/metric/Categories/updateOrder

Metrics/Metric Collections

Use for managing metric collections.

Create a Metric Collection: Method: post
Path: /api/metric/Collections
Delete a Metric Collection: Method: delete
Path: /api/metric/Collections/{id}
Get a Metric Collection by ID: Method: get
Path: /api/metric/Collections/{id}
Get Metric Collections: Method: get
Path: /api/metric/Collections
Get Metric Collections for Combo Boxes and Item Selectors: Method: get
Path: /api/metric/Collections/readForSelect
Get Metrics in Metric Collections for Combo Boxes and Item Selectors: Method: get
Path: /api/metric/Collections/readMetricsForSelect
Update a Metric Collection: Method: put
Path: /api/metric/Collections/{id}

Metrics/Metric Device Group Availability Data

Use for managing the device group availability panel.

Get a Device Group Name: Method: get
Path: /api/metric/DeviceGroupAvailabilityData/readGroupName
Get Availability Data for a Device Group: Method: get
Path: /api/metric/DeviceGroupAvailabilityData

Metrics/Metric Groups

Use for managing metric groups.

Add a Metric Group: Method: post
Path: /api/metric/MetricGroups
Delete a Metric Group: Method: delete
Path: /api/metric/MetricGroups/{id}
Get a Metric Group by ID: Method: get
Path: /api/metric/MetricGroups/{id}
Get Metric Groups for Combo Boxes and Item Selectors: Method: get
Path: /api/metric/metricGroups/readForSelect
Update a Metric Group: Method: put
Path: /api/metric/MetricGroups/{id}
View all Metric Groups: Method: get
Path: /api/metric/MetricGroups

Metrics/Metric Instances

Use for managing metric instances.

Create a Metric Instance: Method: post
Path: /api/metric/Instances
Delete a Metric Instance: Method: delete
Path: /api/metric/Instances/{id}
Get a Metric Instance by ID: Method: get
Path: /api/metric/Instances/{id}
Get Metric Instances: Method: get
Path: /api/metric/Instances
Get Metric Instances for a Device for Combo Boxes and Item Selectors: Method: get
Path: /api/metric/Instances/readForSelectByDevice
Get Metric Instances for Combo Boxes and Item Selectors: Method: get
Path: /api/metric/Instances/readForSelect
Update a Metric Instance: Method: put
Path: /api/metric/Instances/{id}

Metrics/Metric Threshold Types

Use for viewing metric threshold types.

Get Metric Threshold Types for Combo Boxes and Item Selectors: Method: get
Path: /api/metric/ThresholdTypes/readForSelect

Metrics/Metric Thresholds

Use for managing metric thresholds.

Create a Metric Threshold: Method: post
Path: /api/metric/Thresholds
Delete a Metric Threshold: Method: delete
Path: /api/metric/Thresholds/{id}
Get a Metric Threshold: Method: get
Path: /api/metric/Thresholds/{id}
Get Metric Thresholds: Method: get
Path: /api/metric/Thresholds
Get Metric Thresholds for Combo Boxes and Item Selectors: Method: get
Path: /api/metric/Thresholds/readForSelect
Update a Metric Threshold: Method: put
Path: /api/metric/Thresholds/{id}

Metrics/Metric Transactions

Use for managing metric synthetic transactions.

Check Syntax for a Metric Transaction: Method: post
Path: /api/metric/Transactions/executeCheckSyntax
Create a Metric Transaction: Method: post
Path: /api/metric/Transactions
Delete a Metric Transaction: Method: delete
Path: /api/metric/Transactions/{id}
Get a Metric Transaction: Method: get
Path: /api/metric/Transactions/{id}
Get Metric Transactions: Method: get
Path: /api/metric/Transactions
Get Metric Transactions for Combo Boxes and Item Selectors: Method: get
Path: /api/metric/Transactions/readForSelect
Update a Metric Transaction: Method: put
Path: /api/metric/Transactions/{id}

Metrics/Metric Types

Use for managing metric types.

Create a Metric Type: Method: post
Path: /api/metric/Types
Delete a Metric Type: Method: delete
Path: /api/metric/Types/{id}
Get a Metric Type: Method: get
Path: /api/metric/Types/{id}
Get Metric Types: Method: get
Path: /api/metric/Types
Get Metric Types for Combo Boxes and Item Selectors: Method: get
Path: /api/metric/Types/readForSelect
Update a Metric Type: Method: put
Path: /api/metric/Types/{id}

Metrics/Metrics

Use for managing metrics.

Create a Metric: Method: post
Path: /api/metric/Metrics
Delete a Metric: Method: delete
Path: /api/metric/Metrics/{id}
Get a Metric by ID: Method: get
Path: /api/metric/Metrics/{id}
Get Metrics: Method: get
Path: /api/metric/Metrics
Get Metrics for Combo Boxes and Item Selectors: Method: get
Path: /api/metric/Metrics/readForSelect
Get Metrics for Real and Virtual Devices: Method: get
Path: /api/metric/Metrics/readForAllDevices
Update a Metric: Method: put
Path: /api/metric/Metrics/{id}

Metrics/Network Traffic

Use for viewing all metrics by device.

Get Metrics for a Device: Method: get
Path: /api/metric/NetworkTraffic

Metrics/Performance Data

Use for retrieving performance data.

Get a Navigator Series for a Chart Display: Method: get
Path: /api/metric/PerformanceData/readForNavigator
Get Information About Metrics that can be Graphed: Method: get
Path: /api/metric/PerformanceData/readMetrics
Get Performance Data: Method: get
Path: /api/metric/PerformanceData
Get Performance Data Details for a Grid Display: Method: get
Path: /api/metric/PerformanceData/readDetails
Get Summary Performance Information: Method: get
Path: /api/metric/PerformanceData/readSummary

Metrics/Poller Templates

Use for managing poller templates for use in the Polling Assignments and Polling Policies interfaces.

Create a Poller Template: Method: post
Path: /api/metric/PollerTemplates
Delete a Poller Template: Method: delete
Path: /api/metric/PollerTemplates/{id}
Get a Poller Template: Method: get
Path: /api/metric/PollerTemplates/{id}
Get Poller Templates: Method: get
Path: /api/metric/PollerTemplates
Get Poller Templates for Combo Boxes and Item Selectors: Method: get
Path: /api/metric/PollerTemplates/readForSelect
Update a Poller Template: Method: put
Path: /api/metric/PollerTemplates/{id}

Metrics/Polling Assignments

Use for managing polling assignments.

Create Metrics for Polling Assignments: Method: post
Path: /api/metric/PollingAssignments
Get Polling Assignment Instances: Method: get
Path: /api/metric/PollingAssignments/readInstances

Metrics/Polling Policies

Use for managing metric polling policies that can be used by the Metric Poller Discovery scheduled job.

Create a Polling Policy: Method: post
Path: /api/metric/PollingPolicies
Delete a Polling Policy: Method: delete
Path: /api/metric/PollingPolicies/{id}
Get a Polling Policy: Method: get
Path: /api/metric/PollingPolicies/{id}
Get Polling Policies: Method: get
Path: /api/metric/PollingPolicies
Update a Polling Policy: Method: put
Path: /api/metric/PollingPolicies/{id}

Metrics/Retention Policies

Use for viewing metric data retention policies.

Get Retention Policies for Combo Boxes and Item Selectors: Method: get
Path: /api/metric/RetentionPolicies/readForSelect

Metrics/Threshold Functions

Use for viewing metric threshold functions.

Get Threshold Functions for Combo Boxes and Item Selectors: Method: get
Path: /api/metric/ThresholdFunctions/readForSelect

Metrics/Threshold Groups

Use for managing metric threshold groups.

Create a Metric Threshold Group: Method: post
Path: /api/metric/ThresholdGroups
Delete a Metric Threshold Group: Method: delete
Path: /api/metric/ThresholdGroups/{id}
Get a Metric Threshold Group: Method: get
Path: /api/metric/ThresholdGroups/{id}
Get Metric Threshold Groups: Method: get
Path: /api/metric/ThresholdGroups
Get Metric Threshold Groups for Combo Boxes and Item Selectors: Method: get
Path: /api/metric/ThresholdGroups/readForSelect
Update a Metric Threshold Group: Method: put
Path: /api/metric/ThresholdGroups/{id}

Metrics/TopN Data

Use for retrieving metric TopN overview data.

Get the TopN Overview Title: Method: get
Path: /api/metric/TopNData/readTitle
Get TopN Overview Data: Method: get
Path: /api/metric/TopNData

Microservice/Helm Chart Catalog

Use for listing Helm charts.

Get Available Helm Charts: Method: get
Path: /api/microservice/Catalogs
Get Default Settings for a Helm Chart Repository: Method: get
Path: /api/microservice/Catalogs/readForHelmchartValues
Get Details of a Version of a Helm Chart: Method: get
Path: /api/microservice/Catalogs/readForVersionsDetails
Get Helm Chart Versions: Method: get
Path: /api/microservice/Catalogs/readForVersions

Microservice/Helm Deployment

Use for managing Helm charts, including deploying, undeploying, and getting current deployment details.

Deploy a Helm Chart: Method: post
Path: /api/microservice/Deploy
Get a List of Installed Helm Charts: Method: get
Path: /api/microservice/Deploy/readForInstalled
Get Helm Release Names for a Helm Chart: Method: get
Path: /api/microservice/Deploy/readForReleaseName
Get Namespaces for a Cluster: Method: get
Path: /api/microservice/Deploy/readClusterData
Get the Current Value Settings for a Helm Chart: Method: get
Path: /api/microservice/Deploy
Uninstall Helm Chart: Method: delete
Path: /api/microservice/Deploy/{id}

Microservice/Kubernetes Workload

Use for reading the microservice pod.

Get Details for a Running Cronjob: Method: get
Path: /api/microservice/Workload/readForCronJobDetails
Get Details for a Running Daemonset: Method: get
Path: /api/microservice/Workload/readForDaemonSetDetails
Get Details for a Running Deployment: Method: get
Path: /api/microservice/Workload/readForDeploymentDetails
Get Details for a Running Job: Method: get
Path: /api/microservice/Workload/readForJobDetails
Get Details for a Running Pod: Method: get
Path: /api/microservice/Workload/readForPodDetails
Get Details for a Running Replicaset: Method: get
Path: /api/microservice/Workload/readForReplicaSetDetails
Get Details for a Running Service: Method: get
Path: /api/microservice/Workload/readForServiceDetails
Get Details for a Statefulset: Method: get
Path: /api/microservice/Workload/readForStatefulSetDetails
Get Microservice Container Logs: Method: get
Path: /api/microservice/Workload/readLogs
Get Microservice Workloads for a Tree Grids: Method: get
Path: /api/microservice/Workload/readForTree

Microservice/Microservice Clusters

Use for managing microservice clusters.

Get Clusters: Method: get
Path: /api/microservice/Clusters
Get Nodes and Their Roles within a Cluster: Method: get
Path: /api/microservice/Clusters/readForServers

Navigation/Navigation Bookmarks

Use for managing user bookmarks.

Create a User Bookmark for the Navigation Menu: Method: post
Path: /api/navigation/Bookmarks
Delete a Bookmark: Method: delete
Path: /api/navigation/Bookmarks/{id}
Get All the Bookmarks for an User: Method: get
Path: /api/navigation/Bookmarks
Update a Bookmark: Method: put
Path: /api/navigation/Bookmarks/{id}

Navigation/Navigation Configurations

Use for viewing navigation tree.

Get a List of Search Keywords for Menu: Method: get
Path: /api/navigation/Configurations/readKeywords

Notification/Notification Profiles

Use for managing notification profiles.

Create a Notification Profile: Method: post
Path: /api/notification/Profiles
Delete a Profile by ID: Method: delete
Path: /api/notification/Profiles/{id}
Get a Profile by ID: Method: get
Path: /api/notification/Profiles/{id}
Get Notification Profiles: Method: get
Path: /api/notification/Profiles
Get Notification Profiles for Combo Boxes and Item Selectors: Method: get
Path: /api/notification/Profiles/readForSelect
Update a Notification Profile by ID: Method: put
Path: /api/notification/Profiles/{id}

Notification/Notification Templates

Use for managing notification templates.

Create a Notification Template: Method: post
Path: /api/notification/Templates
Delete a Template by ID: Method: delete
Path: /api/notification/Templates/{id}
Get a Template by ID: Method: get
Path: /api/notification/Templates/{id}
Get Notification Templates: Method: get
Path: /api/notification/Templates
Get Notification Templates for Combo Boxes and Item Selectors: Method: get
Path: /api/notification/Templates/readForSelect
Update a Template by ID: Method: put
Path: /api/notification/Templates/{id}

Package/Package Depots

Use for managing global properties.

Create a Depot: Method: post
Path: /api/package/Depots
Delete a Depot: Method: delete
Path: /api/package/Depots/{id}
Get a Depot by ID: Method: get
Path: /api/package/Depots/{id}
Get Depots: Method: get
Path: /api/package/Depots
Get Package Depots for Combo Boxes and Item Selectors: Method: get
Path: /api/package/Depots/readForSelect
Update a Depot: Method: put
Path: /api/package/Depots/{id}

Report/Report Profiles

Use for managing report profiles.

Create a Report Profile: Method: post
Path: /api/report/Profiles
Delete a Report Profile: Method: delete
Path: /api/report/Profiles/{id}
Get a Profile by ID: Method: get
Path: /api/report/Profiles/{id}
Get Report Profiles: Method: get
Path: /api/report/Profiles
Get Report Profiles for Combo Boxes and Item Selectors: Method: get
Path: /api/report/Profiles/readForSelect
Update a Report Profile: Method: put
Path: /api/report/Profiles/{id}

Report/Reports

Use for managing reports.

Create a Report: Method: post
Path: /api/report/Reports
Delete a Report: Method: delete
Path: /api/report/Reports/{id}
Get a Report by ID: Method: get
Path: /api/report/Reports/{id}
Get Reports: Method: get
Path: /api/report/Reports
Get Reports for Combo Boxes and Item Selectors: Method: get
Path: /api/report/Reports/readForSelect
Start a Report: Method: get
Path: /api/report/Reports/executeStart
Update a Report: Method: put
Path: /api/report/Reports/{id}

Rule/Rule Branches

Use for managing rule branches.

Get Rules Branches for Combo Boxes: Method: get
Path: /api/rule/Branches/readRulesBranches
Show Branches for Combo Boxes and Item Selectors: Method: get
Path: /api/rule/Branches/readForSelect

Rule/Rules

Use for managing rules files.

Check Syntax for a Rule: Method: post
Path: /api/rule/Rules/executeCheckSyntax
Compare Rules Files and Revisions: Method: get
Path: /api/rule/Rules/readDiff
Create a Folder: Method: post
Path: /api/rule/Rules/executeCreateFolder
Create a New Branch From an Existing Branch: Method: post
Path: /api/rule/Rules/createBranch
Create a Rule From Upload: Method: post
Path: /api/rule/Rules/createUploadFile
Create a Rules File: Method: post
Path: /api/rule/Rules/read
Delete a Rules File: Method: delete
Path: /api/rule/Rules/{id}
Download a Rules File: Method: post
Path: /api/rule/Rules/executeDownload
Get a rule by ID: Method: get
Path: /api/rule/Rules/{id}
Get Revision History for a Rules File: Method: get
Path: /api/rule/Rules/readRevisionHistory
Get Rules: Method: get
Path: /api/rule/Rules/read
Revert a Rule to an Earlier Version: Method: put
Path: /api/rule/Rules/executeRevert/{id}
Update a Rules File: Method: put
Path: /api/rule/Rules/{id}

SLM/SLM Navigation

Use for getting information about SLM service for tree views.

Get Constructed Event Filter for SLM Events: Method: get
Path: /api/SLMNavigation/NavServices/readForServiceFilter
Get SLM Service Details for Tree Grids: Method: get
Path: /api/SLMNavigation/NavServices/readForTree
Get the States of SLM Service Nodes Based On Child Nodes: Method: get
Path: /api/SLMNavigation/NavServices/readStates

SLM/SLM Services

Use for managing SLM services.

Create an SLM Service: Method: post
Path: /api/SLM/Services
Delete an SLM Service: Method: delete
Path: /api/SLM/Services/{id}
Get an SLM Service by ID: Method: get
Path: /api/SLM/Services/{id}
Get Full Neo4j Path for a Service: Method: get
Path: /api/SLM/Services/readPathFromServiceID
Get SLM Services: Method: get
Path: /api/SLM/Services
Move SLM Services to a Different Parent: Method: put
Path: /api/SLM/Services/updateMove
Update an SLM Service: Method: put
Path: /api/SLM/Services/{id}

SLM/Service Filters

Use for managing SLM filters.

Create an SLM Filter: Method: post
Path: /api/SLM/ServiceFilters
Delete an SLM Filter: Method: delete
Path: /api/SLM/ServiceFilters/{id}
Get an SLM Filter: Method: get
Path: /api/SLM/ServiceFilters/{id}
Update an SLM Filter: Method: put
Path: /api/SLM/ServiceFilters/{id}

SLM/Service Metrics

Use for managing SLM metrics.

Create an SLM Metric: Method: post
Path: /api/SLM/ServiceMetrics
Delete an SLM Metric: Method: delete
Path: /api/SLM/ServiceMetrics/{id}
Get an SLM Metric: Method: get
Path: /api/SLM/ServiceMetrics/{id}
Get Device Metric Types for Combo Boxes and Item Selectors: Method: get
Path: /api/SLM/ServiceMetrics/readMetricTypes
Get Device Metrics of Specified Metric Type for Combo Boxes and Item Selectors: Method: get
Path: /api/SLM/ServiceMetrics/readMetricInstances
Update an SLM Metric: Method: put
Path: /api/SLM/ServiceMetrics/{id}

SLM/Service Views

Use for retrieving SLM services.

Get SLM Services for Tree Grids: Method: get
Path: /api/SLM/ServiceViews/readForTree

Topology/Topology Menus

Use for managing topology menus.

Create a Menu: Method: post
Path: /api/topology/Menus
Delete a Menu: Method: delete
Path: /api/topology/Menus/{id}
Get a Topology Menu by ID: Method: get
Path: /api/topology/Menus/{id}
Get Tools in a Menu: Method: get
Path: /api/topology/Menus/readForMenu
Get Topology Menus: Method: get
Path: /api/topology/Menus
Get Topology Menus for Combo Boxes and Item Selectors: Method: get
Path: /api/topology/menus/readForSelect
Get Topology Menus for Tree Combos: Method: get
Path: /api/topology/Menus/readForTree
Get Topology Menus for Tree Combos: Method: get
Path: /api/topology/Menus/readForTreeCombo
Move a Topology Menu to a Different Parent: Method: put
Path: /api/topology/Menus/updateMove
Move Topology Menu Tools: Method: put
Path: /api/topology/Menus/updateTools
Update a Topology Menu: Method: put
Path: /api/topology/Menus/{id}

Topology/Topology Network Details

Use for retrieving topology network details.

Get Network Details by Name: Method: get
Path: /api/topology/NetworkDetails
Get Number of Records for Each Network Detail: Method: get
Path: /api/topology/NetworkDetails/readSummary

Topology/Topology Tools

Use for managing topology tools.

Create a Tool: Method: post
Path: /api/topology/Tools
Delete a Tool: Method: delete
Path: /api/topology/Tools/{id}
Execute View Tool: Method: get
Path: /api/topology/Tools/executeViewTool
Get a Topology Tool by ID.: Method: get
Path: /api/topology/Tools/{id}
Get Tools: Method: get
Path: /api/topology/Tools
Get Topology Tools for Combo Boxes and Item Selectors: Method: get
Path: /api/topology/Tools/readForSelect
Update a Tool: Method: put
Path: /api/topology/Tools/{id}