Updating Instance Properties with the Push Metrics REST API

Last updated on 30 June, 2021

You can use LogicMonitor’s Push Metrics REST API to programmatically add or update properties for existing instances. However, system (system.xyz) and (auto.xyz) properties are not added to the payload.

The Push Metrics REST API requires LMv1 API Token Authentication.

Request Information

The instance property ingestion endpoint is used to add or update one or more properties for an existing instance.

Only one instance is supported per request.

MethodPUT/PATCH
Base URLhttps://{ACCOUNTNAME}.logicmonitor.com/santaba/rest
Pathinstance_property/ingest
HeaderAuthorization: LMv1 token
Content-Typeapplication/json
SpecificationPUT – All the properties for that resource must be specified.

PATCH – LogicMonitor will add/update the properties specified in the request.

{
    “resourceIds”: {                                          //Mandatory
        “key”: “<The value of a property>”,…
    }
    “dataSource”: “<DataSource Name>”                        //Mandatory
    “dataSourceDisplayName”: “<DataSource Display Name>”,    
    “instanceName”: “<Instance Name>”,                       //Mandatory
    “instanceProperties”: {      
       “key”: “<The value of a property>”,…      //Should have at least 1 attribute
}
}

For details on the fields used in this request, see Ingesting Metrics with the Push Metrics REST API.

In This Article