RPC API Developer's Guide

Add OpsNotes

Note that LogicMonitor has a REST API equivalent for this function.

The LogicMonitor RPC API allows users to programmatically add OpsNotes to their graphs using the addOpsNote call.

Note: As with all of our API calls, authentication is required.

URL:

 https://accountName.logicmonitor.com/santaba/rpc/addOpsNote?c=accountName&u=user&p=password&description=description&opstags=tag1,tag2,tag3&happenon=longValue
 

Request Parameters: You can include the following as query parameters in an addOpsNote request:

Parameter

Type

Description

description String Required. The description of the event that the OpsNote is describing
opstags String Optional. The tag(s) associated with the OpsNote, where multiple tags must be separated by commas and no spaces
happenon Long Optional. The time of the event that the OpsNote is describing, specified in Epoch format.

 

All outputs will be in the format: { [status], [data], [errmsg] }, where status is the status of the response, errmsg is the error message associated with the response, and the data object includes the following:

Parameter

Description

tags The tag(s) associated with the OpsNote
id The Id associated with the OpsNote
description The description of the OpsNote
happenOn The time associated with the OpsNote, in Epoch format.

 

Example

The following example adds an OpsNote for an internal server upgrade, with tags Dev & TechOps:

Request:


curl "https://apiExample.logicmonitor.com/santaba/rpc/addOpsNote?c=apiExample&u=apiUser&p=example&description=Server%20Upgrade&opstags=TechOps,Dev&happenon=1447458416"
 

Response:


{
  "status": 200,
  "data": {
    "tags": [
      {
        "createdOn": 1447458473,
        "id": 8,
        "tag": "TechOps"
      },
      {
        "createdOn": 1447458473,
        "id": 9,
        "tag": "Dev"
      }
    ],
    "id": 18,
    "description": "Server Upgrade",
    "happenOn": 1447458416
  },
  "errmsg": "OK"
}