All REST Endpoints
AAA/Authentication Types
Use for managing authentication types.
- Create an Authentication Type Instance
- Method: postPath:
/api/AAA/AuthTypes - Delete an Authentication Type Instance
- Method: deletePath:
/api/AAA/AuthTypes/{id} - Get an Authentication Type Instance by ID
- Method: getPath:
/api/AAA/AuthTypes/{id} - Get Authentication Type Instances
- Method: getPath:
/api/AAA/AuthTypes - Get Authentication Type Instances for Combo Boxes and Item Selectors
- Method: getPath:
/api/AAA/AuthTypes/readForSelect - Update an Authentication Type Instance
- Method: putPath:
/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: getPath:
/api/AAA/Permissions/{id} - Get Permissions
- Method: getPath:
/api/AAA/Permissions - Get Permissions for Combo Boxes and Item Selectors
- Method: getPath:
/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: postPath:
/api/AAA/Preferences - Delete a Preference
- Method: deletePath:
/api/AAA/Preferences/{id} - Get a Preference by ID
- Method: getPath:
/api/AAA/Preferences/{id} - Get Preferences
- Method: getPath:
/api/AAA/Preferences - Get Preferences for Combo Boxes and Item Selectors
- Method: getPath:
/api/AAA/Preferences/readForSelect - Update a Preference
- Method: putPath:
/api/AAA/Preferences/{id}
AAA/Roles
Use for managing roles.
- Create a Role
- Method: postPath:
/api/AAA/Roles - Delete a Role
- Method: deletePath:
/api/AAA/Roles/{id} - Get a Role by ID
- Method: getPath:
/api/AAA/Roles/{id} - Get Roles
- Method: getPath:
/api/AAA/Roles - Get Roles for Combo Boxes and Item Selectors
- Method: getPath:
/api/AAA/Roles/readForSelect - Update a Role
- Method: putPath:
/api/AAA/Roles/{id}
AAA/Tenants
Use for managing tenants.
- Create a Tenant
- Method: postPath:
/api/AAA/Tenants - Delete a Tenant
- Method: deletePath:
/api/AAA/Tenants/{id} - Get a Tenant by ID
- Method: getPath:
/api/AAA/Tenants/{id} - Get Tenants
- Method: getPath:
/api/AAA/Tenants - Update a Tenant
- Method: putPath:
/api/AAA/Tenants/{id}
AAA/User Group Properties
Use for managing user group properties.
- Create a User Group Property
- Method: postPath:
/api/AAA/UserGroupProperties - Delete a User Group Property
- Method: deletePath:
/api/AAA/UserGroupProperties/{id} - Get a User Group Property by ID
- Method: getPath:
/api/AAA/UserGroupProperties/{id} - Get User Group Properties
- Method: getPath:
/api/AAA/UserGroupProperties - Get User Group Properties for Combo Boxes and Item Selectors
- Method: getPath:
/api/AAA/UserGroupProperties/readForSelect - Update a User Group Property
- Method: putPath:
/api/AAA/UserGroupProperties/{id}
AAA/User Groups
Use for managing user groups.
- Create a User Group
- Method: postPath:
/api/AAA/UserGroups - Delete a User Group
- Method: deletePath:
/api/AAA/UserGroups/{id} - Get a User Group by ID
- Method: getPath:
/api/AAA/UserGroups/{id} - Get User Groups
- Method: getPath:
/api/AAA/UserGroups - Get User Groups for Combo Boxes and Item Selectors
- Method: getPath:
/api/AAA/UserGroups/readForSelect - Update a User Group
- Method: putPath:
/api/AAA/UserGroups/{id}
AAA/User Profiles
Use for managing user profiles.
- Get a User Profile by ID
- Method: getPath:
/api/AAA/UserProfiles/{id} - Update a User Profile
- Method: putPath:
/api/AAA/UserProfiles/{id}
AAA/User Properties
Use for managing user properties.
- Create a User Property
- Method: postPath:
/api/AAA/UserProperties - Delete a User Property
- Method: deletePath:
/api/AAA/UserProperties/{id} - Get a User Property by ID
- Method: getPath:
/api/AAA/UserProperties/{id} - Get User Properties
- Method: getPath:
/api/AAA/UserProperties - Get User Properties for Combo Boxes and Item Selectors
- Method: getPath:
/api/AAA/UserProperties/readForSelect - Update a User Property
- Method: putPath:
/api/AAA/UserProperties/{id}
AAA/Users
Use for managing users.
- Create a User
- Method: postPath:
/api/AAA/Users - Delete a User
- Method: deletePath:
/api/AAA/Users/{id} - Get a User by ID
- Method: getPath:
/api/AAA/Users/{id} - Get Users
- Method: getPath:
/api/AAA/Users - Get Users for Combo Boxes and Item Selectors
- Method: getPath:
/api/AAA/Users/readForSelect - Update a User
- Method: putPath:
/api/AAA/Users/{id}
Broker Control/Application Config Types
Use for managing application configuration types.
- Create an Application Configuration Type
- Method: postPath:
/api/broker/ApplicationConfigTypes - Delete an Application Configuration Type
- Method: deletePath:
/api/broker/ApplicationConfigTypes/{id} - Get an Application Configuration Type by ID
- Method: getPath:
/api/broker/ApplicationConfigTypes/{id} - Get Application Configuration Types
- Method: getPath:
/api/broker/ApplicationConfigTypes - Update an Application Configuration Type
- Method: putPath:
/api/broker/ApplicationConfigTypes/{id}
Broker Control/Broker Services
Use for managing broker services.
- Create a Broker Service
- Method: postPath:
/api/broker/Services - Delete a Broker Service
- Method: deletePath:
/api/broker/Services/{id} - Get a Broker Service by ID
- Method: getPath:
/api/broker/Services/{id} - Get Broker Service States
- Method: getPath:
/api/broker/Services/readStates - Get Broker Services
- Method: getPath:
/api/broker/Services - Get Broker Services for Combo Boxes and Item Selectors
- Method: getPath:
/api/broker/Services/readForSelect - Reload Service Configuration
- Method: getPath:
/api/broker/Services/executeReloadConfig - Restart a Service
- Method: getPath:
/api/broker/Services/executeRestart - Start a Service
- Method: getPath:
/api/broker/Services/executeStart - Stop a Service
- Method: getPath:
/api/broker/Services/executeStop - Update a Broker Service
- Method: putPath:
/api/broker/Services/{id}
Broker Control/Failover Service States
Use for viewing broker component failover states.
- Get Details of All Failover Service States
- Method: getPath:
/api/broker/FailoverStates
Broker Control/Jobs
Use for managing jobs.
- Create a Job
- Method: postPath:
/api/broker/Jobs - Delete a Job
- Method: deletePath:
/api/broker/Jobs/{id} - Get a Job by ID
- Method: getPath:
/api/broker/Jobs/{id} - Get Job States
- Method: getPath:
/api/broker/Jobs/readStates - Get Jobs
- Method: getPath:
/api/broker/Jobs - Get Jobs for Combo Boxes and Item Selectors
- Method: getPath:
/api/broker/Jobs/readForSelect - Start a Job
- Method: getPath:
/api/broker/Jobs/executeStart - Update a Job
- Method: putPath:
/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: getPath:
/api/broker/renderTypes/{id} - Get Render Types
- Method: getPath:
/api/broker/renderTypes - Get Render Types for Combo Boxes and Item Selectors
- Method: getPath:
/api/broker/RenderTypes/readForSelect
Broker Control/Servers
Use for managing broker servers.
- Delete a Broker Server
- Method: deletePath:
/api/broker/Servers/{id} - Get a Broker Server by ID
- Method: getPath:
/api/broker/Servers/{id} - Get Acceptance of EULA
- Method: getPath:
/api/broker/Servers/readEULAAcceptance - Get Available Versions of Unified Assurance Package
- Method: getPath:
/api/broker/Servers/readVersions - Get Broker Servers
- Method: getPath:
/api/broker/Servers - Get Broker Servers for Combo Boxes and Item Selectors
- Method: getPath:
/api/broker/Servers/readForSelect - Get Install Status of Server Roles
- Method: getPath:
/api/broker/Servers/readInstallStatus - Get States of Broker Servers
- Method: getPath:
/api/broker/Servers/readStates - Update a Broker Server
- Method: putPath:
/api/broker/Servers/{id} - Update Acceptance of EULA
- Method: putPath:
/api/broker/Servers/updateEULAAcceptance - Update Server Roles
- Method: postPath:
/api/broker/Servers/updateServerRoles - Update Server Version
- Method: postPath:
/api/broker/Servers/updateServers
Core/API Batches
Use for running APIs in batches.
- Run APIs in Batches
- Method: postPath:
/api/core/Batch/execute
Core/Certificate Warning
Use for getting the global settings for certificate warnings.
- Get Global Setting for Certificate Warning
- Method: getPath:
/api/core/CertificateWarning
Core/Global Properties
Use for managing global properties.
- Get a Global Property by ID
- Method: getPath:
/api/core/GlobalProperties/{id} - Get Global Properties
- Method: getPath:
/api/core/GlobalProperties - Update a Global Property
- Method: putPath:
/api/core/GlobalProperties/{id}
Core/Icons
Use for managing icons.
- Create an Icon
- Method: postPath:
/api/core/Icons - Get Icons for Combo Boxes and Item Selectors
- Method: getPath:
/api/core/Icons/readForSelect
Core/Locales
Use for reading locales and translation text.
- Get Locale Information
- Method: getPath:
/api/core/Locales/read/{LocaleValue} - Get Locales for Combo Boxes and Item Selectors
- Method: getPath:
/api/core/Locales/readForSelect
Core/Themes
Use for getting themes.
- Get Themes for Combo Boxes and Item Selectors
- Method: getPath:
/api/core/Themes/readForSelect
Core/Time Zones
Use for getting time zones.
- Get Database Time Zones for Combo Boxes and Item Selectors
- Method: getPath:
/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: postPath:
/api/core/ChangePassword/executeChangePassword - Get Session Data
- Method: getPath:
/api/core/Login/readSessionInfo - Get Session Data as JSON File
- Method: getPath:
/api/core/Login/readSessionInfoJs - Log a User Out
- Method: postPath:
/api/core/Login/executeLogout - Log In and Authenticate a User
- Method: postPath:
/api/core/Login/executeLogin
Dashboards/Dashboard Groups
Use for managing dashboard groups.
- Create a Dashboard Group
- Method: postPath:
/api/dashboard/DashboardGroups - Delete a Dashboard Group
- Method: deletePath:
/api/dashboard/DashboardGroups/{id} - Get a Dashboard Group by ID
- Method: getPath:
/api/dashboard/DashboardGroups/{id} - Get Dashboard Groups for Tree Grids
- Method: getPath:
/api/dashboard/DashboardGroups/readForTree - Get Dashboard Groups for Tree Grids or Form Grids
- Method: getPath:
/api/dashboard/DashboardGroups - Move Dashboard Groups to a Different Parent
- Method: putPath:
/api/dashboard/DashboardGroups/updateMove - Move or Copy Dashboards to a Different Group
- Method: putPath:
/api/dashboard/DashboardGroups/updateDashboards - Update a Dashboard Group
- Method: putPath:
/api/dashboard/DashboardGroups/{id}
Dashboards/Dashboard Navigation
Use for displaying navigation for dashboards and dashboard groups.
- Get Dashboards and Dashboard Groups Under a Specific Node
- Method: getPath:
/api/dashboardNavigation/Dashboards/readForTree
Dashboards/Dashboards
Use for managing dashboards.
- Create a Dashboard
- Method: postPath:
/api/dashboard/Dashboards - Create a Dashboard from a JSON File
- Method: postPath:
/api/dashboard/Dashboards/createImportDashboard - Delete a Dashboard
- Method: deletePath:
/api/dashboard/Dashboards/{id} - Get a Dashboard by ID
- Method: getPath:
/api/dashboard/Dashboards/{id} - Get a JSON String Representation of a Dashboard
- Method: getPath:
/api/dashboard/Dashboards/readExportDashboard - Get Dashboard Part Configurations
- Method: getPath:
/api/dashboard/Dashboards/readParts - Get Dashboards
- Method: getPath:
/api/dashboard/Dashboards - Get Dashboards for Combo Boxes and Item Selectors
- Method: getPath:
/api/dashboard/Dashboards/readForSelect - Update a Dashboard
- Method: putPath:
/api/dashboard/Dashboards/{id}
Databases/Database Queries
Use for managing saved database queries.
- Create a Query
- Method: postPath:
/api/database/Queries - Delete a Query
- Method: deletePath:
/api/database/Queries/{id} - Get a Query by ID
- Method: getPath:
/api/database/Queries/{id} - Get All Tokens of a Query
- Method: getPath:
/api/database/Queries/readTokens - Get Queries
- Method: getPath:
/api/database/Queries - Get Queries for Combo Boxes and Item Selectors
- Method: getPath:
/api/database/Queries/readForSelect - Update a Query
- Method: putPath:
/api/database/Queries/{id}
Databases/Database Query Tools
Use for executing queries.
- Run a Query
- Method: postPath:
/api/database/QueryTools/executeQuery
Databases/Databases
Use for managing databases.
- Create a Database
- Method: postPath:
/api/database/Databases - Delete a Database
- Method: deletePath:
/api/database/Databases/{id} - Get a Database by ID
- Method: getPath:
/api/database/Databases/{id} - Get Database Schemas for Combo Boxes and Item Selectors
- Method: getPath:
/api/database/Databases/readSchemasForSelect - Get Databases
- Method: getPath:
/api/database/Databases - Get Databases for Combo Boxes and Item Selectors
- Method: getPath:
/api/database/Databases/readForSelect - Get States of Databases Based on DatabaseWatchdog
- Method: getPath:
/api/database/Databases/readStates - Update a Database
- Method: putPath:
/api/database/Databases/{id}
Device Catalog/Device Groups
Use for managing device groups.
- Create a Device Group
- Method: postPath:
/api/device/Groups - Delete a Device Group
- Method: deletePath:
/api/device/Groups/{id} - Get a Device Group by ID
- Method: getPath:
/api/device/Groups/{id} - Get a Device Group or Children of a Device Group
- Method: getPath:
/api/device/Groups - Get Device Groups for Tree Combos
- Method: getPath:
/api/device/Groups/readForTreeCombo - Get Device Groups for Tree Grids
- Method: getPath:
/api/device/Groups/readForTree - Move Device Groups to a Different Parent
- Method: putPath:
/api/device/Groups/updateMove - Move or Copy Devices to a Different Group
- Method: putPath:
/api/device/Groups/updateDevices - Update a Device Group
- Method: putPath:
/api/device/Groups/{id}
Device Catalog/Device Maintenance Windows
Use for managing device maintenance windows.
- Create a Device Maintenance Window
- Method: postPath:
/api/device/Windows - Delete a Device Maintenance Window
- Method: deletePath:
/api/device/Windows/{id} - Get a Device Maintenance Window by ID
- Method: getPath:
/api/device/Windows/{id} - Get Device Maintenance Windows
- Method: getPath:
/api/device/Windows - Get Device Maintenance Windows for Combo Boxes and Item Selectors
- Method: getPath:
/api/device/Windows/readForSelect - Update a Device Maintenance Window
- Method: putPath:
/api/device/Windows/{id}
Device Catalog/Device Management
Use for managing multiple devices.
- Delete Multiple Devices
- Method: postPath:
/api/device/DeviceManagement/deleteDevice - Update Device Priority ID
- Method: postPath:
/api/device/DeviceManagement/updatePriority - Update Device Shard ID
- Method: postPath:
/api/device/DeviceManagement/updateShard - Update Device State ID
- Method: postPath:
/api/device/DeviceManagement/updateDiscovery - Update Device State ID to Unmanage a Device
- Method: postPath:
/api/device/DeviceManagement/updateUnmanageDevice - Update Device Type Category by ID
- Method: postPath:
/api/device/DeviceManagement/updateCategory - Update Device Zone ID
- Method: postPath:
/api/device/DeviceManagement/updateZone
Device Catalog/Device Metadata
Use for managing device metadata.
- Get Device Metadata for Combo Boxes and Item Selectors
- Method: getPath:
/api/device/MetaData/readForSelect
Device Catalog/Device Metatypes
Use for managing device metatypes.
- Create a Device Metatype
- Method: postPath:
/api/device/MetaTypes - Delete a Device Metatype
- Method: deletePath:
/api/device/MetaTypes/{id} - Get a Device Metatype by ID
- Method: getPath:
/api/device/MetaTypes/{id} - Get Active Device Metatypes for Combo Boxes and Item Selectors
- Method: getPath:
/api/device/MetaTypes/readForSelectActive - Get Assigned Device Metatypes for Combo Boxes and Item Selectors
- Method: getPath:
/api/device/MetaTypes/readAssignedForSelect - Get Device Metatypes
- Method: getPath:
/api/device/MetaTypes - Get Device Metatypes for Combo Boxes and Item Selectors
- Method: getPath:
/api/device/MetaTypes/readForSelect - Update a Device Metatype
- Method: putPath:
/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: getPath:
/api/deviceNavigation/Devices/readStates - Get Device Availability Details
- Method: getPath:
/api/deviceNavigation/Devices/readStatesAvailability - Get Device Event Details
- Method: getPath:
/api/deviceNavigation/Devices/readStatesEvent - Get Device Groups and Devices in Tree Representation
- Method: getPath:
/api/deviceNavigation/Devices/readForTree - Get Device Threshold Details
- Method: getPath:
/api/deviceNavigation/Devices/readStatesThresholds - Get Device Vertex in Graph Database
- Method: getPath:
/api/deviceNavigation/Devices/readDeviceVertex - Get Devices for Combo Boxes and Item Selectors
- Method: getPath:
/api/deviceNavigation/Devices/readForSelect - Get Network Inventory Status of Devices
- Method: getPath:
/api/deviceNavigation/Devices/readStatesNetworks
Device Catalog/Device Remote
Use for establishing session connections to remote devices with Guacamole.
- Authenticate with Apache Guacamole
- Method: postPath:
/api/device/Remote
Device Catalog/Device Type Categories
Use for managing device type categories.
- Create a Device Type Category
- Method: postPath:
/api/device/Categories - Delete a Device Type Category
- Method: deletePath:
/api/device/Categories/{id} - Delete Multiple Device Type Categories
- Method: postPath:
/api/device/Categories/delete - Get a Device Type Category by ID
- Method: getPath:
/api/device/Categories/{id} - Get Device Type Categories
- Method: getPath:
/api/device/Categories - Get Device Type Categories for Combo Boxes and Item Selectors
- Method: getPath:
/api/device/Categories/readForSelect - Update a Device Type Category
- Method: putPath:
/api/device/Categories/{id}
Device Catalog/Device Type Vendors
Use for managing device type vendors.
- Create a Device Type Vendor
- Method: postPath:
/api/device/Vendors - Delete a Device Type Vendor
- Method: deletePath:
/api/device/Vendors/{id} - Get a Device Type Vendor by ID
- Method: getPath:
/api/device/Vendors/{id} - Get Device Type Vendors
- Method: getPath:
/api/device/Vendors - Get Device Type Vendors for Combo Boxes and Item Selectors
- Method: getPath:
/api/device/Vendors/readForSelect - Update a Device Type Vendor
- Method: putPath:
/api/device/Vendors/{id}
Device Catalog/Device Types
Use for managing device types.
- Create a Device Type
- Method: postPath:
/api/device/Types - Delete a Device Type
- Method: deletePath:
/api/device/Types/{id} - Get a Device Type by ID
- Method: getPath:
/api/device/Types/{id} - Get Device Types
- Method: getPath:
/api/device/Types - Get Device Types for Combo Boxes and Item Selectors
- Method: getPath:
/api/device/Types/readForSelect - Update a Device Type
- Method: putPath:
/api/device/Types/{id}
Device Catalog/Device Views
Use for retrieving device details.
- Get Device Details
- Method: getPath:
/api/device/DeviceViews
Device Catalog/Device Zones
Use for managing device zones.
- Create a Device Zone
- Method: postPath:
/api/device/Zones - Delete a Device Zone
- Method: deletePath:
/api/device/Zones/{id} - Get a Device Zone by ID
- Method: getPath:
/api/device/Zones/{id} - Get Device Zones
- Method: getPath:
/api/device/Zones - Get Device Zones for Combo Boxes and Item Selectors
- Method: getPath:
/api/device/Zones/readForSelect - Update a Device Zone
- Method: putPath:
/api/device/Zones/{id}
Device Catalog/Devices
Use for managing devices.
- Create a Device
- Method: postPath:
/api/device/Devices - Delete a Device
- Method: deletePath:
/api/device/Devices/{id} - Get a Device by ID
- Method: getPath:
/api/device/Devices/{id} - Get an IP Address for a DNS Name
- Method: getPath:
/api/device/Devices/readIpForDns - Get Devices
- Method: getPath:
/api/device/Devices - Get Devices for Combo Boxes and Item Selectors
- Method: getPath:
/api/device/Devices/readForSelect - Update a Device
- Method: putPath:
/api/device/Devices/{id}
Device Configuration/Device Configuration Actions
Use for managing Topology Configuration Agent (TCA) actions.
- Create a Device Configuration Action
- Method: postPath:
/api/config/Actions - Delete a Device Configuration Action
- Method: deletePath:
/api/config/Actions/{id} - Get a Device Configuration Action by ID
- Method: getPath:
/api/config/Actions/{id} - Get Device Configuration Actions
- Method: getPath:
/api/config/Actions - Get Device Configuration Actions for Combo Boxes and Item Selectors
- Method: getPath:
/api/config/Actions/readForSelect - Update a Device Configuration Action
- Method: putPath:
/api/config/Actions/{id}
Device Configuration/Device Configuration Collections
Use for managing Topology Configuration Agent (TCA) collections.
- Create a Device Configuration Collection
- Method: postPath:
/api/config/Collections - Delete a Device Configuration Collection
- Method: deletePath:
/api/config/Collections/{id} - Get a Device Configuration Collection by ID
- Method: getPath:
/api/config/Collections/{id} - Get Device Configuration Collections
- Method: getPath:
/api/config/Collections - Get Device Configuration Collections for Combo Boxes and Item Selectors
- Method: getPath:
/api/config/Collections/readForSelect - Start Config Gatherer Job for a Device
- Method: getPath:
/api/config/Collections/executeRun - Update a Device Configuration Collection
- Method: putPath:
/api/config/Collections/{id}
Device Configuration/Device Configuration Policies
Use for managing Topology Configuration Agent (TCA) policies.
- Create a Device Configuration Policy
- Method: postPath:
/api/config/Policies - Delete a Device Configuration Policy
- Method: deletePath:
/api/config/Policies/{id} - Get a Device Configuration Policy by ID
- Method: getPath:
/api/config/Policies/{id} - Get Device Configuration Policies
- Method: getPath:
/api/config/Policies - Get Device Configuration Policies for Combo Boxes and Item Selectors
- Method: getPath:
/api/config/Policies/readForSelect - Update a Device Configuration Policy
- Method: putPath:
/api/config/Policies/{id}
Device Configuration/Device Configuration Profiles
Use for managing Topology Configuration Agent (TCA) profiles.
- Create a Device Configuration Profile
- Method: postPath:
/api/config/Profiles - Delete a Device Configuration Profile
- Method: deletePath:
/api/config/Profiles/{id} - Get a Device Configuration Profile by ID
- Method: getPath:
/api/config/Profiles/{id} - Get Device Configuration Profiles
- Method: getPath:
/api/config/Profiles - Get Device Configuration Profiles for Combo Boxes and Item Selectors
- Method: getPath:
/api/config/Profiles/readForSelect - Update a Device Configuration Profile
- Method: putPath:
/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: getPath:
/api/config/ViewConfigs/readForSelect - Get Difference between Specified Files or Revisions
- Method: getPath:
/api/config/ViewConfigs/readDiff - Get File Contents for Specified Configuration
- Method: getPath:
/api/config/ViewConfigs/readFile - Get Logs for a Device
- Method: getPath:
/api/config/ViewConfigs/readView - Get Revision History of a File
- Method: getPath:
/api/config/ViewConfigs/readRevisionHistory
Device Discovery/Discovery
Use for executing remote discovery.
- Get Jobs Associated with Specified Server and Job Program
- Method: getPath:
/api/discovery/Discover/readDiscoveryJobJobs - Get Servers Supporting Auto Discovery for Combo Boxes and Item Selectors
- Method: getPath:
/api/discovery/Discover/readServers - Get Servers with Specified Package
- Method: getPath:
/api/discovery/Discover/readDiscoveryJobServers - Get Servers with Specified Package and Job Configuration
- Method: getPath:
/api/discovery/Discover/readDiscoveryJobs - Start an Auto Discovery or SNMP Discovery Job
- Method: getPath:
/api/discovery/Discover/executeRun
Device Discovery/Exclusion Profiles
Use for managing discovery exclusion profiles.
- Create an Exclusion Profile
- Method: postPath:
/api/discovery/Excludes - Delete an Exclusion Profile
- Method: deletePath:
/api/discovery/Excludes/{id} - Get an Exclusion Profile by ID
- Method: getPath:
/api/discovery/Excludes/{id} - Get Discovery Exclusion Profiles
- Method: getPath:
/api/discovery/Excludes - Get Discovery Exclusion Profiles for Combo Boxes and Item Selectors
- Method: getPath:
/api/discovery/Excludes/readForSelect - Update an Exclusion Profile
- Method: putPath:
/api/discovery/Excludes/{id}
Device Discovery/Inclusion Profiles
Use for managing discovery inclusion profiles.
- Create an Inclusion Profile
- Method: postPath:
/api/discovery/Includes - Delete an Inclusion Profile
- Method: deletePath:
/api/discovery/Includes/{id} - Get an Inclusion Profile by ID
- Method: getPath:
/api/discovery/Includes/{id} - Get Discovery Inclusion Profiles
- Method: getPath:
/api/discovery/Includes - Get Discovery Inclusion Profiles for Combo Boxes and Item Selectors
- Method: getPath:
/api/discovery/Includes/readForSelect - Update an Inclusion Profile
- Method: putPath:
/api/discovery/Includes/{id}
Device Discovery/SNMP Access
Use for managing discovery SNMP access Profiles.
- Create an SNMP Access Profile
- Method: postPath:
/api/discovery/Snmp - Delete an SNMP Access Profile
- Method: deletePath:
/api/discovery/Snmp/{id} - Get an SNMP Access Profile by ID
- Method: getPath:
/api/discovery/Snmp/{id} - Get Discovery SNMP Access Profiles
- Method: getPath:
/api/discovery/Snmp - Get Discovery SNMP Access Profiles for Combo Boxes and Item Selectors
- Method: getPath:
/api/discovery/Snmp/readForSelect - Update an SNMP Access Profile
- Method: putPath:
/api/discovery/Snmp/{id} - Update Priority Order of SNMP Access
- Method: getPath:
/api/discovery/Snmp/updateOrder
Diagrams/Diagram Groups
Use for managing diagram groups.
- Create a Diagram Group
- Method: postPath:
/api/diagram/DiagramGroups - Delete a Diagram Group
- Method: deletePath:
/api/diagram/DiagramGroups/{id} - Get a Diagram Group by ID
- Method: getPath:
/api/diagram/DiagramGroups/{id} - Get Diagram Groups
- Method: getPath:
/api/diagram/DiagramGroups - Get Diagram Groups for Tree Combos
- Method: getPath:
/api/diagram/DiagramGroups/readForTreeCombo - Get Diagram Groups for Tree Grids
- Method: getPath:
/api/diagram/DiagramGroups/readForTree - Move Diagram Groups to a Different Parent
- Method: putPath:
/api/diagram/DiagramGroups/updateMove - Move or Copy Diagrams to a Different Group
- Method: putPath:
/api/diagram/DiagramGroups/updateDiagrams - Update a Diagram Group
- Method: putPath:
/api/diagram/DiagramGroups/{id}
Diagrams/Diagram Menus
Use for managing diagram menus.
- Create a Diagram Menu
- Method: postPath:
/api/diagram/Menus - Delete a Diagram Menu
- Method: deletePath:
/api/diagram/Menus/{id} - Get a Diagram Menu by ID
- Method: getPath:
/api/diagram/Menus/{id} - Get Diagram Menus
- Method: getPath:
/api/diagram/Menus - Get Menus for Combo Boxes and Item Selectors
- Method: getPath:
/api/diagram/Menus/readForSelect - Get Menus for Diagram Menu
- Method: getPath:
/api/diagram/Menus/readForMenu - Move a Diagram Menu to a Different Parent
- Method: putPath:
/api/diagram/Menus/updateMove - Move or Copy Diagram Tools to a New Menu
- Method: putPath:
/api/diagram/Menus/updateTools - Update a Diagram Menu
- Method: putPath:
/api/diagram/Menus/{id}
Diagrams/Diagram Navigation
Use for displaying navigation for diagrams and groups.
- Get Diagrams and Groups Under a Specific Node
- Method: getPath:
/api/diagramNavigation/Diagrams/readForTree
Diagrams/Diagram Tools
Use for managing diagram tools.
- Create a Diagram Tool
- Method: postPath:
/api/diagram/Tools - Delete a Diagram Tool
- Method: deletePath:
/api/diagram/Tools/{id} - Get a Diagram Tool by ID
- Method: getPath:
/api/diagram/Tools/{id} - Get Diagram Tools
- Method: getPath:
/api/diagram/Tools - Get Diagram Tools for Combo Boxes and Item Selectors
- Method: getPath:
/api/diagram/Tools/readForSelect - Run a View Tool
- Method: getPath:
/api/diagram/Tools/executeViewTool/{id} - Update a Diagram Tool
- Method: putPath:
/api/diagram/Tools/{id}
Diagrams/Diagram Types
Use for managing diagram types.
- Get Diagram Types for Combo Boxes and Item Selectors
- Method: getPath:
/api/diagram/Types/readForSelect
Diagrams/Diagrams
Use for managing diagrams.
- Create a Diagram
- Method: postPath:
/api/diagram/Diagrams - Delete a Diagram
- Method: deletePath:
/api/diagram/Diagrams/{id} - Get a Diagram by ID
- Method: getPath:
/api/diagram/Diagrams/{id} - Get a Diagram's SVG
- Method: getPath:
/api/diagram/Diagrams/readSVG - Get an SVG Template for a New Diagram
- Method: getPath:
/api/diagram/Diagrams/readNewSVG - Get Diagram Revisions for Combo Boxes and Item Selectors
- Method: getPath:
/api/diagram/Diagrams/readRevisionForSelect - Get Diagram SVG File
- Method: getPath:
/api/diagram/Diagrams/executeDownload - Get Diagrams
- Method: getPath:
/api/diagram/Diagrams - Get Diagrams for Combo Boxes and Item Selectors
- Method: getPath:
/api/diagram/Diagrams/readForSelect - Get the Uploaded SVG Content
- Method: postPath:
/api/diagram/Diagrams/readBack - Revert a Diagram to a Specified Revision
- Method: postPath:
/api/diagram/Diagrams/updateRevision - Update a Diagram
- Method: putPath:
/api/diagram/Diagrams/{id}
Diagrams/Widgets
Use for viewing diagram widgets.
- Get Event Widget Status
- Method: postPath:
/api/diagram/Widgets/readEventStatus - Get Metric Widget Status
- Method: postPath:
/api/diagram/Widgets/readMetricStatus - Get Widgets
- Method: getPath:
/api/diagram/Widgets
Events/CAPE Nodes
Use for managing event CAPE nodes.
- Check Syntax for a CAPE Node
- Method: postPath:
/api/event/Nodes/executeCheckSyntax - Create a CAPE Node
- Method: postPath:
/api/event/Nodes - Delete a CAPE Node
- Method: deletePath:
/api/event/Nodes/{id} - Get a CAPE Node by ID
- Method: getPath:
/api/event/Nodes/{id} - Get CAPE Nodes
- Method: getPath:
/api/event/Nodes - Get CAPE Nodes for Combo Boxes and Item Selectors
- Method: getPath:
/api/event/Nodes/readForSelect - Update a CAPE Node
- Method: putPath:
/api/event/Nodes/{id}
Events/CAPE Policies
Use for managing event CAPE policies.
- Create a CAPE Policy
- Method: postPath:
/api/event/Policies - Delete a CAPE Policy
- Method: deletePath:
/api/event/Policies/{id} - Get a CAPE Policy by ID
- Method: getPath:
/api/event/Policies/{id} - Get CAPE Policies
- Method: getPath:
/api/event/Policies - Get CAPE Policies for Combo Boxes and Item Selectors
- Method: getPath:
/api/event/Policies/readForSelect - Update a CAPE Policy
- Method: putPath:
/api/event/Policies/{id}
Events/Conversions
Use for managing event display conversions
- Create an Event Display Conversion
- Method: postPath:
/api/event/DisplayConversions - Delete an Event Display Conversion
- Method: deletePath:
/api/event/DisplayConversions/{id} - Get an Event Display Conversion by Field Name
- Method: getPath:
/api/event/DisplayConversions/{id} - Get Conversions for a Specific Field for Combo Boxes and Item Selectors
- Method: getPath:
/api/event/DisplayConversions/readForSelect - Get Event Display Conversions
- Method: getPath:
/api/event/DisplayConversions - Get Event Fields from Events for Combo Boxes
- Method: getPath:
/api/event/DisplayConversions/readFieldsForSelect - Update an Event Display Conversion
- Method: putPath:
/api/event/DisplayConversions/{id}
Events/Custom Event Fields
Use for managing custom event fields.
- Create a Custom Event Field
- Method: postPath:
/api/event/customEventFields - Delete a Custom Event Field
- Method: deletePath:
/api/event/customEventFields/{id} - Get a Custom Event Field by ID
- Method: getPath:
/api/event/customEventFields/{id} - Get Custom Event Fields
- Method: getPath:
/api/event/customEventFields - Get Custom Event Fields for Combo Boxes and Item Selectors
- Method: getPath:
/api/event/customEventFields/readForSelect - Update a Custom Event Field
- Method: putPath:
/api/event/customEventFields/{id}
Events/Displays
Use for managing event displays.
- Create an Event Display
- Method: postPath:
/api/event/Displays - Delete an Event Display
- Method: deletePath:
/api/event/Displays/{id} - Get All Columns for New Displays
- Method: getPath:
/api/event/Displays/readAllColumns - Get an Event Display by ID
- Method: getPath:
/api/event/Displays/{id} - Get Event Displays
- Method: getPath:
/api/event/Displays - Get Event Displays for Combo Boxes and Item Selectors
- Method: getPath:
/api/event/Displays/readForSelect - Update an Event Display
- Method: putPath:
/api/event/Displays/{id}
Events/Event Filter Groups
Use for managing event filter groups.
- Create an Event Filter Group
- Method: postPath:
/api/event/FilterGroups - Delete an Event Filter Group
- Method: deletePath:
/api/event/FilterGroups/{id} - Get an Event Filter Group by ID
- Method: getPath:
/api/event/FilterGroups/{id} - Get an Event Filter Group or Children of an Event Filter Group
- Method: getPath:
/api/event/FilterGroups - Get Event Filter Groups for Combo Boxes and Item Selectors
- Method: getPath:
/api/event/FilterGroups/readForSelect - Get Event Filter Groups for Tree Combos
- Method: getPath:
/api/event/FilterGroups/readForTreeCombo - Get Event Filter Groups for Tree Grids
- Method: getPath:
/api/event/FilterGroups/readForTree - Move Event Filter Groups to a Different Parent
- Method: putPath:
/api/event/FilterGroups/updateMove - Move or Copy Event Filters to a Different Group
- Method: putPath:
/api/event/FilterGroups/updateFilters - Update an Event Filter Group
- Method: putPath:
/api/event/FilterGroups/{id}
Events/Event Filters
Use for managing event filters.
- Create an Event Filter
- Method: postPath:
/api/event/Filters - Delete an Event Filter
- Method: deletePath:
/api/event/Filters/{id} - Get an Event Filter by ID
- Method: getPath:
/api/event/Filters/{id} - Get Event Filters
- Method: getPath:
/api/event/Filters - Get Event Filters for Combo Boxes and Item Selectors
- Method: getPath:
/api/event/Filters/readForSelect - Update an Event Filter
- Method: putPath:
/api/event/Filters/{id}
Events/Event Menus
Use for managing event menus.
- Create an Event Menu
- Method: postPath:
/api/event/Menus - Delete an Event Menu
- Method: deletePath:
/api/event/Menus/{id} - Get an Event Menu by ID
- Method: getPath:
/api/event/Menus/{id} - Get Event Menus
- Method: getPath:
/api/event/Menus - Get Event Menus for Tree Grids
- Method: getPath:
/api/event/Menus/readForTree - Get Menu Items of an Event Menu
- Method: getPath:
/api/event/Menus/readForMenu - Move an Event Menu to a Different Parent
- Method: putPath:
/api/event/Menus/updateMove - Move or Copy Event Menu Tools to a Different Menu
- Method: putPath:
/api/event/Menus/updateTools - Update an Event Menu
- Method: putPath:
/api/event/Menus/{id}
Events/Event Navigation
Use for displaying navigation for events and event severity counts.
- Get Event Filters under a Specific Node
- Method: getPath:
/api/eventNavigation/Events/readForTree - Get Severity States and Summary Count of Event Filters
- Method: getPath:
/api/eventNavigation/Events/readStates
Events/Event Tools
Use for managing event tools.
- Create an Event Tool
- Method: postPath:
/api/event/Tools/ - Delete an Event Tool
- Method: deletePath:
/api/event/Tools/{id} - Get an Event Tool by ID
- Method: getPath:
/api/event/Tools/{id} - Get Event Tools
- Method: getPath:
/api/event/Tools/ - Get Event Tools for Combo Boxes and Item Selectors
- Method: getPath:
/api/event/Tools/readForSelect - Update an Event Tool
- Method: putPath:
/api/event/Tools/{id}
Events/Events
Use for managing events.
- Create an Event
- Method: postPath:
/api/event/Events - Delete an Event
- Method: deletePath:
/api/event/Events/{id} - Get an Event by ID
- Method: getPath:
/api/event/Events/{id} - Get Event Filter Fields
- Method: getPath:
/api/event/Events/readFields - Get Event Severities
- Method: getPath:
/api/event/Events/readSeverities - Get Events
- Method: getPath:
/api/event/Events - Get Fields Associated to Events Table in Event Schema
- Method: getPath:
/api/event/Events/readFieldsForSelect - Update an Event
- Method: putPath:
/api/event/Events/{id}
Events/Forensic Views
Use for managing forensic views.
- Get Possible Values for a Field from the Events Table
- Method: getPath:
/api/event/ForensicViews/readFilterOptions
Events/Journals
Use to read and add new event journal entries.
- Create a Journal Entry
- Method: postPath:
/api/event/EventJournals - Get Journal Entries
- Method: getPath:
/api/event/EventJournals
Events/Mechanizations
Use for managing event mechanizations.
- Create an Event Mechanization
- Method: postPath:
/api/event/Mechanizations/ - Delete an Event Mechanization
- Method: deletePath:
/api/event/Mechanizations/{id} - Get an Event Mechanization by ID
- Method: getPath:
/api/event/Mechanizations/{id} - Get Event Mechanizations
- Method: getPath:
/api/event/Mechanizations/ - Get Event Mechanizations for Combo Boxes and Item Selectors
- Method: getPath:
/api/event/Mechanizations/readForSelect - Update an Event Mechanization
- Method: putPath:
/api/event/Mechanizations/{id}
Events/Meta Events
Use for managing meta events.
- Create a Meta Events
- Method: postPath:
/api/event/MetaEvents/ - Delete a Meta Event
- Method: deletePath:
/api/event/MetaEvents/{id} - Get a Meta Event by ID
- Method: getPath:
/api/event/MetaEvents/{id} - Get All Fields from the Events Table
- Method: getPath:
/api/event/MetaEvents/readFields - Get Meta Events
- Method: getPath:
/api/event/MetaEvents/ - Get Meta Events for Combo Boxes and Item Selectors
- Method: getPath:
/api/event/MetaEvents/readForSelect - Update a Meta Events
- Method: putPath:
/api/event/MetaEvents/{id}
Events/Supervised Correlations
Use to correlate events to a root cause and manage symptom events.
- Create an Event Supervised Correlation Policy
- Method: postPath:
/api/event/SupervisedCorrelations/ - Delete an Event Supervised Correlation Policy
- Method: deletePath:
/api/event/SupervisedCorrelations/{id} - Get an Event Supervised Correlation Policy by ID
- Method: getPath:
/api/event/SupervisedCorrelations/{id} - Get Event Keys for Combo Boxes and Item Selectors
- Method: getPath:
/api/event/SupervisedCorrelations/readKeysForSelect - Get Event Supervised Correlation Policies
- Method: getPath:
/api/event/SupervisedCorrelations/ - Update an Event Supervised Correlation Policy
- Method: putPath:
/api/event/SupervisedCorrelations/{id}
Events/Watcher Policies
Use for managing event watcher policies.
- Create an Event Watcher Policy
- Method: postPath:
/api/event/WatcherPolicies - Delete an Event Watcher Policy
- Method: deletePath:
/api/event/WatcherPolicies/{id} - Get an Event Watcher Policy by ID
- Method: getPath:
/api/event/WatcherPolicies/{id} - Get Event Watcher Policies
- Method: getPath:
/api/event/WatcherPolicies - Get Event Watcher Policies for Combo Boxes and Item Selectors
- Method: getPath:
/api/event/WatcherPolicies/readForSelect - Get Events Table Fields
- Method: getPath:
/api/event/WatcherPolicies/readFieldsForSelect - Update an Event Watcher Policy
- Method: putPath:
/api/event/WatcherPolicies/{id}
Files/File Types
Use for managing file types.
- Add a File Type
- Method: postPath:
/api/file/FileTypes - Delete a File Type
- Method: deletePath:
/api/file/FileTypes/{id} - Get a File Type by ID
- Method: getPath:
/api/file/FileTypes/{id} - Get File Types
- Method: getPath:
/api/file/FileTypes - Get File Types for Combo Boxes and Item Selectors
- Method: getPath:
/api/file/FileTypes/readForSelect - Update a File Type
- Method: putPath:
/api/file/FileTypes/{id}
Files/Files
Use for managing files.
- Delete a File
- Method: deletePath:
/api/file/Files/{id} - Download a File
- Method: getPath:
/api/file/Files/executeDownload/{id} - Get a File by ID
- Method: getPath:
/api/file/Files/{id} - Get Files
- Method: getPath:
/api/file/Files - Get Files for Combo Boxes and Item Selectors
- Method: getPath:
/api/file/Files/readForSelect - Return a File Based on ID or File Name
- Method: getPath:
/api/file/Files/readContent - Update a File
- Method: putPath:
/api/file/Files/{id} - Upload a File
- Method: postPath:
/api/file/Files
Gateways/Gateway Elements
Use for managing elements.
- Create an Element Vertex
- Method: postPath:
/api/gateway/Elements - Delete an Element Vertex
- Method: deletePath:
/api/gateway/Elements/{id} - Get an Element by ID
- Method: getPath:
/api/gateway/Elements/{id} - Get Element Objects
- Method: getPath:
/api/gateway/Elements - Get Element Vertices for Combo Boxes and Item Selectors
- Method: getPath:
/api/gateway/Elements/readForSelect - Update an Element Vertex
- Method: putPath:
/api/gateway/Elements/{id}
Gateways/Gateways
Use for managing gateways.
- Create a Gateway Vertex
- Method: postPath:
/api/gateway/Gateways - Delete a Gateway Vertex
- Method: deletePath:
/api/gateway/Gateways/{id} - Get Gateway Objects
- Method: getPath:
/api/gateway/Gateways - Get Gateway Objects by ID
- Method: getPath:
/api/gateway/Gateways/{id} - Get Gateway Vertices for Combo Boxes and Item Selectors
- Method: getPath:
/api/gateway/Gateways/readForSelect - Update a Gateway Vertex
- Method: putPath:
/api/gateway/Gateways/{id}
Graphs/Edge Types
Use for managing graph edge types.
- Create an Edge Type
- Method: postPath:
/api/graph/EdgeTypes - Delete an Edge Type
- Method: deletePath:
/api/graph/EdgeTypes/{id} - Get an Edge Type by ID
- Method: getPath:
/api/graph/EdgeTypes/{id} - Get Edge Types
- Method: getPath:
/api/graph/EdgeTypes - Get Edge Types for Combo Boxes and Item Selectors
- Method: getPath:
/api/graph/EdgeTypes/readForSelect - Update an Edge Type
- Method: putPath:
/api/graph/EdgeTypes/{id}
Graphs/Edges
Use for managing graph edges.
- Create an Edge
- Method: postPath:
/api/graph/Edges - Delete an Edge
- Method: deletePath:
/api/graph/Edges/{id} - Get an Edge by ID
- Method: getPath:
/api/graph/Edges/{id} - Get Edges
- Method: getPath:
/api/graph/Edges - Get Property Values by Edge Type and Property
- Method: getPath:
/api/graph/Edges/readProperties - Update an Edge
- Method: putPath:
/api/graph/Edges/{id}
Graphs/Graphs
Use to gather topology node and edge data.
- Get Topology Vertices and Edges
- Method: getPath:
/api/graph/Graphs/read - Get Topology Vertices and Edges in a Hierarchical Array
- Method: getPath:
/api/graph/Graphs/readForDirectionalTree
Graphs/Node Details
Use for gathering graph node and edge details like availability and status.
- Get the Status of a Topology Widget
- Method: postPath:
/api/graph/NodeDetails/read
Graphs/Property Types
Use for managing property types.
- Create a Property Type
- Method: postPath:
/api/graph/PropertyTypes - Delete a Property Type
- Method: deletePath:
/api/graph/PropertyTypes/{id} - Get a Property Type by ID
- Method: getPath:
/api/graph/PropertyTypes/{id} - Get Objects for Combo Boxes and Item Selectors
- Method: getPath:
/api/graph/PropertyTypes/readForSelect - Get Property Types
- Method: getPath:
/api/graph/PropertyTypes - Update a Property Type
- Method: putPath:
/api/graph/PropertyTypes/{id}
Graphs/Vertex Types
Use for managing vertex types.
- Create a Vertex Type
- Method: postPath:
/api/graph/VertexTypes - Delete a Vertex Type
- Method: deletePath:
/api/graph/VertexTypes/{id} - Get a Vertex Type by ID
- Method: getPath:
/api/graph/VertexTypes/{id} - Get Vertex Types
- Method: getPath:
/api/graph/VertexTypes - Gets Objects for Combo Boxes and Item Selectors
- Method: getPath:
/api/graph/VertexTypes/readForSelect - Update a Vertex Type
- Method: putPath:
/api/graph/VertexTypes/{id}
Graphs/Vertices
Use for managing vertices.
- Create a Vertex
- Method: postPath:
/api/graph/Vertices - Delete a Vertex
- Method: deletePath:
/api/graph/Vertices/{id} - Get a Vertex by ID
- Method: getPath:
/api/graph/Vertices/{id} - Get Device Vertices
- Method: getPath:
/api/graph/Vertices/readDevicesForSelect - Get Objects for Combo Boxes and Item Selectors
- Method: getPath:
/api/graph/Vertices/readForSelect - Get Property Values by Vertex Type and Property
- Method: getPath:
/api/graph/Vertices/readProperties - Get Vertices
- Method: getPath:
/api/graph/Vertices - Update a Vertex
- Method: putPath:
/api/graph/Vertices/{id}
Links/Link Groups
Use for managing link groups.
- Create a Link Group
- Method: postPath:
/api/link/LinkGroups/ - Delete a Link Group
- Method: deletePath:
/api/link/LinkGroups/{id} - Get a Link Group
- Method: getPath:
/api/link/LinkGroups/{id} - Get Link Groups for Tree Grids
- Method: getPath:
/api/link/LinkGroups/readForTree - Get Link Groups for Tree Grids or Form Grids
- Method: getPath:
/api/link/LinkGroups/ - Move Link Groups to a Different Parent
- Method: putPath:
/api/link/LinkGroups/updateMove - Move or Copy Links to a Different Group
- Method: putPath:
/api/link/LinkGroups/updateLinks - Update a Link Group
- Method: putPath:
/api/link/LinkGroups/{id}
Links/Link Navigation
Use for displaying navigation for links.
- Get Links and Link Groups Under a Specific Node
- Method: getPath:
/api/link/LinkNavigation/readForTree
Links/Links
Use for managing links.
- Create a Link
- Method: postPath:
/api/link/Links/ - Delete a Link
- Method: deletePath:
/api/link/Links/{id} - Get a Link by ID
- Method: getPath:
/api/link/Links/{id} - Get Links
- Method: getPath:
/api/link/Links/ - Get Links for Combo Boxes and Item Selectors
- Method: getPath:
/api/link/Links/readForSelect - Update a Link
- Method: putPath:
/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: postPath:
/api/metric/AbnormalProfiles - Delete an Abnormal Profile
- Method: deletePath:
/api/metric/AbnormalProfiles/{id} - Get Abnormal Profiles
- Method: getPath:
/api/metric/AbnormalProfiles - Get Abnormal Profiles for Combo Boxes and Item Selectors
- Method: getPath:
/api/metric/AbnormalProfiles/readForSelect - Get an Abnormal Profile by ID
- Method: getPath:
/api/metric/AbnormalProfiles/{id} - Update an Abnormal Profile
- Method: putPath:
/api/metric/AbnormalProfiles/{id}
Metrics/All Metrics Overview
Use for viewing selected metrics and the associated data.
- Get Metrics for an Instance
- Method: getPath:
/api/metric/allMetricsOverview
Metrics/Calculations
Use for managing metric post-collection calculations.
- Check Syntax for a Calculation Policy
- Method: postPath:
/api/metric/Calculations/executeCheckSyntax - Create a Calculation Policy
- Method: postPath:
/api/metric/Calculations - Delete a Calculation Policy
- Method: deletePath:
/api/metric/Calculations/{id} - Get a Calculation Policy by ID
- Method: getPath:
/api/metric/Calculations/{id} - Get Calculation Policies
- Method: getPath:
/api/metric/Calculations - Get Calculation Policies for Combo Boxes and Item Selectors
- Method: getPath:
/api/metric/Calculations/readForSelect - Update a Calculation Policy
- Method: putPath:
/api/metric/Calculations/{id}
Metrics/Device Group Availability Data
The operations from the Metrics/Device Group Availability Data category.
- Get a Device Group Name
- Method: getPath:
/api/metric/DeviceGroupAvailabilityData/readGroupName - Get Availability Data for a Device Group
- Method: getPath:
/api/metric/DeviceGroupAvailabilityData
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: postPath:
/api/metric/DisplayInstances - Delete a Metric Display Instance
- Method: deletePath:
/api/metric/DisplayInstances/{id} - Get a Metric Display Instance
- Method: getPath:
/api/metric/DisplayInstances/{id} - Get Metric Display Instances
- Method: getPath:
/api/metric/DisplayInstances - Get Metric Display Instances for Combo Boxes and Item Selectors
- Method: getPath:
/api/metric/DisplayInstances/readForSelect - Update a Metric Display Instance
- Method: putPath:
/api/metric/DisplayInstances/{id}
Metrics/Measurements
Use for managing metric measurements.
- Get a Measurement by Name
- Method: getPath:
/api/metric/Measurements/{name} - Get Measurements
- Method: getPath:
/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: getPath:
/api/metric/AvailabilityData/readSummary - Get Metric Availability Data
- Method: getPath:
/api/metric/AvailabilityData/read
Metrics/Metric Categories
Use for managing metric DDO categories that can be used in dashboards.
- Create a Metric Category
- Method: postPath:
/api/metric/Categories - Delete a Metric Category
- Method: deletePath:
/api/metric/Categories/{id} - Get a Metric Category by ID
- Method: getPath:
/api/metric/Categories/{id} - Get Metric Categories
- Method: getPath:
/api/metric/Categories - Get Metric Categories for Combo Boxes and Item Selectors
- Method: getPath:
/api/metric/Categories/readForSelect - Get the Metric Tabs for a Device
- Method: getPath:
/api/metric/Categories/readMetricTabs - Update a Metric Category
- Method: putPath:
/api/metric/Categories/{id} - Update the Order of Metric Tabs
- Method: putPath:
/api/metric/Categories/updateOrder
Metrics/Metric Collections
Use for managing metric collections.
- Create a Metric Collection
- Method: postPath:
/api/metric/Collections - Delete a Metric Collection
- Method: deletePath:
/api/metric/Collections/{id} - Get a Metric Collection by ID
- Method: getPath:
/api/metric/Collections/{id} - Get Metric Collections
- Method: getPath:
/api/metric/Collections - Get Metric Collections for Combo Boxes and Item Selectors
- Method: getPath:
/api/metric/Collections/readForSelect - Get Metrics in Metric Collections for Combo Boxes and Item Selectors
- Method: getPath:
/api/metric/Collections/readMetricsForSelect - Update a Metric Collection
- Method: putPath:
/api/metric/Collections/{id}
Metrics/Metric Groups
Use for managing metric groups.
- Add a Metric Group
- Method: postPath:
/api/metric/MetricGroups - Delete a Metric Group
- Method: deletePath:
/api/metric/MetricGroups/{id} - Get a Metric Group by ID
- Method: getPath:
/api/metric/MetricGroups/{id} - Get Metric Groups for Combo Boxes and Item Selectors
- Method: getPath:
/api/metric/metricGroups/readForSelect - Update a Metric Group
- Method: putPath:
/api/metric/MetricGroups/{id} - View all Metric Groups
- Method: getPath:
/api/metric/MetricGroups
Metrics/Metric Instances
Use for managing metric instances.
- Create a Metric Instance
- Method: postPath:
/api/metric/Instances - Delete a Metric Instance
- Method: deletePath:
/api/metric/Instances/{id} - Get a Metric Instance by ID
- Method: getPath:
/api/metric/Instances/{id} - Get Metric Instances
- Method: getPath:
/api/metric/Instances - Get Metric Instances for a Device for Combo Boxes and Item Selectors
- Method: getPath:
/api/metric/Instances/readForSelectByDevice - Get Metric Instances for Combo Boxes and Item Selectors
- Method: getPath:
/api/metric/Instances/readForSelect - Update a Metric Instance
- Method: putPath:
/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: getPath:
/api/metric/ThresholdTypes/readForSelect
Metrics/Metric Thresholds
Use for managing metric thresholds.
- Create a Metric Threshold
- Method: postPath:
/api/metric/Thresholds - Delete a Metric Threshold
- Method: deletePath:
/api/metric/Thresholds/{id} - Get a Metric Threshold
- Method: getPath:
/api/metric/Thresholds/{id} - Get Metric Thresholds
- Method: getPath:
/api/metric/Thresholds - Get Metric Thresholds for Combo Boxes and Item Selectors
- Method: getPath:
/api/metric/Thresholds/readForSelect - Update a Metric Threshold
- Method: putPath:
/api/metric/Thresholds/{id}
Metrics/Metric Transactions
Use for managing metric synthetic transactions.
- Check Syntax for a Metric Transaction
- Method: postPath:
/api/metric/Transactions/executeCheckSyntax - Create a Metric Transaction
- Method: postPath:
/api/metric/Transactions - Delete a Metric Transaction
- Method: deletePath:
/api/metric/Transactions/{id} - Get a Metric Transaction
- Method: getPath:
/api/metric/Transactions/{id} - Get Metric Transactions
- Method: getPath:
/api/metric/Transactions - Get Metric Transactions for Combo Boxes and Item Selectors
- Method: getPath:
/api/metric/Transactions/readForSelect - Update a Metric Transaction
- Method: putPath:
/api/metric/Transactions/{id}
Metrics/Metric Types
Use for managing metric types.
- Create a Metric Type
- Method: postPath:
/api/metric/Types - Delete a Metric Type
- Method: deletePath:
/api/metric/Types/{id} - Get a Metric Type
- Method: getPath:
/api/metric/Types/{id} - Get Metric Types
- Method: getPath:
/api/metric/Types - Get Metric Types for Combo Boxes and Item Selectors
- Method: getPath:
/api/metric/Types/readForSelect - Update a Metric Type
- Method: putPath:
/api/metric/Types/{id}
Metrics/Metrics
Use for managing metrics.
- Create a Metric
- Method: postPath:
/api/metric/Metrics - Delete a Metric
- Method: deletePath:
/api/metric/Metrics/{id} - Get a Metric by ID
- Method: getPath:
/api/metric/Metrics/{id} - Get Metrics
- Method: getPath:
/api/metric/Metrics - Get Metrics for Combo Boxes and Item Selectors
- Method: getPath:
/api/metric/Metrics/readForSelect - Get Metrics for Real and Virtual Devices
- Method: getPath:
/api/metric/Metrics/readForAllDevices - Update a Metric
- Method: putPath:
/api/metric/Metrics/{id}
Metrics/Network Traffic
Use for viewing all metrics by device.
- Get Metrics for a Device
- Method: getPath:
/api/metric/NetworkTraffic
Metrics/Performance Data
Use for retrieving performance data.
- Get a Navigator Series for a Chart Display
- Method: getPath:
/api/metric/PerformanceData/readForNavigator - Get Information About Metrics for Graphs
- Method: getPath:
/api/metric/PerformanceData/readMetrics - Get Performance Data
- Method: getPath:
/api/metric/PerformanceData - Get Performance Data Details for a Grid Display
- Method: getPath:
/api/metric/PerformanceData/readDetails - Get Summary Performance Information
- Method: getPath:
/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: postPath:
/api/metric/PollerTemplates - Delete a Poller Template
- Method: deletePath:
/api/metric/PollerTemplates/{id} - Get a Poller Template
- Method: getPath:
/api/metric/PollerTemplates/{id} - Get Poller Templates
- Method: getPath:
/api/metric/PollerTemplates - Get Poller Templates for Combo Boxes and Item Selectors
- Method: getPath:
/api/metric/PollerTemplates/readForSelect - Update a Poller Template
- Method: putPath:
/api/metric/PollerTemplates/{id}
Metrics/Polling Assignments
Use for managing polling assignments.
- Create Metrics for Polling Assignments
- Method: postPath:
/api/metric/PollingAssignments - Get Polling Assignment Instances
- Method: getPath:
/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: postPath:
/api/metric/PollingPolicies - Delete a Polling Policy
- Method: deletePath:
/api/metric/PollingPolicies/{id} - Get a Polling Policy
- Method: getPath:
/api/metric/PollingPolicies/{id} - Get Polling Policies
- Method: getPath:
/api/metric/PollingPolicies - Update a Polling Policy
- Method: putPath:
/api/metric/PollingPolicies/{id}
Metrics/Retention Policies
Use for viewing metric data retention policies.
- Get Retention Policies for Combo Boxes and Item Selectors
- Method: getPath:
/api/metric/RetentionPolicies/readForSelect
Metrics/Threshold Functions
Use for viewing metric threshold functions.
- Get Threshold Functions for Combo Boxes and Item Selectors
- Method: getPath:
/api/metric/ThresholdFunctions/readForSelect
Metrics/Threshold Groups
Use for managing metric threshold groups.
- Create a Metric Threshold Group
- Method: postPath:
/api/metric/ThresholdGroups - Delete a Metric Threshold Group
- Method: deletePath:
/api/metric/ThresholdGroups/{id} - Get a Metric Threshold Group
- Method: getPath:
/api/metric/ThresholdGroups/{id} - Get Metric Threshold Groups
- Method: getPath:
/api/metric/ThresholdGroups - Get Metric Threshold Groups for Combo Boxes and Item Selectors
- Method: getPath:
/api/metric/ThresholdGroups/readForSelect - Update a Metric Threshold Group
- Method: putPath:
/api/metric/ThresholdGroups/{id}
Metrics/TopN Data
Use for retrieving metric TopN overview data.
- Get the TopN Overview Title
- Method: getPath:
/api/metric/TopNData/readTitle - Get TopN Overview Data
- Method: getPath:
/api/metric/TopNData
Microservices/Helm Chart Catalog
Use for listing Helm charts.
- Get Available Helm Charts
- Method: getPath:
/api/microservice/Catalogs - Get Default Settings for a Helm Chart Repository
- Method: getPath:
/api/microservice/Catalogs/readForHelmchartValues - Get Details of a Version of a Helm Chart
- Method: getPath:
/api/microservice/Catalogs/readForVersionsDetails - Get Helm Chart Versions
- Method: getPath:
/api/microservice/Catalogs/readForVersions
Microservices/Helm Deployment
Use for managing Helm charts, including deploying, undeploying, and getting current deployment details.
- Deploy a Helm Chart
- Method: postPath:
/api/microservice/Deploy - Get a List of Installed Helm Charts
- Method: getPath:
/api/microservice/Deploy/readForInstalled - Get Helm Release Names for a Helm Chart
- Method: getPath:
/api/microservice/Deploy/readForReleaseName - Get Namespaces for a Cluster
- Method: getPath:
/api/microservice/Deploy/readClusterData - Get the Current Value Settings for a Helm Chart
- Method: getPath:
/api/microservice/Deploy - Uninstall Helm Chart
- Method: deletePath:
/api/microservice/Deploy/{id}
Microservices/Kubernetes Workload
Use for reading the microservice pod.
- Get Details for a Running Cronjob
- Method: getPath:
/api/microservice/Workload/readForCronJobDetails - Get Details for a Running Daemonset
- Method: getPath:
/api/microservice/Workload/readForDaemonSetDetails - Get Details for a Running Deployment
- Method: getPath:
/api/microservice/Workload/readForDeploymentDetails - Get Details for a Running Job
- Method: getPath:
/api/microservice/Workload/readForJobDetails - Get Details for a Running Pod
- Method: getPath:
/api/microservice/Workload/readForPodDetails - Get Details for a Running Replicaset
- Method: getPath:
/api/microservice/Workload/readForReplicaSetDetails - Get Details for a Running Service
- Method: getPath:
/api/microservice/Workload/readForServiceDetails - Get Details for a Statefulset
- Method: getPath:
/api/microservice/Workload/readForStatefulSetDetails - Get Microservice Container Logs
- Method: getPath:
/api/microservice/Workload/readLogs - Get Microservice Workloads for a Tree Grids
- Method: getPath:
/api/microservice/Workload/readForTree
Microservices/Microservice Clusters
Use for managing microservice clusters.
- Get Clusters
- Method: getPath:
/api/microservice/Clusters - Get Nodes and Their Roles within a Cluster
- Method: getPath:
/api/microservice/Clusters/readForServers
Navigation/Bookmarks
Use for managing user bookmarks.
- Create a Bookmark for a User
- Method: postPath:
/api/navigation/Bookmarks - Delete a Bookmark
- Method: deletePath:
/api/navigation/Bookmarks/{id} - Get a User's Bookmarks
- Method: getPath:
/api/navigation/Bookmarks - Update a Bookmark
- Method: putPath:
/api/navigation/Bookmarks/{id}
Navigation/Navigation Configurations
Use for viewing keywords.
- Get a List of Search Keywords for Menu
- Method: getPath:
/api/navigation/Configurations/readKeywords
Notification/Notification Profiles
Use for managing notification profiles.
- Create a Notification Profile
- Method: postPath:
/api/notification/Profiles - Delete a Profile by ID
- Method: deletePath:
/api/notification/Profiles/{id} - Get a Notification Profile by ID
- Method: getPath:
/api/notification/Profiles/{id} - Get Notification Profiles
- Method: getPath:
/api/notification/Profiles - Get Notification Profiles for Combo Boxes and Item Selectors
- Method: getPath:
/api/notification/Profiles/readForSelect - Update a Notification Profile by ID
- Method: putPath:
/api/notification/Profiles/{id}
Notification/Notification Templates
Use for managing notification templates.
- Create a Notification Template
- Method: postPath:
/api/notification/Templates - Delete a Template by ID
- Method: deletePath:
/api/notification/Templates/{id} - Get a Template by ID
- Method: getPath:
/api/notification/Templates/{id} - Get Notification Templates
- Method: getPath:
/api/notification/Templates - Get Notification Templates for Combo Boxes and Item Selectors
- Method: getPath:
/api/notification/Templates/readForSelect - Update a Template by ID
- Method: putPath:
/api/notification/Templates/{id}
Packages/Package Depots
Use for managing global properties.
- Create a Depot
- Method: postPath:
/api/package/Depots - Delete a Depot
- Method: deletePath:
/api/package/Depots/{id} - Get a Depot by ID
- Method: getPath:
/api/package/Depots/{id} - Get Depots
- Method: getPath:
/api/package/Depots - Get Package Depots for Combo Boxes and Item Selectors
- Method: getPath:
/api/package/Depots/readForSelect - Update a Depot
- Method: putPath:
/api/package/Depots/{id}
Reports/Report Profiles
Use for managing report profiles.
- Create a Report Profile
- Method: postPath:
/api/report/Profiles - Delete a Report Profile
- Method: deletePath:
/api/report/Profiles/{id} - Get a Report Profile by ID
- Method: getPath:
/api/report/Profiles/{id} - Get Report Profiles
- Method: getPath:
/api/report/Profiles - Get Report Profiles for Combo Boxes and Item Selectors
- Method: getPath:
/api/report/Profiles/readForSelect - Update a Report Profile
- Method: putPath:
/api/report/Profiles/{id}
Reports/Reports
Use for managing reports.
- Create a Report
- Method: postPath:
/api/report/Reports - Delete a Report
- Method: deletePath:
/api/report/Reports/{id} - Get a Report by ID
- Method: getPath:
/api/report/Reports/{id} - Get Reports
- Method: getPath:
/api/report/Reports - Get Reports for Combo Boxes and Item Selectors
- Method: getPath:
/api/report/Reports/readForSelect - Start a Report
- Method: getPath:
/api/report/Reports/executeStart - Update a Report
- Method: putPath:
/api/report/Reports/{id}
Rules/Rule Branches
Use for managing rule branches.
- Get Rules Branches for Combo Boxes
- Method: getPath:
/api/rule/Branches/readRulesBranches - Show Branches for Combo Boxes and Item Selectors
- Method: getPath:
/api/rule/Branches/readForSelect
Rules/Rules
Use for managing rules files.
- Check Syntax for a Rule
- Method: postPath:
/api/rule/Rules/executeCheckSyntax - Compare Rules Files and Revisions
- Method: getPath:
/api/rule/Rules/readDiff - Create a Folder
- Method: postPath:
/api/rule/Rules/executeCreateFolder - Create a New Branch From an Existing Branch
- Method: postPath:
/api/rule/Rules/createBranch - Create a Rule From Upload
- Method: postPath:
/api/rule/Rules/createUploadFile - Create a Rules File
- Method: postPath:
/api/rule/Rules - Delete a Rules File
- Method: deletePath:
/api/rule/Rules/{id} - Download a Rules File
- Method: postPath:
/api/rule/Rules/executeDownload - Get a Rule by ID
- Method: getPath:
/api/rule/Rules/{id} - Get Revision History for a Rules File
- Method: getPath:
/api/rule/Rules/readRevisionHistory - Get Rules
- Method: getPath:
/api/rule/Rules/read - Revert a Rule to an Earlier Version
- Method: putPath:
/api/rule/Rules/executeRevert/{id} - Update a Rules File
- Method: putPath:
/api/rule/Rules/{id}
SLM/SLM Navigation
Use for displaying navigation for SLM services.
- Get Constructed Event Filter for SLM Events
- Method: getPath:
/api/SLMNavigation/NavServices/readForServiceFilter - Get SLM Service Details for Tree Grids
- Method: getPath:
/api/SLMNavigation/NavServices/readForTree - Get the States of SLM Service Nodes Based On Child Nodes
- Method: getPath:
/api/SLMNavigation/NavServices/readStates
SLM/SLM Services
Use for managing SLM services.
- Create an SLM Service
- Method: postPath:
/api/SLM/Services - Delete an SLM Service
- Method: deletePath:
/api/SLM/Services/{id} - Get an SLM Service by ID
- Method: getPath:
/api/SLM/Services/{id} - Get Full Neo4j Path for a Service
- Method: getPath:
/api/SLM/Services/readPathFromServiceID - Get SLM Services
- Method: getPath:
/api/SLM/Services - Move SLM Services to a Different Parent
- Method: putPath:
/api/SLM/Services/updateMove - Update an SLM Service
- Method: putPath:
/api/SLM/Services/{id}
SLM/Service Filters
Use for managing SLM filters.
- Create an SLM Filter
- Method: postPath:
/api/SLM/ServiceFilters - Delete an SLM Filter
- Method: deletePath:
/api/SLM/ServiceFilters/{id} - Get an SLM Filter
- Method: getPath:
/api/SLM/ServiceFilters/{id} - Update an SLM Filter
- Method: putPath:
/api/SLM/ServiceFilters/{id}
SLM/Service Metrics
Use for managing SLM metrics.
- Create an SLM Metric
- Method: postPath:
/api/SLM/ServiceMetrics - Delete an SLM Metric
- Method: deletePath:
/api/SLM/ServiceMetrics/{id} - Get an SLM Metric
- Method: getPath:
/api/SLM/ServiceMetrics/{id} - Get Device Metric Types for Combo Boxes and Item Selectors
- Method: getPath:
/api/SLM/ServiceMetrics/readMetricTypes - Get Device Metrics of Specified Metric Type for Combo Boxes and Item Selectors
- Method: getPath:
/api/SLM/ServiceMetrics/readMetricInstances - Update an SLM Metric
- Method: putPath:
/api/SLM/ServiceMetrics/{id}
SLM/Service Views
Use for retrieving SLM services.
- Get SLM Services for Tree Grids
- Method: getPath:
/api/SLM/ServiceViews/readForTree
Topology/Topology Menus
Use for managing topology menus.
- Create a Menu
- Method: postPath:
/api/topology/Menus - Delete a Menu
- Method: deletePath:
/api/topology/Menus/{id} - Get a Topology Menu by ID.
- Method: getPath:
/api/topology/Menus/{id} - Get Tools in a Menu
- Method: getPath:
/api/topology/Menus/readForMenu - Get Topology Menus
- Method: getPath:
/api/topology/Menus - Get Topology Menus for Combo Boxes and Item Selectors
- Method: getPath:
/api/topology/menus/readForSelect - Get Topology Menus for Tree Combos
- Method: getPath:
/api/topology/Menus/readForTree - Get Topology Menus for Tree Combos
- Method: getPath:
/api/topology/Menus/readForTreeCombo - Move a Topology Menu to a Different Parent
- Method: putPath:
/api/topology/Menus/updateMove - Move Topology Menu Tools
- Method: putPath:
/api/topology/Menus/updateTools - Update a Topology Menu
- Method: putPath:
/api/topology/Menus/{id}
Topology/Topology Network Details
Use for retrieving topology network details.
- Get Network Details by Name
- Method: getPath:
/api/topology/NetworkDetails - Get Number of Records for Each Network Detail
- Method: getPath:
/api/topology/NetworkDetails/readSummary
Topology/Topology Tools
Use for managing topology tools.
- Create a Topology Tool
- Method: postPath:
/api/topology/Tools - Delete a Topology Tool
- Method: deletePath:
/api/topology/Tools/{id} - Get a Topology Tool by ID
- Method: getPath:
/api/topology/Tools/{id} - Get Topology Tools
- Method: getPath:
/api/topology/Tools - Get Topology Tools for Combo Boxes and Item Selectors
- Method: getPath:
/api/topology/Tools/readForSelect - Run a Topology View Tool
- Method: getPath:
/api/topology/Tools/executeViewTool - Update a Topology Tool
- Method: putPath:
/api/topology/Tools/{id}