x
REST API Developer's Guide
- REST API Overview
- REST API v1
- REST API v1 Examples
- REST API v1 Status Codes
- Managing Ops Notes with the REST API
- Managing Alert Rules with the REST API
- Managing Alerts with the REST API
- Managing API Tokens with the REST API
- Accessing Audit Logs with the REST API
- Managing Collectors with the REST API
- Managing Collector Groups with the REST API
- Managing Dashboards and Widgets with the REST API
- Managing Dashboard Groups with the REST API
- Getting Data with the REST API
- Managing Datasources with the REST API
- Managing Datasource Instances with the REST API
- Managing Devices with the REST API
- Managing Device Groups with the REST API
- Get devices for a particular device group
- Get all alerts for a Device Group
- AWS Device Groups
- Delete Device Group Properties
- Update Device Group Properties
- Get Device Group Properties
- Add Device Group Properties
- Get all SDTs for a Device Group
- Delete a Device Group
- Get Device Groups
- Update a Device Group
- Add a Device Group
- About the Device Group Resource
- Managing Escalation Chains with the REST API
- Managing Reports with the REST API
- Managing Report Groups with the REST API
- Managing Roles with the REST API
- Managing SDTs with the REST API
- Managing Websites with the REST API
- Managing Website Groups with the REST API
- Getting Websites Test Locations with the REST API
- Managing Thresholds with the REST API
- Managing Users with the REST API
- REST API v2
- LogicMonitor SDKs
Support > REST API Developer's... > REST API v1 > Managing Datasource ... > About the Datasource Instance Resource
About the Datasource Instance Resource
You can use LogicMonitor's REST API to programmatically manage the datasource instances for a particular device. Note that instances can only be added, deleted & updated via API if Active Discovery is disabled for the datasource.
Using LogicMonitor's REST API, you can:
Note: As with all of our API calls, authentication is required.
Resource URI:
/device/devices/{deviceId}/devicedatasources/{deviceDatasourceId}/instances
Resource Properties:
All datasources have the following properties:
Property |
Description |
Type |
id | The Id of the datasource instance | Integer |
dataSourceId | The id of the datasource definition that the instance represents | Integer |
deviceDataSourceId | The id of the unique device-datasource the instance is associated with | String |
groupId | The id of the instance group associated with the datasource instance | Integer |
groupName | The name of the instance group associated with the datasource instance | Integer |
name | The name of the datasource instance, in the format of: datasourceName-instanceAlias | String |
displayName | The instance alias. This is the descriptive name of the instance, and should be unique for the device/datasource combination. | String |
description | The description of the datasource instance | String |
lockDescription | Whether or not Active Discovery is enabled, and thus whether or not the instance description is editable | Boolean |
deviceId | The id of the device the datasource instance is associated with | Integer |
deviceDisplayName | The display name of the device the datasource instance is associated with | String |
wildValue | The variable part of the instance, used to query data from a device. For example, variable part of the SNMP OID tree. This value must be unique for the device/datasource combination, unless two-dimensional active discovery is used. | String |
wildValue2 | Only used for two dimensional active discovery. When used, during Active Discovery runs, the token ##WILDVALUE## is replaces with the value of ALIAS and the token ##WILDVALUE2## is replaced with the value of the second part alias. This value must be unique for the device/datasource/WILDVALUE combination. | String |
disableAlerting | Whether or not alerting is disabled for the instance | Boolean |
stopMonitoring | Whether or not monitoring is disabled for the instance | Boolean |
alertStatus | Whether or not this instance is in alert, and and whether or not the alert has been acknowledged. This status property has three values in the following format {acknowledged status} - {alertLevel} - {sdt status}, where acknowledged: confirmed | unconfirmed & alertLevel: warn | error | critical | String |
alertStatusPriority | The priority associated with the alert, as used in rolling up alert icons in the Device Tree | Integer |
sdtStatus | Whether or not this instance is effectively in SDT, and where the SDT is set, in the format: deviceSDTStatus - instanceSDTStatus - none | String |
alertDisableStatus | Whether or not alerting is disabled for this instance, and where it is disabled, in the format: deviceDisabledStatus - instanceDisabledStatus - datapointDisabledStatus | String |
alertingDisabledOn | If alerting is disabled, this object indicates the level at which it is disabled. | JSON Object |
groupDisabledThisSource | Indicates whether or not this Datasource has been disabled at the group level | Boolean |
sdtAt | If the instance is in SDT, this parameter displays what entity the SDT was set at (device, instance, etc.) | String |
dataSourceType | The type of LogicModule, e.g. DS (datasource) | String |
lastCollectedTime | The time that data was last collected for the instance | Integer |
lastUpdatedTime | The time that the instance was last updated | Integer |
customProperties | Any instance level properties assigned to the instance | JSON Object |