# API Reference

## Admin Module

### addServiceMonitor

**Method:** POST

**Description:** Add Service Monitor

**Parameters:**

- **apiKey\***: API Key to access your OpManager server.
- **serviceName\***: Service Name to be added
- **portNumber**: Port Number of the service
- **timeOut\***: Timeout value in seconds. Default value 0.
- **failureThreshold\***: Consecutive time value to generate service down alert. Default value 1.
- **autoDiscovery\***: True - Need to check and add this service during discovery. Otherwise false

**Sample URL:**

```
http://localhost:8060/api/json/admin/addServiceMonitor?apiKey=081c9ac51ba16ab061d5efee583dcd2f&autoDiscovery=false&serviceName=test2&portNumber=119&timeOut=5&failureThreshold=1
```

### addSysLogForwarder

**Method:** POST

**Description:** Add SysLog Forwarder

**Parameters:**

- **apiKey\***: API Key to access your OpManager server.
- **destHost\***: Destination Host.
- **destPort\***: Destination Port (0 – 65536)

### addSysLogRule

**Method:** POST

**Description:** Add SysLog Rule

**Parameters:**

- **apiKey\***: API Key to access your OpManager server.
- **ruleName\***: Name of the rule
- **facilityName\***: SysLog Facility
- **severityList\***: SysLog Severity (Comma Separated)
- **alertSeverity\***: OpManager Alert Severity
- **alarmMessage\***: OpManager Alert Message
- **matchString**: String matched with incoming syslog message
- **consecutiveTime\***: Consecutive time
- **timeInterval\***: Time interval  
  (If rearmFacilityName selected then rearmSeverityList should be selected)
- **rearmFacilityName**: Facility name for rearm syslog
- **rearmSeverityList**: Severity list for rearm syslog
- **rearmMatchString**: String matched with incoming syslog for rearm

## Alerts

### acknowledgeAlarm

**Method:** POST

**Description:** Allows to acknowledge an alarm.

**Parameters:**

- **apiKey\***: API Key to access your OpManager server.
- **entity**: Entity of the alarm.

**Sample URL:**

```
http://localhost:8060/api/json/alarm/acknowledgeAlarm?apiKey=081c9ac51ba16ab061d5efee583dcd2f&entity=222222222
```

### addEvent

**Method:** POST

**Description:** Adds an event.

**Parameters:**

- **apiKey\***: API Key to access your OpManager server.
- **entity**: Entity of the alarm.
- **apiKey\***: API Key to access your OpManager server.
- **source\***: Name of the source device of the event.
- **severity\***: The severity of the event. Following are the severity levels and its ID:  
  Critical - 1  
  Trouble - 2  
  Attention - 3  
  Service Down - 4
- **message\***: The message that is displayed when the event is generated.
- **alarmCode**: Unique string used to trigger the event. Eg:-Threshold-DOWN
- **entity**: Uniquely identifies the failure object within the source. Events will be correlated into alarms according to the entity field. Multiple events with the same entity will be grouped as a single alarm.
- **eventType**: Description of the event type

**Sample URL:**

```
http://localhost:80/api/json/events/addEvent?apiKey=3d4d1f45e4c445eb52b9f1c51bc7c1ca&source=Cisco2081_router&severity=1&message=DownStatus&alarmCode=Threshold-DOWN&entity=Cisco2081_router
```

### addNotes

**Method:** POST

**Description:** Adds notes to an alarm.

**Parameters:**

- **apiKey\***: API Key to access your OpManager server.
- **entity\***: Entity of the alarm.
- **notes\***: Text that has to be added as notes to the alarm.

**Sample URL:**

```
http://localhost:8060/api/json/alarm/addNotes?apiKey=081c9ac51ba16ab061d5efee583dcd2f&notes=test&entity=222222222
```