SevOne Data Platform Endpoint Mapping Guide
About
This document contains the following tables:
- SOAP API > REST API v3 Mappings where SOAP API endpoints have been migrated to REST API v3
- REST API v2 > REST API v3 Mappings where REST API v2 endpoints have been migrated to REST API v3
Important:
By default, REST API v2 endpoints are hidden. To enable, please contact IBM SevOne Support Team.
SOAP API > REST API v3 Mappings
Important: In the table below, you will notice that some SOAP API endpoints have not
yet been migrated to REST API v3. The migration task will continue in the future SevOne NMS
release(s).
| SOAP API | REST API v3 | NOTES |
|---|---|---|
| alert_clearByAlertId | ||
| alert_getAlerts | POST / GET /api/v3/data/alerts GET /api/v3/data/alerts/{id} | Can filter on closed, open, or both, instead of SOAP's $cleared bool value.Richer filtering options |
| authenticate | POST /api/v3/users/signin | |
| core_createDevice | POST /api/v3/devices/data | |
| core_createDeviceInGroup | ||
| core_deleteDevice | DELETE /api/v3/devices | |
| core_getDeviceById | GET / POST /api/v3/metadata/devices | Richer filtering options |
| core_getDeviceByName | GET / POST /api/v3/metadata/devices | |
| core_getDeviceIdsByIp | GET / POST /api/v3/metadata/devices | |
| core_getDeviceMoveStatus | ||
| core_getEnabledPluginsByDeviceId | POST /api/v3/devices/stream | |
| core_getObjectById | POST /api/v3/metadata/objects | You can't filter by objectID, but there are many additional filter options |
| core_getPeers | POST / GET /api/v3/peers | Richer filtering options |
| core_rediscoverDevice | SOA can't kick off a discovery | |
| core_setDeviceDiscovery | ||
| core_setDeviceIcmpInformation | ||
| core_setDeviceInformationExt | ||
| core_setDeviceSnmpInformation | ||
| devicetype_getDeviceTypeIdsByDeviceId | POST / GET /api/v3/metadata/device_types POST / GET /api/v3/devicetypes/filter | Gives all device type information, not just IDs,Filtering optionsVarious filtering options |
| factory_Graph | ||
| factory_GraphDataSource | ||
| factory_Metadata_Mapping_Value | ||
| factory_Timespan | ||
| getAuthenticatedUid | ||
| group_getDeviceGroupById | GET /api/v3/devicegroups/{id} | |
| group_getDeviceGroupIdByName | No name filtering | |
| group_getDevicesByGroupId | ||
| group_getObjectGroupIdByName | ||
| group_getObjectGroupRulesByGroupId | ||
| group_getObjectsByObjectGroupId | ||
| metadata_createMappingToDevice | ||
| metadata_getAttributes | ||
| metadata_getMapping | ||
| plugin_bulkdata_enablePluginForDevice | PUT /api/v3/device/{device_id}/plugin/{plugin_name} | |
| plugin_bulkdata_getIndicatorTypesByObjectTypeId | ||
| plugin_bulkdata_getSources | ||
| plugin_deferred_createObject | ||
| plugin_deferred_getIndicatorByObjectAndType | ||
| plugin_deferred_getIndicatorsByDeviceId | ||
| plugin_deferred_getIndicatorsByObject | ||
| plugin_deferred_getIndicatorTypes | ||
| plugin_deferred_getObject | ||
| plugin_deferred_getObjectsByDeviceId | ||
| plugin_deferred_getObjectTypeByDeviceTypeIdAndName | ||
| plugin_deferred_getObjectTypes | POST / GET /api/v3/metadata/object_types | |
| plugin_deferred_insertDataRow | ||
| plugin_deferred_setIndicatorOverrideMaxValue | ||
| plugin_deferred_setObjectIsEnabled | ||
| plugin_deferred_setObjectIsHidden | ||
| plugin_deferred_setObjectOverrideDescription | ||
| plugin_deferred_setObjectSubtype | ||
| plugin_icmp_getIndicatorsByObject | ||
| plugin_icmp_getObject | ||
| plugin_snmp_enablePluginForDevice | ||
| plugin_snmp_getEnabledObjectsByDeviceId | ||
| plugin_snmp_getIndicatorByObjectAndType | ||
| plugin_snmp_getIndicatorsByObject | ||
| plugin_snmp_getObject | ||
| plugin_snmp_getObjectTypeByDeviceTypeIdAndName | ||
| plugin_snmp_getObjectTypes | POST / GET /api/v3/metadata/object_types | |
| plugin_snmp_setSNMPLock | ||
| polling_highfrequency_addObject | POST /api/v3/polling/HFPobjects | |
| polling_highfrequency_deleteObject | DELETE /api/v3/polling/HFPobjects/{deviceID}/{ObjectID} | |
| polling_highfrequency_getObjects | GET /api/v3/polling/HFPobjects/{peerID} | |
| report_makeUrlFromGraph | ||
| COC and Plugin Indicators | ||
| SOAP API | RESTv3 | NOTES |
| coc_deleteObjectType | DELETE /api/v3/plugins/object_type/delete/{id} | |
| coc_createObjectType | POST /api/v3/plugins/object_type/create | Creates all types of object types, uses plugin id |
| coc_editObjectType | PATCH /api/v3/plugins/object_type/update | |
| coc_createIndicatorType | POST /api/v3/plugins/indicator_type/create | |
| coc_deleteIndicatorType | DELETE /api/v3/plugins/indicator_type/delete/{id} | |
| coc_editIndicatorTypeDisplayName | PATCH /api/v3/plugins/indicator_type/update | |
| coc_editIndicatorTypeUnits | PATCH /api/v3/plugins/indicator_type/update | |
| coc_createObject | POST /api/v3/objects/coc_group/create | |
| coc_updateObject | PATCH /api/v3/objects/coc_group/update | |
| coc_deleteObject | DELETE /api/v3/objects/coc_group/delete | |
| coc_deleteVariable | ||
| coc_updateVariable | ||
| coc_createVariable | ||
| coc_getVariables | ||
| coc_getExpressionByObjectAndIndicatorType | GET /api/v3/objects/coc_group/expression | |
| coc_getMaxValueExpressionByObjectAndIndicatorType | GET /api/v3/objects/coc_group/expression | |
| coc_setExpressionByObjectAndIndicatorType | PATCH /api/v3/objects/coc_group/expression | |
| coc_setMaxValueExpressionByObjectAndIndicatorType | PATCH /api/v3/objects/coc_group/expression | |
| coc_getEnabledIndicatorsByObject | ||
| coc_enablePluginForDevice | PUT /api/v3/device/{device_id}/plugin/{plugin_name} | |
| coc_getObjectTypes | POST / GET /api/v3/metadata/object_types | |
| coc_getObjectTypeById | POST / GET /api/v3/metadata/object_types | |
| coc_getObjectTypesByDeviceTypeId | POST / GET /api/v3/metadata/object_types | |
| coc_getObjectTypeByDeviceTypeIdAndName | POST / GET /api/v3/metadata/object_types | |
| coc_getObjectTypesByName | POST / GET /api/v3/metadata/object_types | |
| coc_getObjectTypesByParentId | POST / GET /api/v3/metadata/object_types | |
| coc_getObjectSubtypes | POST / GET /api/v3/metadata/object_subtypes | |
| coc_getObjectSubtypesByObjectType | POST / GET /api/v3/metadata/object_subtypes | |
| coc_getObjectSubtypeByObjectTypeAndSubtype | POST / GET /api/v3/metadata/object_subtypes | |
| coc_getIndicatorTypes | POST / GET /api/v3/metadata/indicator_types | |
| coc_getIndicatorTypesByObjectTypeId | POST / GET /api/v3/metadata/indicator_types | |
| coc_getIndicatorTypeById | POST / GET /api/v3/metadata/indicator_types | |
| coc_getIndicatorTypeByObjectTypeIdAndName | POST / GET /api/v3/metadata/indicator_types | |
| coc_getObjectsByDeviceId | POST / GET /api/v3/metadata/objects | |
| coc_getEnabledObjectsByDeviceId | POST / GET /api/v3/metadata/objects | |
| coc_getObjectsByObjectGroupId | POST / GET /api/v3/metadata/objects | |
| coc_getObject | POST / GET /api/v3/metadata/objects | |
| coc_setObjectOverrideDescription | ||
| coc_setObjectIsEnabled | ||
| coc_setObjectIsHidden | ||
| coc_objectExists | ||
| coc_getIndicatorsByDeviceId | POST / GET /api/v3/metadata/indicators | |
| coc_getIndicatorsByObject | POST / GET /api/v3/metadata/indicators | |
| coc_getIndicatorByObjectAndType | POST / GET /api/v3/metadata/indicators | |
| coc_getIndicatorById | POST / GET /api/v3/metadata/indicators | |
| coc_setIndicatorOverrideMaxValue | POST /api/v3/indicators/setOverrideMaxValue | |
| coc_indicatorExists | ||
| deferred_setObjectOverrideDescription | ||
| deferred_setObjectSubtype | ||
| icmp_getIndicatorsByObject | POST / GET /api/v3/metadata/indicators | |
| icmp_getObject | ||
| snmp_enablePluginForDevice | ||
| snmp_getEnabledObjectsByDeviceId | ||
| snmp_getIndicatorByObjectAndType | POST / GET /api/v3/metadata/indicators | |
| snmp_getIndicatorsByObject | POST / GET /api/v3/metadata/indicators | |
| snmp_getObject | ||
| snmp_getObjectTypeByDeviceTypeIdAndName | ||
| snmp_getObjectTypes | ||
| snmp_setSNMPLock | ||
| polling_highfrequency_addObject | ||
| polling_highfrequency_getObjects | ||
| bulkdata_getFoundIndicatorTypes | ||
| bulkdata_getFoundObjects | ||
| bulkdata_getFoundIndicators | ||
| bulkdata_getIndicatorTypes | POST / GET /api/v3/metadata/indicator_types | |
| bulkdata_getIndicatorTypesByObjectTypeId | POST / GET /api/v3/metadata/indicator_types | |
| bulkdata_getIndicatorTypeById | POST / GET /api/v3/metadata/indicator_types | |
| bulkdata_getIndicatorTypeByObjectTypeIdAndName | POST / GET /api/v3/metadata/indicator_types | |
| bulkdata_getIndicatorsByDeviceId | POST / GET /api/v3/metadata/indicators | |
| bulkdata_getIndicatorsByObject | POST / GET /api/v3/metadata/indicators | |
| bulkdata_getIndicatorByObjectAndType | POST / GET /api/v3/metadata/indicators | |
| bulkdata_getIndicatorById | POST / GET /api/v3/metadata/indicators | |
| bulkdata_setIndicatorOverrideMaxValue | ||
| bulkdata_indicatorExists | ||
| core_getBaselinesByIndicatorId | ||
| deferred_createIndicatorType | ||
| deferred_deleteIndicatorType | ||
| deferred_setIndicatorTypeDescription | ||
| deferred_setIndicatorTypeFormat | ||
| deferred_setIndicatorTypeHasMaxValue | ||
| deferred_setIndicatorTypeUnits | ||
| deferred_insertDataRow | ||
| deferred_insertDataRows | ||
| deferred_getIndicatorTypes | POST / GET /api/v3/metadata/indicator_types | |
| deferred_getIndicatorTypesByObjectTypeId | POST / GET /api/v3/metadata/indicator_types | |
| deferred_getIndicatorTypeById | POST / GET /api/v3/metadata/indicator_types | |
| deferred_getIndicatorTypeByObjectTypeIdAndName | POST / GET /api/v3/metadata/indicator_types | |
| deferred_getIndicatorsByDeviceId | POST / GET /api/v3/metadata/indicators | |
| deferred_getIndicatorsByObject | POST / GET /api/v3/metadata/indicators | |
| deferred_getIndicatorByObjectAndType | POST / GET /api/v3/metadata/indicators | |
| deferred_getIndicatorById | POST / GET /api/v3/metadata/indicators | |
| deferred_setIndicatorOverrideMaxValue | ||
| deferred_indicatorExists | ||
| dns_getIndicatorTypes | POST / GET /api/v3/metadata/indicator_types | |
| dns_getIndicatorTypesByObjectTypeId | POST / GET /api/v3/metadata/indicator_types | |
| dns_getIndicatorTypeById | POST / GET /api/v3/metadata/indicator_types | |
| dns_getIndicatorTypeByObjectTypeIdAndName | POST / GET /api/v3/metadata/indicator_types | |
| dns_getIndicatorsByDeviceId | POST / GET /api/v3/metadata/indicators | |
| dns_getIndicatorsByObject | POST / GET /api/v3/metadata/indicators | |
| dns_getIndicatorByObjectAndType | POST / GET /api/v3/metadata/indicators | |
| dns_getIndicatorById | POST / GET /api/v3/metadata/indicators | |
| dns_setIndicatorOverrideMaxValue | ||
| dns_indicatorExists | ||
| http_getIndicatorTypes | POST / GET /api/v3/metadata/indicator_types | |
| http_getIndicatorTypesByObjectTypeId | POST / GET /api/v3/metadata/indicator_types | |
| http_getIndicatorTypeById | POST / GET /api/v3/metadata/indicator_types | |
| http_getIndicatorTypeByObjectTypeIdAndName | POST / GET /api/v3/metadata/indicator_types | |
| http_getIndicatorsByObject | POST / GET /api/v3/metadata/indicators | |
| http_getIndicatorByObjectAndType | POST / GET /api/v3/metadata/indicators | |
| http_getIndicatorById | POST / GET /api/v3/metadata/indicators | |
| http_setIndicatorOverrideMaxValue | ||
| http_indicatorExists | ||
| icmp_getIndicatorTypes | POST / GET /api/v3/metadata/indicator_types | |
| icmp_getIndicatorTypesByObjectTypeId | POST / GET /api/v3/metadata/indicator_types | |
| icmp_getIndicatorTypeById | POST / GET /api/v3/metadata/indicator_types | |
| icmp_getIndicatorTypeByObjectTypeIdAndName | POST / GET /api/v3/metadata/indicator_types | |
| icmp_getIndicatorsByDeviceId | POST / GET /api/v3/metadata/indicators | |
| icmp_getIndicatorsByObject | POST / GET /api/v3/metadata/indicators | |
| icmp_getIndicatorByObjectAndType | POST / GET /api/v3/metadata/indicators | |
| icmp_getIndicatorById | POST / GET /api/v3/metadata/indicators | |
| icmp_setIndicatorOverrideMaxValue | ||
| icmp_indicatorExists | ||
| ipsla_getIndicatorTypes | POST / GET /api/v3/metadata/indicator_types | |
| ipsla_getIndicatorTypesByObjectTypeId | POST / GET /api/v3/metadata/indicator_types | |
| ipsla_getIndicatorTypeById | POST / GET /api/v3/metadata/indicator_types | |
| ipsla_getIndicatorTypeByObjectTypeIdAndName | POST / GET /api/v3/metadata/indicator_types | |
| ipsla_getIndicatorsByDeviceId | POST / GET /api/v3/metadata/indicators | |
| ipsla_getIndicatorsByObject | POST / GET /api/v3/metadata/indicators | |
| ipsla_getIndicatorByObjectAndType | POST / GET /api/v3/metadata/indicators | |
| ipsla_getIndicatorById | POST / GET /api/v3/metadata/indicators | |
| ipsla_setIndicatorOverrideMaxValue | ||
| ipsla_indicatorExists | ||
| mysqldb_getIndicatorTypes | POST / GET /api/v3/metadata/indicator_types | |
| mysqldb_getIndicatorTypesByObjectTypeId | POST / GET /api/v3/metadata/indicator_types | |
| mysqldb_getIndicatorTypeById | POST / GET /api/v3/metadata/indicator_types | |
| mysqldb_getIndicatorTypeByObjectTypeIdAndName | POST / GET /api/v3/metadata/indicator_types | |
| mysqldb_getIndicatorsByObject | POST / GET /api/v3/metadata/indicators | |
| mysqldb_getIndicatorByObjectAndType | POST / GET /api/v3/metadata/indicators | |
| mysqldb_getIndicatorById | POST / GET /api/v3/metadata/indicators | |
| mysqldb_setIndicatorOverrideMaxValue | ||
| mysqldb_indicatorExists | ||
| nbar_getIndicatorTypes | POST / GET /api/v3/metadata/indicator_types | |
| nbar_getIndicatorTypesByObjectTypeId | POST / GET /api/v3/metadata/indicator_types | |
| nbar_getIndicatorTypeById | POST / GET /api/v3/metadata/indicator_types | |
| nbar_getIndicatorTypeByObjectTypeIdAndName | POST / GET /api/v3/metadata/indicator_types | |
| nbar_getIndicatorsByDeviceId | POST / GET /api/v3/metadata/indicators | |
| nbar_getIndicatorsByObject | POST / GET /api/v3/metadata/indicators | |
| nbar_getIndicatorByObjectAndType | POST / GET /api/v3/metadata/indicators | |
| nbar_getIndicatorById | POST / GET /api/v3/metadata/indicators | |
| nbar_setIndicatorOverrideMaxValue | ||
| nbar_indicatorExists | ||
| portshaker_getIndicatorTypes | POST / GET /api/v3/metadata/indicator_types | |
| portshaker_getIndicatorTypesByObjectTypeId | POST / GET /api/v3/metadata/indicator_types | |
| portshaker_getIndicatorTypeById | POST / GET /api/v3/metadata/indicator_types | |
| portshaker_getIndicatorTypeByObjectTypeIdAndName | POST / GET /api/v3/metadata/indicators | |
| portshaker_getIndicatorsByDeviceId | POST / GET /api/v3/metadata/indicators | |
| portshaker_getIndicatorsByObject | POST / GET /api/v3/metadata/indicators | |
| portshaker_getIndicatorByObjectAndType | POST / GET /api/v3/metadata/indicators | |
| portshaker_getIndicatorById | POST / GET /api/v3/metadata/indicators | |
| portshaker_setIndicatorOverrideMaxValue | ||
| portshaker_indicatorExists | ||
| process_getIndicatorTypes | POST / GET /api/v3/metadata/indicator_types | |
| process_getIndicatorTypesByObjectTypeId | POST / GET /api/v3/metadata/indicator_types | |
| process_getIndicatorTypeById | POST / GET /api/v3/metadata/indicator_types | |
| process_getIndicatorTypeByObjectTypeIdAndName | POST / GET /api/v3/metadata/indicator_types | |
| process_getIndicatorsByDeviceId | POST / GET /api/v3/metadata/indicators | |
| process_getIndicatorsByObject | POST / GET /api/v3/metadata/indicators | |
| process_getIndicatorByObjectAndType | POST / GET /api/v3/metadata/indicators | |
| process_getIndicatorById | POST / GET /api/v3/metadata/indicators | |
| process_setIndicatorOverrideMaxValue | ||
| process_indicatorExists | ||
| proxyping_getIndicatorTypes | POST / GET /api/v3/metadata/indicator_types | |
| proxyping_getIndicatorTypesByObjectTypeId | POST / GET /api/v3/metadata/indicator_types | |
| proxyping_getIndicatorTypeById | POST / GET /api/v3/metadata/indicator_types | |
| proxyping_getIndicatorTypeByObjectTypeIdAndName | POST / GET /api/v3/metadata/indicator_types | |
| proxyping_getIndicatorsByDeviceId | POST / GET /api/v3/metadata/indicators | |
| proxyping_getIndicatorsByObject | POST / GET /api/v3/metadata/indicators | |
| proxyping_getIndicatorByObjectAndType | POST / GET /api/v3/metadata/indicators | |
| proxyping_getIndicatorById | POST / GET /api/v3/metadata/indicators | |
| proxyping_setIndicatorOverrideMaxValue | ||
| proxyping_indicatorExists | ||
| snmp_getIndicatorTypes | POST / GET /api/v3/metadata/indicator_types | |
| snmp_getIndicatorTypesByObjectTypeId | POST / GET /api/v3/metadata/indicator_types | |
| snmp_getIndicatorTypeById | POST / GET /api/v3/metadata/indicator_types | |
| snmp_getIndicatorTypeByObjectTypeIdAndName | POST / GET /api/v3/metadata/indicator_types | |
| snmp_getIndicatorsByDeviceId | POST / GET /api/v3/metadata/indicators | |
| snmp_getIndicatorsByObject | POST / GET /api/v3/metadata/indicators | |
| snmp_getIndicatorByObjectAndType | POST / GET /api/v3/metadata/indicators | |
| snmp_getIndicatorById | POST / GET /api/v3/metadata/indicators | |
| snmp_setIndicatorOverrideMaxValue | ||
| snmp_indicatorExists | ||
| vmware_getIndicatorTypes | POST / GET /api/v3/metadata/indicator_types | |
| vmware_getIndicatorTypesByObjectTypeId | POST / GET /api/v3/metadata/indicator_types | |
| vmware_getIndicatorTypeById | POST / GET /api/v3/metadata/indicator_types | |
| vmware_getIndicatorTypeByObjectTypeIdAndName | POST / GET /api/v3/metadata/indicator_types | |
| vmware_getIndicatorsByDeviceId | POST / GET /api/v3/metadata/indicators | |
| vmware_getIndicatorsByObject | POST / GET /api/v3/metadata/indicators | |
| vmware_getIndicatorByObjectAndType | POST / GET /api/v3/metadata/indicators | |
| vmware_getIndicatorById | POST / GET /api/v3/metadata/indicators | |
| vmware_setIndicatorOverrideMaxValue | ||
| vmware_indicatorExists | ||
| webstatus_getIndicatorTypes | POST / GET /api/v3/metadata/indicator_types | |
| webstatus_getIndicatorTypesByObjectTypeId | POST / GET /api/v3/metadata/indicator_types | |
| webstatus_getIndicatorTypeById | POST / GET /api/v3/metadata/indicator_types | |
| webstatus_getIndicatorTypeByObjectTypeIdAndName | POST / GET /api/v3/metadata/indicator_types | |
| webstatus_getIndicatorsByDeviceId | POST / GET /api/v3/metadata/indicators | |
| webstatus_getIndicatorsByObject | POST / GET /api/v3/metadata/indicators | |
| webstatus_getIndicatorByObjectAndType | POST / GET /api/v3/metadata/indicators | |
| webstatus_getIndicatorById | POST / GET /api/v3/metadata/indicators | |
| webstatus_setIndicatorOverrideMaxValue | ||
| webstatus_indicatorExists | ||
| wmi_getIndicatorTypes | POST / GET /api/v3/metadata/indicator_types | |
| wmi_getIndicatorTypesByObjectTypeId | POST / GET /api/v3/metadata/indicator_types | |
| wmi_getIndicatorTypeById | POST / GET /api/v3/metadata/indicator_types | |
| wmi_getIndicatorTypeByObjectTypeIdAndName | POST / GET /api/v3/metadata/indicator_types | |
| wmi_getIndicatorsByDeviceId | POST / GET /api/v3/metadata/indicators | |
| wmi_getIndicatorsByObject | POST / GET /api/v3/metadata/indicators | |
| wmi_getIndicatorByObjectAndType | POST / GET /api/v3/metadata/indicators | |
| wmi_getIndicatorById | POST / GET /api/v3/metadata/indicators | |
| wmi_setIndicatorOverrideMaxValue | ||
| wmi_indicatorExists | ||
| threshold_getConditionsByIndicatorId | ||
| threshold_getConditionsByObjectAndIndicator | ||
REST API v2 > REST API v3 Mappings
Note: In the table below, you will notice that several REST API v2 endpoints have not yet been
migrated to REST API v3. The migration task will continue in the future SevOne NMS release(s).
| REST API v2 | REST API v3 | NOTES |
|---|---|---|
| GET /api/v2/alerts | POST /api/v3/alerts | Get all alert |
| POST /api/v2/alerts | POST /api/v3/alerts/create | Create alerts |
| GET /api/v2/alerts/devices/{id} | POST /api/v3/alerts | Get all alert |
| POST /api/v2/alerts/filter | POST /api/v3/alerts | Filter alerts |
| POST /api/v2/alerts/force | POST /api/v3/alerts/create/force | Create Alert Forced |
| GET /api/v2/alerts/netflow-device/{id} | (excluded) | Get all alerts by FlowFalcon Device Id |
| POST /api/v2/alerts/objects | (excluded) | Get max severity alert/object |
| GET /api/v2/alerts/{id} | GET /api/v3/alerts/{id} | Get alert |
| DELETE /api/v2/alerts/{id} | DELETE /api/v3/alerts/{id} | Delete alert |
| PATCH /api/v2/alerts/{id}/assign/{username} | POST /api/v3/alerts/assign | Assign alert |
| PATCH /api/v2/alerts/{id}/clear | POST /api/v3/alerts/acknowledge | Clear alert |
| PATCH /api/v2/alerts/{id}/ignore/{ignoreTime} | POST /api/v3/alerts/ignore | Ignore alert |
| POST /api/v2/application/logger | (excluded) | Change logging level per logger |
| GET /api/v2/application/metrics | (excluded) | Get public metrics |
| GET /api/v2/application/version | (excluded) | Get build version |
| GET /api/v2/authentication/active-sessions | (excluded) | View active sessions |
| GET /api/v2/authentication/keep-alive | (excluded) | Keep-alive endpoint |
| POST /api/v2/authentication/signin | POST /api/v3/users/signin | Sign in user |
| DELETE /api/v2/authentication/signout | POST /api/v3/users/signout | Sign out user |
| DELETE /api/v2/authentication/signout-others | (excluded) | Sign out others |
| DELETE /api/v2/authentication/signout/{userId} | (excluded) | Sign out user |
| GET /api/v2/background/ | (excluded) | List background tasks |
| GET /api/v2/background/{taskId} | (excluded) | Get background task status / response |
| PATCH /api/v2/bulkUpdateMetadata |
|
|
| GET /api/v2/countries/timezones | /api/v3/metadata/time_zones | Get timezones |
| POST /api/v2/device-indicators/data | POST /api/v3/devices/data | Create device indicator data |
| POST /api/v2/device-indicators/last-seen | POST /api/v3/indicators/last-seen | Get the timestamp of the most recent data point for indicators |
| GET /api/v2/devicegroups | GET /api/v3/devicegroups | Get all device groups |
| POST /api/v2/devicegroups | POST /api/v3/devicegroups | Create device group |
| GET /api/v2/devicegroups/ancestors/{ids} | GET /api/v3/devicegroups/ancestors | Get ancestors of the device groups |
| POST /api/v2/devicegroups/filter | POST /api/v3/devicegroups/filter | Filter device groups |
| GET /api/v2/devicegroups/rules | GET / POST /api/v3/devicegroups/rules/all | Get all device group rules |
| POST /api/v2/devicegroups/rules | POST /api/v3/devicegroups/rules | Create device group rules |
| POST /api/v2/devicegroups/rules/apply | POST /api/v3/devicegroups/rules/apply | Apply rules for all device groups |
| GET /api/v2/devicegroups/rules/{id} | GET /api/v3/devicegroups/rules/{id} | Get device group rule by Id |
| PUT /api/v2/devicegroups/rules/{id} | PUT /api/v3/devicegroups/{id} | Update device group rule |
| DELETE /api/v2/devicegroups/rules/{id} | DELETE /api/v3/devicegroups/rules/{id} | Delete device group rule |
| GET /api/v2/devicegroups/{id} | GET /api/v3/devicegroups/{id} | Get device group by Id |
| PUT /api/v2/devicegroups/{id} | PUT /api/v3/devicegroups/{id} | Update device group |
| DELETE /api/v2/devicegroups/{id} | DELETE /api/v3/devicegroups/{id} | Delete device group |
| PATCH /api/v2/devicegroups/{id} | PATCH /api/v3/devicegroups/{id} | Partially update device group |
| GET /api/v2/devicegroups/{id}/ancestors | GET /api/v3/devicegroups/ancestors | Get ancestors of the device group |
| POST /api/v2/devicegroups/{id}/members/{deviceId} | POST /api/v3/devicegroups/{id}/members/{deviceId} | Add an existing device to device group |
| DELETE /api/v2/devicegroups/{id}/members/{deviceId} | DELETE /api/v3/devicegroups/{id}/members/{deviceId} | Remove device group member |
| GET /api/v2/devicegroups/{id}/rules | GET /api/v3/devicegroups/{id}/rules | Get device group rules |
| POST /api/v2/devicegroups/{id}/rules/apply | POST /api/v3/devicesgroups/{id}/rules/apply | Apply rules for the specified device group |
| GET /api/v2/devices | GET / POST /api/v3/metadata/devices | Get all devices |
| POST /api/v2/devices | POST /api/v3/devices | Create device |
| PATCH /api/v2/devices/bulkUpdateDevices | PATCH /api/v3/devices/bulkUpdate | Updates devices basic info |
| POST /api/v2/devices/data | POST /api/v3/devices/data | Create device data |
| POST /api/v2/devices/filter | GET / POST /api/v3/metadata/devices | Filter devices |
| POST /api/v2/devices/objects/filter | (excluded) | Find objects |
| PATCH /api/v2/devices/{deviceId}/bulkUpdateObjects | PATCH /api/v3/metadata/stream | Update objects basic info |
| GET /api/v2/devices/{deviceId}/objects | (excluded) | Get all objects for a device |
| GET /api/v2/devices/{deviceId}/objects/{id} | GET /api/v3/metadata/objects | Get object by Id |
| DELETE /api/v2/devices/{deviceId}/objects/{id} | DELETE /api/v3/devices/{deviceId}/object/{objectId} | Delete object |
| PUT /api/v2/devices/{deviceId}/objects/{id} | PUT /api/v3/devices/object | Update object |
| GET /api/v2/devices/{deviceId}/objects/{objectId}/indicators | (excluded) | Get indicators by deviceId and objectId |
| GET /api/v2/devices/{deviceId}/objects/{objectId}/indicators/{indicatorId} | (excluded) | Get indicator by deviceId |
| GET /api/v2/devices/{deviceId}/objects/{objectId}/indicators/{indicatorId}/data | (excluded) | Get indicator data by deviceId |
| GET /api/v2/devices/{deviceId}/objects/{objectId}/metadata | GET /api/v3/metadata/devices/{deviceID}/objects/{objectID} | Get Object Metadata value |
| PUT /api/v2/devices/{deviceId}/objects/{objectId}/metadata | PUT /api/v3/metadata/devices/{deviceID}/objects/{objectID} | Update Metadata Attributes |
| PATCH /api/v2/devices/{deviceId}/objects/{objectId}/metadata | PATCH /api/v3/metadata/devices/{deviceID}/objects/{objectID} | Partially update Metadata Attributes |
| PUT /api/v2/devices/{deviceId}/objects/{objectId}/metadata/{attributeKey} | (excluded) | Update Metadata Attributes |
| GET /api/v2/devices/{id} | (excluded) | Get device by Id |
| DELETE /api/v2/devices/{id} | DELETE /api/v3/devices | Delete device |
| PATCH /api/v2/devices/{id} | PATCH /api/v3/devices | Partially update device |
| POST /api/v2/devices/{id}/rules/apply | POST /api/v3/devices/{id}/rules/apply | Apply the rules for the specified device |
| POST /api/v2/devices/{id}/undelete | /api/v3/devices/{id}/RemoveFromDeletionQueue | Undelete device |
| GET /api/v2/devicetags/{id} | GET / POST /api/v3/metadata/device_tags | Get device tags by Id |
| GET /api/v2/devicetypes | GET /api/v3/metadata/device_types | Get all device types |
| POST /api/v2/devicetypes | POST /api/v3/devicetypes/create_device_type | Create device type |
| GET /api/v2/devicetypes/ancestors/{ids} | GET /api/v3/devicetypes/ancestors/{ids} | Get ancestors of the device types |
| POST /api/v2/devicetypes/filter | GET / POST /api/v3/devicetypes/filter | Filter devices |
| DELETE /api/v2/devicetypes/{id} | DELETE DELETE /api/v3/devicetypes/{id} | Delete device type |
| GET /api/v2/devicetypes/{id}/ancestors | /api/v3/devicetypes/{id}/ancestors | Get ancestors of the device type |
| GET /api/v2/devicetypes/members/{deviceId} | GET /api/v3/devicetypes/members/{deviceId} | Get device types for device |
| GET /api/v2/devicetypes/{id} | GET /api/v3/metadata/device_types | Get device type |
| GET /api/v2/devicetypes/{id}/ancestors | GET /api/v3/devicetypes/{id}/ancestors | Get ancestors of the device type |
| POST /api/v2/devicetypes/{id}/members/{deviceId} | POST /api/v3/devicetypes/{id}/members/{deviceId} | Associate an existing device with device type |
| DELETE /api/v2/devicetypes/{id}/members/{deviceId} | DELETE /api/v3/devicetypes/{id}/members/{deviceId} | Remove device type member |
| GET /api/v2/devicetypes/members/{deviceId} | GET /api/v3/devicetypes/members/{id} | Get device types for device |
| GET /api/v2/discovery | GET /api/v3/discovery | Get all devices currently in the discovery queue |
| GET /api/v2/discovery/{id} | GET /api/v3/discovery/{id} | Get device status from the discovery queue by Id |
| POST /api/v2/discovery/filter | POST /api/v3/discovery/filter | Filter devices currently in the discovery queue |
| POST /api/v2/discovery/run | (excluded) | Run discovery for all devices (of the peer on which API is running) in the discovery queue |
| GET /api/v2/discovery/{id} | GET /api/v3/discovery/{id} | Get device status from the discovery queue by Id |
| POST /api/v2/discovery/{id}/run | (excluded) | Run discovery for a concrete device |
| GET /api/v2/maintenancewindows | GET /api/v3/maintenancewindows | Get list of maintenance windows |
| POST /api/v2/maintenancewindows | POST /api/v3/maintenancewindows | Create maintenance window associated with devices |
| POST /api/v2/maintenancewindows/device-group | POST /api/v3/maintenancewindows/device-group | Create maintenance window associated to device groups |
| PUT /api/v2/maintenancewindows/device-group/{id} | PUT /api/v3/maintenancewindows/device-group/{id} | updateGroupMaintenanceWindow |
| POST /api/v2/maintenancewindows/filter | POST /api/v3/maintenancewindows/filter | Get filtered list of device maintenance windows |
| POST /api/v2/maintenancewindows/filterall | POST /api/v3/maintenancewindows/filter | Get filtered list of maintenance windows of any entity type |
| GET /api/v2/maintenancewindows/{id} | GET /api/v3/maintenancewindows/{id} | Get maintenance window |
| PUT /api/v2/maintenancewindows/{id} | PUT /api/v3/maintenancewindows/{id} | Update maintenance window associated with devices |
| DELETE /api/v2/maintenancewindows/{id} | DELETE /api/v3/maintenancewindows/{id} | Delete maintenance window |
| GET /api/v2/mapimages | (excluded) | Get all map images |
| GET /api/v2/mapimages/{id} | (excluded) | Get map image |
| GET /api/v2/maps | (excluded) | Get all status maps |
| GET /api/v2/maps/{id} | (excluded) | Get status map by Id |
| GET /api/v2/maps/{id}/connection/{connectionId}/alerts | (excluded) | Get alerts for connection |
| GET /api/v2/maps/{id}/connections | (excluded) | Get connections by status map Id |
| PUT /api/v2/maps/{id}/connections/{connectionId} | (excluded) | Update connection |
| GET /api/v2/maps/{id}/node/{nodeId}/alerts | (excluded) | Get alerts for node |
| GET /api/v2/maps/{id}/nodes | (excluded) | Get all nodes for a specific status map |
| PUT /api/v2/maps/{id}/nodes/{nodeId} | (excluded) | Update node |
| GET /api/v2/metadata/attribute | GET /api/v3/metadata/metadata_attributes | Get all Metadata Attributes |
| POST /api/v2/metadata/attribute | POST /api/v3/metadata/admin/metadata_attribute | Create Metadata Attribute |
| GET /api/v2/metadata/attribute/{id} | GET /api/v3/metadata/attribute/{id} | Get Metadata Attribute |
| PUT /api/v2/metadata/attribute/{id} | PUT /api/v3/metadata/attribute/{id} | Update Metadata Attribute |
| DELETE /api/v2/metadata/attribute/{id} | DELETE /api/v3/metadata/attribute/{id} | Delete Matadata Attribute |
| POST /api/v2/metadata/attribute/filter | POST /api/v3/metadata/metadata_attributes | Filter Metadata Attributes |
| GET /api/v2/metadata/attribute/{id} | GET /api/v3/metadata/attribute/{id} | Get Metadata Attribute |
| PATCH /api/v2/metadata/bulkUpdate | (excluded) | bulk update Metadata Attributes |
| GET /api/v2/metadata/namespace |
GET / POST /api/v3/metadata/metadata_namespaces NOTE: Additional binding of POST not required |
Get all Metadata Namespaces |
| GET /api/v2/metadata/namespace | POST /api/v3/metadata/admin/metadata_namespace | Create Metadata Namespace |
| GET /api/v2/metadata/namespace/{id} | GET /api/v3/metadata/namespace/{id} | Get Metadata Namespace |
| PUT /api/v2/metadata/namespace/{id} | PUT /api/v3/metadata/namespace/{id} | Update Metadata Namespace |
| DELETE /api/v2/metadata/namespace/{id} | DELETE /api/v3/metadata/namespace/{id} | Delete Metadata Namespace |
| GET /api/v2/netflow/deviceMappings | GET / POST /api/v3/metadata/flow_device_mappings | Get flow interface to device mappings |
| POST /api/v2/netflow/deviceMappings | POST /api/v3/metadata/admin/flow_device_mapping | Create device mapping |
| DELETE /api/v2/netflow/deviceMappings/{mappingId} | DELETE /api/v3/metadata/admin/flow_device_mapping/{id} | Delete Device Mapping by Id |
| PATCH /api/v2/netflow/deviceMappings/{mappingId} | PATCH/PUT /api/v3/metadata/admin/flow_device_mapping/{id} | Update device mapping |
| GET /api/v2/netflow/devices | GET / POST /api/v3/metadata/flow_devices | Get all NetFlow devices |
| POST /api/v2/netflow/devices/filter | GET / POST /api/v3/metadata/flow_devices | Get all NetFlow devices |
| POST /api/v2/netflow/devices/interfaces/filter | GET /api/v3/metadata/flow_interfaces | Get NetFlow device interfaces |
| GET /api/v2/netflow/devices/{netflowDeviceId}/interfaces | GET /api/v3/metadata/flow_interfaces | Get interfaces by NetFlow device id |
| DELETE /api/v2/netflow/devices/{netflowDeviceId}/interfaces/{netFlowInterfaceId} | DELETE /api/v3/flow/rule/{peer_id}/{id} | Delete interface by device id |
| GET /api/v2/netflow/devices/{netflowDeviceId}/interfaces/{interfaceId}/directions | GET /api/v3/flow/rule/{peerId} | Get directions by NetFlow device id and interface id |
| PATCH /api/v2/netflow/devices/{netflowDeviceId}/interfaces/{netFlowInterfaceId} | PATCH/PUT /api/v3/metadata/admin/flow_device/{flowDeviceId}/flow_interface/{id} | Update interface |
| GET /api/v2/netflow/fields | (excluded) | Get netflow fields |
| POST /api/v2/netflow/fields/filter | (excluded) | Filter netflow fields |
| GET /api/v2/netflow/filters | GET /api/v3/metadata/flow_filters | Get Netflow filters |
| POST /api/v2/netflow/filters | POST /api/v3/flow/filter/create | Create Netflow filters |
| GET /api/v2/netflow/filters/{id} | GET /api/v3/metadata/flow_filters | Get Netflow filters |
| DELETE /api/v2/netflow/filters/{id} | DELETE /api/v3/flow/filter/{id} | Delete Netflow filter |
| DELETE /api/v2/flow/rule/{peer_id}/{id} | ||
| GET /api/v2/netflow/filters/{id}/rules | GET /api/v3/metadata/flow_filter/{id}/rules | Get Netflow filter rules |
| POST /api/v2/netflow/filters/{id}/rules | POST /api/v3/flow/filter/rules | Create Netflow filter rules |
| DELETE /api/v2/netflow/filters/{id}/rules/{ruleId} | DELETE /api/v3/flow/filter/rules | Delete Netflow filter rule |
| GET /api/v2/netflow/objectMappings | GET / POST /api/v3/metadata/flow_object_mappings | Get flow interface to device indicator mappings |
| POST /api/v2/netflow/objectMappings/filterByIndicator | POST /api/v3/flow/object_mappings/filter_by_indicator | Get flow interface to device indicator mapping by indicators |
| POST /api/v2/netflow/objectMappings/filterByInterface | POST /api/v3/flow/object_mappings/filter_by_interface | Get flow interface to device indicator mapping by interface |
| DELETE /api/v2/netflow/objectMappings/{id} | DELETE /api/v3/metadata/admin/flow_object_mapping/{id} | Delete Object Mapping by Id |
| GET /api/v2/netflow/protocols | GET /api/v3/flow/protocols | Get protocols |
| GET /api/v2/netflow/segments | GET / POST /api/v3/flow/segments | Get Network Segments |
| POST /api/v2/netflow/segments | POST /api/v3/flow/segment | Create Network Segment |
| GET /api/v2/netflow/segments/subnets | GET /api/v3/flow/segments/subnets | Get subnets |
| DELETE /api/v2/netflow/segments/subnets/{id} | DELETE /api/v3/Flow/subnets/{id} | Delete subnet |
| GET /api/v2/netflow/segments/{id} | GET / POST /api/v3/flow/segments | Get Network Segment By Id |
| DELETE /api/v2/netflow/segments/{id} | DELETE /api/v3/Flow/segment/{id} | Delete Network Segment By Id |
| GET /api/v2/netflow/segments/{id}/subnets | GET /api/v3/flow/segments/subnets | Get subnets |
| POST /api/v2/netflow/segments/{id}/subnets | POST /api/v3/flow/segments/{id}/subnets | Create subnet |
| GET /api/v2/netflow/serviceProfiles | GET / POST /api/v3/flow/app_profiles | Get service profiles |
| POST /api/v2/netflow/serviceProfiles | POST /api/v3/flow/app_profiles/create | Create service profiles |
| DELETE /api/v2/netflow/serviceProfiles/{id} | DELETE /api/v3/flow/app_profiles/{id} | Delete service profile |
| PATCH /api/v2/netflow/serviceProfiles/{id} | PATCH /api/v3/flow/app_profiles/create | Update service profile |
| GET /api/v2/netflow/services | GET /api/v3/flow/apps | Get apps by port |
| DELETE /api/v2/netflow/services/{id} | DELETE /api/v3/flow/apps/{id} | Delete application |
| GET /api/v2/netflow/services/{serviceProfileId} | GET /api/v3/flow/apps/{id} | Get apps by app profile Id |
| GET /api/v2/netflow/settings | (excluded) | Get the status of NetFlow settings |
| GET /api/v2/netflow/views | GET / POST /api/v3/metadata/flow_views | Get views |
| GET /api/v2/netflow/views/categories | GET /api/v3/metadata/flow_categories | Get netflow view categories |
| POST /api/v2/netflow/views/filter | POST /api/v3/metadata/admin/flow_view | Filter views |
| GET /api/v2/netflow/views/{viewId}/fields | GET /api/v3/netflow/views/{viewId}/fields | Get the keys and metrics in a FlowFalcon view |
| POST /api/v2/netflow/views/{viewId}/fields/filter | GET /api/v3/netflow/views/{viewId}/fields | Filter netflow view fields |
| GET /api/v2/netflow/views/{viewId}/reportColumns | (excluded) | getReportColumns |
| GET /api/v2/objectgroups | GET /api/v3/metadata/object_groups | Get all object groups |
| POST /api/v2/objectgroups | POST /api/v3/objectgroups | Create object group |
| GET /api/v2/objectgroups/ancestors/{ids} |
GET /api/v3/objectgroups/ancestors NOTE: Use object group Id filter |
Get ancestors to the object groups |
| POST /api/v2/objectgroups/filter | POST /api/v3/objectgroups/members/filter | Find object groups |
| POST /api/v2/objectgroups/members/filter | POST /api/v3/objectgroups/members/filter | Filter object to object group mappings |
| GET /api/v2/objectgroups/rules | GET / POST /api/v3/objectgroups/get/rules | Get all object group rules |
| POST /api/v2/objectgroups/rules | POST /api/v3/objectgroups/rules | Create object group rule |
| GET /api/v2/objectgroups/rules/{id} | GET /api/v3/objectgroups/{id}/rules | Get object group rule by Id |
| DELETE /api/v2/objectgroups/rules/{id} | DELETE /api/v3/objectgroups/rules/{ruleID} | Delete object group rule |
| GET /api/v2/objectgroups/{id} | GET /api/v3/objectgroup/{id} | Get object group by Id |
| PUT /api/v2/objectgroups/{id} | PUT /api/v3/objectgroups/{id} | Update object group |
| DELETE /api/v2/objectgroups/{id} | DELETE /api/v3/objectgroups/{id} | Delete object group |
| PATCH /api/v2/objectgroups/{id} | PATCH /api/v3/objectgroups/{id} | Partially update object group |
| GET /api/v2/objectgroups/{id}/ancestors | GET /api/v3/objectgroups/ancestors | Get ancestors to the object groups |
| POST /api/v2/objectgroups/{id}/members | POST /api/v3/objectgroups/{id}/members | Add a member to the object group |
| DELETE /api/v2/objectgroups/{id}/members | DELETE /api/v3/objectgroups/{id}/members | Remove a member from the object group |
| GET /api/v2/objectgroups/{id}/rules | GET /api/v3/objectgroups/{id}/rules | Get object group rules |
| POST /api/v2/objectgroups/{id}/rules/apply | POST /api/v3/objectgroups/{groupID}/rules/apply | Apply the rules for the specified object group |
| GET /api/v2/peers | GET /api/v3/peers | Get peers |
| GET /api/v2/peers/clusterSettings | GET /api/v3/administration/cluster_settings | Get cluster settings |
| GET /api/v2/peers/current | GET /api/v3/peers/current | Current peer |
| GET /api/v2/peers/incorporateMode | (excluded) | Get peer status |
| GET /api/v2/peers/{id} | GET /api/v3/peers/{id} | Get peer |
| GET /api/v2/peers/{id}/settings | GET /api/v3/peers/{id}/settings | Get settings |
| GET /api/v2/permissions/{roleId}/access | GET /api/v3/permissions/{roleId}/access | Get access permissions |
| PUT /api/v2/permissions/{roleId}/access | PUT /api/v3/permissions/{roleId}/access | Update access permissions |
| GET /api/v2/permissions/{roleId}/devicegroup | GET /api/v3/permissions/{roleId}/devicegroup | Get deviceGroup permissions |
| GET /api/v2/permissions/{roleId}/devicegroup/{id} | GET /api/v3/permissions/{roleId}/devicegroup/{id} | Get deviceGroup permissions by id |
| PATCH /api/v2/permissions/{roleId}/devicegroup/{id} | PATCH /api/v3/permissions/{roleId}/devicegroup/{id} | Update deviceGroup permissions by Id |
| GET /api/v2/permissions/{roleId}/page | GET /api/v3/permissions/{roleId}/page | Get page permissions |
| PUT /api/v2/permissions/{roleId}/page | PUT /api/v3/permissions/{roleId}/page | Update page permissions |
| GET /api/v2/permissions/{roleId}/role | GET /api/v3/permissions/{roleId}/role | Get userrole permissions |
| GET /api/v2/permissions/{roleId}/role/{targetRoleId} | GET /api/v3/permissions/{roleId}/role/{targetRoleId} | Get userrole permissions by target role Id |
| PUT /api/v2/permissions/{roleId}/role/{targetRoleId} | PUT /api/v3/permissions/{roleId}/role/{targetRoleId} | Update userrole permissions by target role Id |
| POST /api/v2/pluginmanager/register | (excluded) | Register dynamic plugin manager |
| POST /api/v2/pluginmanager/{id}/plugin/register | (excluded) | Register plugin in dynamic plugin manager |
| GET /api/v2/plugins | GET /api/v3/plugins/filter | Get all plugins |
| GET /api/v2/plugins/device/schema | GET /api/v3/plugins/device/schema | Get all device extended plugin info schema |
| GET /api/v2/plugins/indicator/schema/{pluginId} | GET /api/v3/plugins/indicator/schema/{pluginId} | Get indicator extended info schema by plugin Id |
| POST /api/v2/plugins/indicatortypes | POST /api/v3/plugins/indicator_type/create | Creates a plugin indicator type |
| POST /api/v2/plugins/indicatortypes/filter | (excluded) | Find plugin indicator types |
| GET /api/v2/plugins/indicatortypes/schema/{pluginId} | GET /api/v3/plugins/indicatortypes/schema/{pluginId} | Get schema for plugin indicator type extended info |
| PUT /api/v2/plugins/indicatortypes/{id} | PATCH /api/v3/plugins/indicator_type/update | Updates a plugin indicator type |
| GET /api/v2/plugins/object/schema/{pluginId} | GET /api/v3/plugins/object/schema/{pluginId} | Get object extended info schema by plugin Id |
| GET /api/v2/plugins/objecttypes | GET /api/v3/metadata/object_types | Get all plugin object types |
| POST /api/v2/plugins/objecttypes | POST /api/v3/plugins/object_type/create | Create a plugin object type |
| POST /api/v2/plugins/objecttypes/filter | GET /api/v3/metadata/object_types | Find plugin object types |
| GET /api/v2/plugins/objecttypes/schema/{pluginId} | get /api/v3/plugins/objecttypes/schema/{pluginId} | Get schema for plugin object type extended info |
| PUT /api/v2/plugins/objecttypes/{id} | PATCH /api/v3/plugins/object_type/update | Updates an plugin object type |
| GET /api/v2/policies | GET /api/v3/policies | Get all policies |
| POST /api/v2/policies | POST /api/v3/policies | Create new policy |
| GET /api/v2/policies/{id} | GET /api/v3/policies/{id} | Get policy by Id |
| PUT /api/v2/policies/{id} | PUT /api/v3/policies/{id} | Update policy |
| DELETE /api/v2/policies/{id} | DELETE /api/v3/policies/{id} | Delete policy |
| POST /api/v2/policies/filter | POST /api/v3/policies/filter | Filter policies |
| GET /api/v2/policies/folders | GET /api/v3/policies/folders | Get all policy folders |
| POST /api/v2/policies/folders | POST /api/v3/policies/folders | Create new policy folder |
| PUT /api/v2/policies/folders/{id} | PUT /api/v3/policies/folders/{id} | Update policy folder |
| DELETE /api/v2/policies/folders/{id} | DELETE /api/v3/policies/folders/{id} | Delete policy folder |
| GET /api/v2/policies/{policyId}/actions | GET /api/v3/policies/{policyId}/actions | Get all policy actions |
| PUT /api/v2/policies/{policyId}/actions | PUT /api/v3/policies/{policyId}/actions | Update policy action |
| DELETE /api/v2/policies/{policyId}/actions | DELETE /api/v3/policies/{policyId}/actions | Delete policy action |
| GET /api/v2/policies/{policyId}/conditions | GET /api/v3/policies/{policyId}/conditions | Get all policy conditions |
| POST /api/v2/policies/{policyId}/conditions | POST /api/v3/policies/{policyId}/conditions | Create new policy condition |
| GET /api/v2/policies/{policyId}/conditions/{conditionId} | GET /api/v3/policies/{policyId}/conditions/{conditionId} | Get policy condition by policyId and conditionId |
| PUT /api/v2/policies/{policyId}/conditions/{conditionId} | PUT /api/v3/policies/policyId}/conditions/{conditionId} | Update policy condition |
| DELETE /api/v2/policies/{policyId}/conditions/{conditionId} | DELETE /api/v3/policies/{policyId}/conditions/{conditionId} | Delete policy condition |
| GET /api/v2/reports | (excluded) | Get all reports |
| GET /api/v2/reports/attachments/alerts/filters/schema | (excluded) | Gets the filters schema |
| POST /api/v2/reports/attachments/alerts/run | (excluded) | Run alert report |
| GET /api/v2/reports/attachments/alerts/{id} | (excluded) | Get alert attachment |
| GET /api/v2/reports/attachments/alerts/{id}/aggregation | (excluded) | Get attachment aggregation |
| GET /api/v2/reports/attachments/alerts/{id}/filters | (excluded) | Get filters |
| GET /api/v2/reports/attachments/alerts/{id}/resources | (excluded) | Get alert attachment resources |
| GET /api/v2/reports/attachments/alerts/{id}/run | (excluded) | Run alert attachment |
| GET /api/v2/reports/attachments/alerts/{id}/settings | (excluded) | Get attachment settings |
| GET /api/v2/reports/attachments/alerts/{id}/time | (excluded) | Get alert attachment time settings |
| GET /api/v2/reports/attachments/alerts/{id}/visualizations | (excluded) | Get attachment visualization settings |
| GET /api/v2/reports/attachments/devicegroups/{id} | (excluded) | Get device group attachment |
| GET /api/v2/reports/attachments/devicegroups/{id}/resources | (excluded) | Get resources for device groups report attachment |
| GET /api/v2/reports/attachments/devicegroups/{id}/visualizations | (excluded) | Get visualization |
| GET /api/v2/reports/attachments/devices/filters/schema | (excluded) | Gets the filters schema |
| GET /api/v2/reports/attachments/devices/{id} | (excluded) | Get device attachment |
| GET /api/v2/reports/attachments/devices/{id}/filters | (excluded) | Get filters |
| GET /api/v2/reports/attachments/devices/{id}/resources | (excluded) | Get devices report attachment |
| GET /api/v2/reports/attachments/devices/{id}/settings | (excluded) | Get devices report attachment |
| GET /api/v2/reports/attachments/devices/{id}/visualizations | (excluded) | Get devices report attachment |
| GET /api/v2/reports/attachments/flow-falcon/filters/schema | (excluded) | Gets the filters schema |
| POST /api/v2/reports/attachments/flow-falcon/performance-metrics/run | (excluded) | Create performance metrics flow falcon report |
| POST /api/v2/reports/attachments/flow-falcon/run | (excluded) | Run a flow falcon report |
| POST /api/v2/reports/attachments/flow-falcon/topn/run | (excluded) | Create TopN flow falcon report |
| GET /api/v2/reports/attachments/flow-falcon/{id} | (excluded) | Get a flow falcon attachment |
| GET /api/v2/reports/attachments/flow-falcon/{id}/filters | (excluded) | Get filters |
| GET /api/v2/reports/attachments/flow-falcon/{id}/resources | (excluded) | Get resources |
| GET /api/v2/reports/attachments/flow-falcon/{id}/run | (excluded) | Run a flow falcon attachment |
| GET /api/v2/reports/attachments/flow-falcon/{id}/settings | (excluded) | Get attachment settings |
| GET /api/v2/reports/attachments/flow-falcon/{id}/time | (excluded) | GET time ranges |
| GET /api/v2/reports/attachments/flow-falcon/{id}/visualizations | (excluded) | Get attachment visualization settings |
| POST /api/v2/reports/attachments/group-metrics/run | (excluded) | Run group metrics attachment |
| GET /api/v2/reports/attachments/group-metrics/{id} | (excluded) | Get group metrics attachment |
| GET /api/v2/reports/attachments/group-metrics/{id}/resources | (excluded) | Get group metrics report attachment |
| GET /api/v2/reports/attachments/group-metrics/{id}/run | (excluded) | Run group metrics attachment by id |
| GET /api/v2/reports/attachments/group-metrics/{id}/settings | (excluded) | Get group metrics report attachment |
| GET /api/v2/reports/attachments/group-metrics/{id}/time | (excluded) | Get group metrics report attachment |
| GET /api/v2/reports/attachments/group-metrics/{id}/visualization | (excluded) | Get group metrics report attachment |
| GET /api/v2/reports/attachments/metadata/{id} | (excluded) | Get metadata attachment |
| GET /api/v2/reports/attachments/metadata/{id}/resources | (excluded) | Get resources |
| GET /api/v2/reports/attachments/metadata/{id}/visualizations | (excluded) | Get attachment visualization settings |
| GET /api/v2/reports/attachments/object-groups/{id} | (excluded) | Get object group attachment |
| GET /api/v2/reports/attachments/object-groups/{id}/resources | (excluded) | Get resources |
| GET /api/v2/reports/attachments/object-groups/{id}/visualizations | (excluded) | Get attachment visualization settings |
| GET /api/v2/reports/attachments/objects/{id} | (excluded) | Get object attachment |
| GET /api/v2/reports/attachments/objects/{id}/resources | (excluded) | Get resources |
| GET /api/v2/reports/attachments/objects/{id}/settings | (excluded) | Get attachment settings |
| GET /api/v2/reports/attachments/objects/{id}/visualizations | (excluded) | Get attachment visualization settings |
| POST /api/v2/reports/attachments/performance-metrics/run | (excluded) | Run performance metrics attachment |
| GET /api/v2/reports/attachments/performance-metrics/{id} | (excluded) | Get performance metrics attachment |
| GET /api/v2/reports/attachments/performance-metrics/{id}/resources | (excluded) | Get resources |
| GET /api/v2/reports/attachments/performance-metrics/{id}/run | (excluded) | Run performance metrics attachment |
| GET /api/v2/reports/attachments/performance-metrics/{id}/settings | (excluded) | Get attachment settings |
| GET /api/v2/reports/attachments/performance-metrics/{id}/time | (excluded) | GET time ranges |
| GET /api/v2/reports/attachments/performance-metrics/{id}/visualizations | (excluded) | Get attachment visualization settings |
| GET /api/v2/reports/attachments/statusmap/{id} | (excluded) | Get status map attachment |
| GET /api/v2/reports/attachments/statusmap/{id}/resources | (excluded) | Get resources |
| POST /api/v2/reports/attachments/topn/run | (excluded) | Run topn attachment |
| GET /api/v2/reports/attachments/topn/{id} | (excluded) | Get topn attachment |
| GET /api/v2/reports/attachments/topn/{id}/resources | (excluded) | Get resources |
| GET /api/v2/reports/attachments/topn/{id}/run | (excluded) | Run topn attachment |
| GET /api/v2/reports/attachments/topn/{id}/settings | (excluded) | Get attachment settings |
| GET /api/v2/reports/attachments/topn/{id}/time | (excluded) | Get topN report attachment |
| GET /api/v2/reports/attachments/topn/{id}/visualizations | (excluded) | Get attachment visualization settings |
| POST /api/v2/reports/attachments/topology/run | (excluded) | Run a topology attachment |
| GET /api/v2/reports/attachments/topology/{id} | (excluded) | Get topology attachment |
| GET /api/v2/reports/attachments/topology/{id}/filters | (excluded) | Get attachment topology filters |
| GET /api/v2/reports/attachments/topology/{id}/resources | (excluded) | Get resources |
| GET /api/v2/reports/attachments/topology/{id}/run | (excluded) | Run a topology attachment |
| GET /api/v2/reports/attachments/topology/{id}/settings | (excluded) | Get attachment settings |
| GET /api/v2/reports/attachments/topology/{id}/visualizations | (excluded) | Get attachment visualization settings |
| GET /api/v2/reports/attachments/{id} | (excluded) | Get report attachment |
| GET /api/v2/reports/attachments/{type}/endpoints | (excluded) | Get all report attachments endpoints |
| GET /api/v2/reports/folders | (excluded) | Get all report folders |
| PUT /api/v2/reports/folders/{id} | (excluded) | Update report folder |
| GET /api/v2/reports/{id} | (excluded) | Get report |
| GET /api/v2/reports/{id}/attachments | (excluded) | Get all report attachments for a report |
| POST /api/v2/reports/{id}/attachments/alerts | (excluded) | Create alert report attachment |
| POST /api/v2/reports/{id}/attachments/devicegroups | (excluded) | Create device groups attachment |
| POST /api/v2/reports/{id}/attachments/devices | (excluded) | Create devices attachment |
| POST /api/v2/reports/{id}/attachments/flow-falcon | (excluded) | Create flow falcon attachment |
| POST /api/v2/reports/{id}/attachments/group-metrics | (excluded) | Create group metrics report attachment |
| POST /api/v2/reports/{id}/attachments/metadata | (excluded) | Create metadata attachment |
| POST /api/v2/reports/{id}/attachments/object-groups | (excluded) | Create object group attachment |
| POST /api/v2/reports/{id}/attachments/objects | (excluded) | Create objects attachment |
| POST /api/v2/reports/{id}/attachments/performance-metrics | (excluded) | Create performance metrics attachment |
| POST /api/v2/reports/{id}/attachments/statusmap | (excluded) | Create statusmap attachment |
| POST /api/v2/reports/{id}/attachments/topn | (excluded) | Create topN report attachment |
| POST /api/v2/reports/{id}/attachments/topology | (excluded) | Create topology attachment |
| GET /api/v2/roles | GET /api/v3/roles | Get roles |
| POST /api/v2/roles | POST /api/v3/roles | Create role |
| GET /api/v2/roles/{id} | GET /api/v3/roles/{id} | Get role |
| DELETE /api/v2/roles/{id} | DELETE /api/v3/roles/{id} | Delete role |
| PATCH /api/v2/roles/{id} | PATCH /api/v3/roles | Update role |
| POST /api/v2/roles/filter | POST /api/v3/roles/filter | Filter roles |
| GET /api/v2/roles/{id} | GET /api/v3/roles/{id} | Get Role |
| GET /api/v2/tags | (excluded) | Get all Tags |
| GET /api/v2/tags/{name}/indicatortypes | (excluded) | Get Indicator Types Based On Tag Name |
| GET /api/v2/thresholds | (excluded) | Get thresholds |
| POST /api/v2/thresholds/flow/{deviceId} | (excluded) | Create threshold |
| GET /api/v2/thresholds/flow/{deviceId}/{thresholdId} | (excluded) | Get a threshold by id |
| POST /api/v2/thresholds/flow/{deviceId}/{thresholdId}/{triggerType}/conditions | (excluded) | add a condition to a threshold |
| PUT /api/v2/thresholds/flow/{deviceId}/{thresholdId}/{triggerType}/conditions/{conditionId} | (excluded) | update a condition of a threshold |
| GET /api/v2/topnviews | GET /api/v3/metadata/topn_views
POST /api/v3/metadata/topn_views |
Get all Interviews |
| GET /api/v2/topnviews/{id} | GET /api/v3/metadata/topn_views/{id}
POST /api/v3/metadata/topn_views/{id} |
Get Viewpoint |
| GET /api/v2/topology/constraints | GET /api/v3/topology/constraints | Get constraints |
| POST /api/v2/topology/constraints | POST /api/v3/topology/constraint | Create constraint |
| GET /api/v2/topology/constraints/{id} | GET /api/v3/topology/constraints/{id} | Get constraint |
| PUT /api/v2/topology/constraints/{id} | PUT /api/v3/topology/constraints/{id} | Update constraint |
| DELETE /api/v2/topology/constraints/{id} | DELETE /api/v3/topology/constraints/{id} | Delete constraint |
| GET /api/v2/topology/devices/{deviceId}/links | GET /api/v3/topology/devices/{deviceId}/links | Get topology full link by device id |
| POST /api/v2/topology/filter | POST /api/v3/topology/filter | Filter topology links |
| POST /api/v2/topology/links | POST /api/v3/topology/links | Create topology link |
| GET /api/v2/topology/links/{connectionId} | GET /api/v3/topology/links/{connectionId} | Get topology full link |
| DELETE /api/v2/topology/links/{connectionId} | DELETE /api/v3/topology/links/{connectionId} | Delete topology full link |
| DELETE /api/v2/topology/links/{connectionId}/halflinks/{deviceId} | DELETE /api/v3/topology/links/{connectionId}/halflinks/{deviceId)} | Delete topology link |
| GET /api/v2/users | GET / POST /api/v3/users | Get all users |
| GET /api/v2/users/api-keys | GET /api/v3/users/apikey | View your API keys |
| POST /api/v2/users/api-keys | POST /api/v3/users/apikey | Create API key |
| DELETE /api/v2/users/api-keys | DELETE /api/v3/users/apikey/{application} | Delete API keys |
| DELETE /api/v2/users/api-keys/{apiKey} | DELETE /api/v3/users/apikey/{application} | Delete API keys |
| POST /api/v2/users/filter |
POST /api/v3/users NOTE: Can be used with role id, states (active), user id. |
Filter users |
| POST /api/v2/users/force-password-change | POST /api/v3/users/force-password-change | Force password change |
| GET /api/v2/users/mypreferences | GET /api/v3/users/self | Get user |
| PATCH /api/v2/users/mypreferences | (excluded) | |
| PUT /api/v2/users/mypreferences/password | PUT /api/v3/users/password | Change user password |
| GET /api/v2/users/myroles | GET / POST /api/v3/users | Get user roles |
| GET /api/v2/users/{id} | GET /api/v3/users/id/{id} | Get one user |
| DELETE /api/v2/users/{id} | DELETE /api/v3/users/{id} | Delete user |
| GET /api/v2/users/{id}/api-keys | (excluded) | View user API keys |
| PUT /api/v2/users/{id}/api-keys/{apiKey} | (excluded) | Update user API key |
| GET /api/v2/users/{id}/roles | GET /api/v3/users/{id}/roles | Get all roles for a specific user |
| DELETE /api/v2/users/{id}/roles | DELETE /api/v3/users/{id}/roles | Remove roles for user |
| PATCH /api/v2/users/{id}/roles | PUT /api/v3/users/{id}/roles | Add roles to user |
| GET /api/v2/utils/unitinfos | GET /api/v3/utils/unitinfos | Get unitinfos |
| GET /api/v2/workhours | GET /api/v3/workhours | Get all WorkHours |
| POST /api/v2/workhours | POST /api/v3/workhours | Create WorkHours |
| GET /api/v2/workhours/{id} | GET /api/v3/workhours/{id} | Get WorkHour by group |
| PUT /api/v2/workhours/{id} | PUT /api/v3/workhours/{id} | Update WorkHours |
| DELETE /api/v2/workhours/{id} | DELETE /api/v3/workhours/{id} | Delete WorkHour group |
| GET /api/v2/{entityType}/{entityId}/metadata | GET /api/v3/entity/{entityType}/id/{entityId}/metadata | Get Metadata values |
| PUT /api/v2/{entityType}/{entityId}/metadata | PUT /api/v3/entity/{entityType}/id/{entityId}/metadata | Update Metadata Attributes |
| PATCH /api/v2/{entityType}/{entityId}/metadata | PATCH /api/v3/entity/{entityType}/id/{entityId}/metadata | Partially update Metadata Attributes |
| PUT /api/v2/{entityType}/{entityId}/metadata/{attributeKey} | PUT /api/v3/metadata/attribute/{id} | Update Metadata Attributes |