Developers Guide

/acks

Get a list of acknowledgements.

/acks/count

Get the number of acknowledgements. (Returns plaintext, rather than XML or JSON.)

/acks/{id}

Get the acknowledgement specified by the given ID.

/acks

Creates or modifies an acknowledgement for the given alarm ID or notification ID. To affect an alarm, set an alarmId< parameter in the URL-encoded POST body; to affect a notification, set notifyId instead. An action parameter is also required, and may be one of ack, unack, clear, or esc (escalate).

/stats/alarms

Returns statistics related to alarms. Accepts the same Hibernate parameters that you can pass to the /alarms ReST service.

/stats/alarms/by-severity

Returns the statistics related to alarms, one per severity. You can optionally pass a list of severities to the severities query parameter to limit it to the specified severities. (eg, GET /opennms/rest/stats/alarms/by-severity?severities=MAJOR,CRITICAL).

/alarms

Get a list of alarms.

/alarms/count

Get the number of alarms. (Returns plaintext, rather than XML or JSON.)

/alarms/{id}

Get the alarms specified by the given ID.

/alarms?comparator=ge&severity=MINOR

Get the alarms with a severity greater than or equal to MINOR.

/alarms/{id}?ack=''(true;false)''

Acknowledges (or unacknowledges) an alarm.

/alarms?x=y&…​&ack=''(true;false)''

Acknowledges (or unacknowledges) alarms matching the additional query parameters. eg, /alarms?node.id=4&ack=true

/alarms/{id}?clear=true

Clears an alarm.

/alarms/{id}?escalate=true

Escalates an alarm. eg, NORMAL → MINOR, MAJOR → CRITICAL, etc.

/alarms?x=y&…​&clear=true

Clears alarms matching the additional query parameters.

/alarms?x=y&…​&escalate=true

Escalates alarms matching the additional query parameters.

/alarms/history/{alarmId}/states

Retrieve the complete set of state changes for the given alarm.

/alarms/history/{alarmId}

Retrieve the last known state of an alarm at the given time.

/alarms/history

Retrieve the last known state of all alarms which were active at the given time.

name

default

comment

matchType

alarm-id

By default we lookup alarms based on the given database id. This property can be used to change the matching behaviour to lookup by reduction key instead.

at

(current time)

Timestamp in milliseconds.

/events

Get a list of events. The default for offset is 0, and the default for limit is 10. To get all results, use limit=0 as a parameter on the URL (ie, GET /events?limit=0).

/events/count

Get the number of events. (Returns plaintext, rather than XML or JSON.)

/events/{id}

Get the event specified by the given ID.

/events/{id}?ack=''(true;false)

Acknowledges (or unacknowledges) an event.

/events?x=y&…​&ack=''(true;false)

Acknowledges (or unacknowledges) the matching events.

/events

Publish an event on the event bus.

/categories

Get all configured categories.

/categories/{category}

Get the category specified by the given name.

/categories/{category}/nodes/{node}

Get the category specified by the given name for the given node (similar to /nodes/{node}/categories/{category})

/categories/nodes/{node}

Get the categories for a given node (similar to /nodes/{node}/categories)

/categories/groups/{group}

Get the categories for a given user group (similar to /groups/{group}/categories)

/categories

Adds a new category.

/categories/{category}

Update the specified category

/categories/{category}/nodes/{node}

Modify the category with the given node ID and name (similar to /nodes/{node}/categories/{category})

/categories/{category}/groups/{group}

Add the given category to the given user group (similar to /groups/{group}/categories/{category})

/categories/{category}

Delete the specified category

/categories/{category}/nodes/{node}

Remove the given category from the given node (similar to /nodes/{node}/categories/{category})

/categories/{category}/groups/{group}

Remove the given category from the given user group (similar to /groups/{group}/categories/{category})

/flows/count

Retrieve the number of flows available

/flows/exporters

Retrieve basic information for the exporter nodes that have flows available

/flows/exporters/{nodeCriteria}

Retrieve detailed information about a specific exporter node

/flows/applications

Retrieve traffic summary statistics for the top N applications or specific applications

/flows/applications/enumerate

Retrieve a list of the applications with flows

/flows/applications/series

Retrieve time series metrics for the top N applications or specific applications

/flows/conversations

Retrieve traffic summary statistics for the top N conversations or specific conversations

/flows/conversations/enumerate

Retrieve a list of the conversations with flows

/flows/conversations/series

Retrieve time series metrics for the top N conversations or specific conversations

/flows/hosts

Retrieve traffic summary statistics for the top N hosts or specific hosts

/flows/hosts/enumerate

Retrieve a list of the hosts with flows

/flows/hosts/series

Retrieve time series metrics for the top N hosts or specific hosts

name

default

comment

start

-14400000

Timestamp in milliseconds.

If > 0, the timestamp is relative to the UNIX epoch (January 1st 1970 00:00:00 AM).

If < 0, the timestamp is relative to the end option (i.e.: default value is 4 hours ago).

end

0

Timestamp in milliseconds. If <= 0, the effective value will be the current timestamp.

ifIndex

(none)

Filter for flows that came in through the given SNMP interface.

exporterNode

(none)

Filter for flows that came where exported by the given node.

Support either node id (integer) i.e. 1, or foreign source and foreign id lookups i.e. FS:FID.

limit

10

Number of applications with flows to return

prefix

""

If provided, filters the results to only include applications with names that start with the given prefix (using fuzzy matching)

N

none

Number of top entries (determined by total bytes transferred) to return

includeOther

false

When set to true the results will also include an additional row or column that contains the bytes transferred for the flows that fall outside of the selected set

application

none

If provided, returns only flow series that match the given application(s). This field can be repeated for any number of applications to be included in the query.

limit

10

Number of hosts with flows to return

location

".*"

If provided, filters the results to only include conversations matching the given location regex pattern

protocol

".*"

If provided, filters the results to only include conversations matching the given protocol regex pattern

lower

".*"

If provided, filters the results to only include conversations matching the given lower IP address regex pattern

upper

".*"

If provided, filters the results to only include conversations matching the given upper IP address regex pattern

application

".*"

If provided, filters the results to only include conversations matching the given application regex pattern

N

10

Number of top entries (determined by total bytes transferred) to return

includeOther

false

When set to true the results will also include an additional row or column that contains the bytes transferred for the flows that fall outside of selected set.

conversation

none

If provided, returns only flow series that match the given conversation(s). This field can be repeated for any number of conversations to be included in the query.

hostname_mode

"replace"

step

300000

Requested time interval between rows.

limit

10

Number of hosts with flows to return

pattern

".*"

If provided, filters the results to only include hosts with names that match the given regex pattern

N

none

Number of top entries (determined by total bytes transferred) to return

includeOther

false

When set to true the results will also include an additional row or column that contains the bytes transferred for the flows that fall outside of the selected set.

host

none

If provided, returns only flow series that match the given host(s). This field can be repeated for any number of hosts to be included in the query.

/classifications

Retrieve a list of all enabled rules. The request is limited to 10 items by default. Setting limit to 0 returns ALL enabled rules.

/classifications/{id}

Retrieve the rule identified by {id}.

/classifications/groups

Retrieve all existing groups. The request is limited to 10 items by default. Setting limit to 0 returns ALL enabled rules.

/classifications/groups/{id}

Retrieve the group identified by {id}` Supports downloading all rules of the given group in CSV format. For this, set the accept header: Accept: text/comma-separated-values.

/classifications/protocols

Retrieve all supported tcp protocols.

comment

groupFilter

(none)

The group to filter the rules by. Should be the id retrieved by /classifications/groups. It is not possible to retrieve the rules for a disabled group.

query

(none)

/classifications

Post a new rule or import rules from CSV. If multiple rules are imported (to user-defined group) from a CSV file all existing rules are deleted.

/classifications/classify

Classify the given request based on all enabled rules.

/classifications/{id}

Update a rule identified by {id}. The id of the rule cannot be changed.

/groups/{id}

Retrieve the rule identified by {id}.

/classifications/groups

Update a group. At the moment, only the enabled property can be changed

/classifications?groupId={groupId}

Deletes all rules of a given group.

/groups/{id}

Delete the given group and all it’s containing rules.

/foreignSources

Get all active foreign sources.

/foreignSources/default

Get the active default foreign source.

/foreignSources/deployed

Get the list of all deployed (active) foreign sources.

/foreignSources/deployed/count

Get the number of deployed foreign sources. (Returns plaintext, rather than XML or JSON.)

/foreignSources/{name}

Get the active foreign source named {name}.

/foreignSources/{name}/detectors

Get the configured detectors for the foreign source named {name}.

/foreignSources/{name}/detectors/{detector}

Get the specified detector for the foreign source named {name}.

/foreignSources/{name}/policies

Get the configured policies for the foreign source named {name}.

/foreignSources/{name}/policies/{policy}

Get the specified policy for the foreign source named {name}.

/foreignSources

Add a foreign source.

/foreignSources/{name}/detectors

Add a detector to the named foreign source.

/foreignSources/{name}/policies

Add a policy to the named foreign source.

/foreignSources/{name}

Modify a foreign source with the given name.

/foreignSources/{name}

Delete the named foreign source.

/foreignSources/{name}/detectors/{detector}

Delete the specified detector from the named foreign source.

/foreignSources/{name}/policies/{policy}

Delete the specified policy from the named foreign source.

/groups

Get a list of groups.

/groups/{groupname}

Get a specific group, given a group name.

/groups/{groupname}/users

Get the users for a group, given a group name. (new in OpenNMS 14)

/groups/{groupname}/categories

Get the categories associated with a group, given a group name. (new in OpenNMS 14)

/groups

Add a new group.

/groups/{groupname}

Update the metadata of a group (eg, change the comments field).

/groups/{groupname}/users/{username}

Add a user to the group, given a group name and username. (new in OpenNMS 14)

/groups/{groupname}/categories/{categoryname}

Associate a category with the group, given a group name and category name. (new in OpenNMS 14)

/groups/{groupname}

Delete a group.

/groups/{groupname}/users/{username}

Remove a user from the group. (new in OpenNMS 14)

/groups/{groupname}/categories/{categoryname}

Disassociate a category from a group, given a group name and category name. (new in OpenNMS 14)

/heatmap/outages/categories

Sizes and color codes based on outages for nodes grouped by Surveillance Categories

/heatmap/outages/foreignSources

Sizes and color codes based on outages for nodes grouped by Foreign Source

/heatmap/outages/monitoredServices

Sizes and color codes based on outages for nodes grouped by monitored services

/heatmap/outages/nodesByCategory/{category}

Sizes and color codes based on outages for nodes associated with a specific Surveillance Category

/heatmap/outages/nodesByForeignSource/{foreignSource}

Sizes and color codes based on outages for nodes associated with a specific Foreign Source

/heatmap/outages/nodesByMonitoredService/{monitoredService}

Sizes and color codes based on outages for nodes providing a specific monitored service

/heatmap/alarms/categories

Sizes and color codes based on alarms for nodes grouped by Surveillance Categories

/heatmap/alarms/foreignSources

Sizes and color codes based on alarms for nodes grouped by Foreign Source

/heatmap/alarms/monitoredServices

Sizes and color codes based on alarms for nodes grouped by monitored services

/heatmap/alarms/nodesByCategory/{category}

Sizes and color codes based on alarms for nodes associated with a specific Surveillance Category

/heatmap/alarms/nodesByForeignSource/{foreignSource}

Sizes and color codes based on alarms for nodes associated with a specific Foreign Source

/heatmap/alarms/nodesByMonitoredService/{monitoredService}

Sizes and color codes based on alarms for nodes providing a specific monitored service

/ifservices

Get all configured monitored services for the given search criteria.

/ifservices/

Update all configured monitored services for the given search criteria.

/ipinterfaces

Get all IP interfaces for the given search criteria.

/ksc

Get a list of all KSC reports, this includes ID and label.

/ksc/{reportId}

Get a specific KSC report, by ID.

/ksc/count

Get a count of all KSC reports.

/ksc/{reportId}

Modify a report with the given ID.

/maps

Get the list of maps.

/maps/{id}

Get the map with the given ID.

/maps/{id}/mapElements

Get the elements (nodes, links, etc.) for the map with the given ID.

/maps

Add a map.

/maps/{id}

Update the properties of the map with the given ID.

/maps/{id}

Delete the map with the given ID.

/measurements/{resourceId}/{attribute}

Retrieve the measurements for a single attribute

start

-14400000

Timestamp in milliseconds.

If > 0, the timestamp is relative to the UNIX epoch (January 1st 1970 00:00:00 AM).

If < 0, the timestamp is relative to the end option (i.e.: default value is 4 hours ago).

end

0

Timestamp in milliseconds. If <= 0, the effective value will be the current timestamp.

step

300000

Requested time interval between rows. Actual step may differ.

maxrows

0

When using the measurements to render a graph, this should be set to the graph’s pixel width.

aggregation

AVERAGE

Consolidation function used. Can typically be AVERAGE, MIN or MAX. Depends on RRA definitions.

fallback-attribute

Secondary attribute that will be queried in the case the primary attribute does not exist.

/measurements

Retrieve the measurements for one or more attributes, possibly spanning multiple resources, with support for JEXL expressions.

__inf

Double.POSITIVE_INFINITY

__neg_inf

Double.NEGATIVE_INFINITY

NaN

Double.NaN

__E

java.lang.Math.E

__PI

java.lang.Math.PI

__diff_time

Time span between start and end of samples

__step

Difference in time between subsequent values

__i

Index into the samples array which the present calculation is referencing

__AttributeName (where AttributeName is the searched for attribute)

This returns the complete double[] array of samples for AttributeName

jexl:evaluate("_formula"):

Passes a string to the JEXL engine to be evaluated as if it was entered as a normal expression. Like normal expressions, expressions evaluated through this function will return a Java double value. This makes it possible to reference and evaluate a formula which has been stored in OpenNMS as a string variable. The use case for this capability is that it gives us the ability to define and store a per-node and per-value correction formula which can normalise samples from different sample sources.

math:

References java.lang.Math class

math:cos(20)

strictmath:

References java.lang.StrictMath class

math:cos(20)

fn:

References the class org.opennms.netmgt.measurements.impl.SampleArrayFunctions. This contains several functions which can reference previous samples in the time series.

fn:arrayNaN("sampleName", n)

References the nth previous sample in the "sampleName" sample series. Replacing the n samples before the start of the series with NaN.

fn:arrayNaN("x", 5)

fn:arrayZero("sampleName", n)

References the nth previous sample in the "sampleName" sample series. Replacing the n samples before the start of the series with 0 (zero).

fn:arrayZero("x", 5)

fn:arrayFirst("sampleName", n)

References the nth previous sample in the "sampleName" sample series. Replacing the n samples before the start of the series with the first sample.

fn:arrayFirst("x", 5)

fn:arrayStart("sampleName", n, constant)

References the nth previous sample in the "sampleName" sample series. Replacing the n samples before the start of the series with a supplied constant.

fn:arrayStart("x", 5, 10)

api/v2/nodes/{id}/metadata

Get the list of meta-data associated with this node.

api/v2/nodes/{id}/metadata/{context}

Get the list of meta-data associated with this node filtered by the given context.

api/v2/nodes/{id}/metadata/{context}/{key}

Get the entry for the given context and key associated with this node.

api/v2/nodes/{id}/ipinterfaces/{ipInterface}/metadata

Get the list of meta-data associated with this interface.

api/v2/nodes/{id}/ipinterfaces/{ipInterface}/metadata/{context}

Get the list of meta-data associated with this interface filtered by the given context.

api/v2/nodes/{id}/ipinterfaces/{ipInterface}/metadata/{context}/{key}

Get the entry for the given context and key associated with this interface.

api/v2/nodes/{id}/ipinterfaces/{ipInterface}/services/{service}/metadata

Get the list of meta-data associated with this service.

api/v2/nodes/{id}/ipinterfaces/{ipInterface}/services/{service}/metadata/{context}

Get the list of meta-data associated with this service filtered by the given context.

api/v2/nodes/{id}/ipinterfaces/{ipInterface}/services/{service}/metadata/{context}/{key}

Get the entry for the given context and key associated with this service.

api/v2/nodes/{id}/metadata

Adds a meta-data entry to the given node.

api/v2/nodes/{id}/{ipInterface}/metadata

Adds a meta-data entry to the given interface.

api/v2/nodes/{id}/{ipInterface}/services/{service}/metadata

Adds a meta-data entry to the given service.

api/v2/nodes/{id}/metadata/{context}/{key}/{value}

Sets the given value for the node-level meta-data entry specified by the given context and key.

api/v2/nodes/{id}/ipinterfaces/{ipInterface}/metadata/{context}/{key}/{value}

Sets the given value for the interface-level meta-data entry specified by the given context and key.

api/v2/nodes/{id}/ipinterfaces/{ipInterface}/services/{service}/metadata/{context}/{key}/{value}

Sets the given value for the service-level meta-data entry specified by the given context and key.

api/v2/nodes/{id}/metadata/{context}

Deletes node-level meta-data with the given context.

api/v2/nodes/{id}/metadata/{context}/{key}

Deletes the node-level meta-data entry for the given context and key.

api/v2/nodes/{id}/ipinterfaces/{ipInterface}/metadata/{context}

Deletes interface-level meta-data with the given context.

api/v2/nodes/{id}/ipinterfaces/{ipInterface}/metadata/{context}/{key}

Deletes the interface-level meta-data entry for the given context and key.

api/v2/nodes/{id}/ipinterfaces/{ipInterface}/services/{service}/metadata/{context}

Deletes service-level meta-data with the given context.

api/v2/nodes/{id}/ipinterfaces/{ipInterface}/services/{service}/metadata/{context}/{key}

Deletes the service-level meta-data entry for the given context and key.

/nodes

Get a list of nodes. This includes the ID and node label.

/nodes/{id}

Get a specific node, by ID.

/nodes/{id}/ipinterfaces

Get the list of IP interfaces associated with the given node.

/nodes/{id}/ipinterfaces/{ipAddress}

Get the IP interface for the given node and IP address.

/nodes/{id}/ipinterfaces/{ipAddress}/services

Get the list of services associated with the given node and IP interface.

/nodes/{id}/ipinterfaces/{ipAddress}/services/{service}

Get the requested service associated with the given node, IP interface, and service name.

/nodes/{id}/snmpinterfaces

Get the list of SNMP interfaces associated with the given node.

/nodes/{id}/snmpinterfaces/{ifIndex}

Get the specific interface associated with the given node and ifIndex.

/nodes/{id}/categories

Get the list of categories associated with the given node.

/nodes/{id}/categories/{categoryName}

Get the category associated with the given node and category name.

/nodes/{id}/assetRecord

Get the asset record associated with the given node.

/nodes

Add a node.

/nodes/{id}/ipinterfaces

Add an IP interface to the node.

/nodes/{id}/ipinterfaces/{ipAddress}/services

Add a service to the interface for the given node.

/nodes/{id}/snmpinterfaces

Add an SNMP interface to the node.

/nodes/{id}/categories

Add a category association to the node.

/nodes/{id}

Modify a node with the given ID.

/nodes/{id}/ipinterfaces/{ipAddress}

Modify the IP interface with the given node ID and IP address.

/nodes/{id}/ipinterfaces/{ipAddress}/services/{service}

Modify the service with the given node ID, IP address, and service name.

/nodes/{id}/snmpinterfaces/{ifIndex}

Modify the SNMP interface with the given node ID and ifIndex.

/nodes/{id}/categories/{categoryName}

Modify the category with the given node ID and name.

/notifications

Get a list of notifications.

/notifications/count

Get the number of notifications. (Returns plaintext, rather than XML or JSON.)

/notifications/{id}

Get the notification specified by the given ID.

 /header/{start}/{end}/{width}

Generate the timeline header

 /image/{nodeId}/{ipAddress}/{serviceName}/{start}/{end}/{width}

Generate the timeline image

 /empty/{start}/{end}/{width}

Generate an empty timeline for non-monitored services

 /html/{nodeId}/{ipAddress}/{serviceName}/{start}/{end}/{width}

Generate the raw HTML for the image

/outages

Get a list of outages.

/outages/count

Get the number of outages. (Returns plaintext, rather than XML or JSON.)

/outages/{id}

Get the outage specified by the given ID.

/outages/forNode/{nodeId}

Get the outages that match the given node ID.

/requisitions

Get all active requisitions.

/requisitions/count

Get the number of active requisitions. (Returns plaintext, rather than XML or JSON.)

/requisitions/deployed

Get the list of all deployed (active) requisitions.

/requisitions/deployed/count

Get the number of deployed requisitions. (Returns plaintext, rather than XML or JSON.)

/requisitions/{name}

Get the active requisition for the given foreign source name.

/requisitions/{name}/nodes

Get the list of nodes being requisitioned for the given foreign source name.

/requisitions/{name}/nodes/{foreignId}

Get the node with the given foreign ID for the given foreign source name.

/requisitions/{name}/nodes/{foreignId}/interfaces

Get the interfaces for the node with the given foreign ID and foreign source name.

/requisitions/{name}/nodes/{foreignId}/interfaces/{ipAddress}

Get the interface with the given IP for the node with the specified foreign ID and foreign source name.

/requisitions/{name}/nodes/{foreignId}/interfaces/{ipAddress}/services

Get the services for the interface with the specified IP address, foreign ID, and foreign source name.

/requisitions/{name}/nodes/{foreignId}/interfaces/{ipAddress}/services/{service}

Get the given service with the specified IP address, foreign ID, and foreign source name.

/requisitions/{name}/nodes/{foreignId}/categories

Get the categories for the node with the given foreign ID and foreign source name.

/requisitions/{name}/nodes/{foreignId}/categories/{categoryName}

Get the category with the given name for the node with the specified foreign ID and foreign source name.

/requisitions/{name}/nodes/{foreignId}/assets

Get the assets for the node with the given foreign ID and foreign source name.

/requisitions/{name}/nodes/{foreignId}/assets/{assetName}

Get the value of the asset for the given assetName for the node with the given foreign ID and foreign source name.

/requisitions

Adds (or replaces) a requisition.

/requisitions/{name}/nodes

Adds (or replaces) a node in the specified requisition. This operation can be very helpful when working with [[Large Requisitions]].

/requisitions/{name}/nodes/{foreignId}/interfaces

Adds (or replaces) an interface for the given node in the specified requisition.

/requisitions/{name}/nodes/{foreignId}/interfaces/{ipAddress}/services

Adds (or replaces) a service on the given interface in the specified requisition.

/requisitions/{name}/nodes/{foreignId}/categories

Adds (or replaces) a category for the given node in the specified requisition.

/requisitions/{name}/nodes/{foreignId}/assets

Adds (or replaces) an asset for the given node in the specified requisition.

/requisitions/{name}/import

Performs an import/synchronize on the specified foreign source. This turns the "active" requisition into the "deployed" requisition.

/requisitions/{name}/import?rescanExisting=false

Performs an import/synchronize on the specified foreign source. This turns the "active" requisition into the "deployed" requisition. Existing nodes will not be scanned until the next rescan interval, only newly-added nodes will be. Useful if you’re planning on making a series of changes.

/requisitions/{name}

Update the specified foreign source.

/requisitions/{name}/nodes/{foreignId}

Update the specified node for the given foreign source.

/requisitions/{name}/nodes/{foreignId}/interfaces/{ipAddress}

Update the specified IP address for the given node and foreign source.

/requisitions/{name}

Delete the pending requisition for the named foreign source.

/requisitions/deployed/{name}

Delete the active requisition for the named foreign source.

/requisitions/{name}/nodes/{foreignId}

Delete the node with the given foreign ID from the given requisition.

/requisitions/{name}/nodes/{foreignId}/interfaces/{ipAddress}

Delete the IP address from the requisitioned node with the given foreign ID and foreign source.

/requisitions/{name}/nodes/{foreignId}/interfaces/{ipAddress}/services/{service}

Delete the service from the requisitioned interface with the given IP address, foreign ID and foreign source.

/requisitions/{name}/nodes/{foreignId}/categories/{category}

Delete the category from the node with the given foreign ID and foreign source.

/requisitions/{name}/nodes/{foreignId}/assets/{field}

Delete the field from the requisition’s nodes asset with the given foreign ID and foreign source.

/resources

Retrieve the full tree of resources in the system (expensive, use with care)

/resources/{resourceId}

Retrieve the tree of resources starting with the named resource ID

/resources/fornode/{nodeCriteria}

Retrieve the tree of resources for a node, given its database ID or foreign-source:foreign-ID tuple

/resources/{resourceId}

Delete resource with the named resource ID, and all its child resources, if any

depth

varies

GET only. Limits the tree depth for retrieved resources. Defaults to 1 when listing all resources, or to -1 (no limit) when listing a single resource.

/availability/categories/{category}

Get all nodes and availability data from a given SLA category filter, i.e. Web Servers (Web+Servers)

/availability/categories/{category}/nodes

Get node availability data for each node of a given SLA category filter

/availability/categories/{category}/nodes/{nodeId}

Get detailed service availability for a given node in a given SLA category filter

/availability/nodes/{nodeId}

Get detailed availability for all services on a given node

/sched-outages

to get a list of configured scheduled outages.

/sched-outages/{outageName}

to get the details of a specific outage.

/sched-outages

to add a new outage (or update an existing one).

/sched-outages/{outageName}/collectd/{package}

to add a specific outage to a collectd’s package.

/sched-outages/{outageName}/pollerd/{package}

to add a specific outage to a pollerd’s package.

/sched-outages/{outageName}/threshd/{package}

to add a specific outage to a threshd’s package.

/sched-outages/{outageName}/notifd

to add a specific outage to the notifications.

/sched-outages/{outageName}

to delete a specific outage.

/sched-outages/{outageName}/collectd/{package}

to remove a specific outage from a collectd’s package.

/sched-outages/{outageName}/pollerd/{package}

to remove a specific outage from a pollerd’s package.

/sched-outages/{outageName}/threshd/{package}

to remove a specific outage from a threshd’s package.

/sched-outages/{outageName}/notifd

to remove a specific outage from the notifications.

/snmpConfig/{ipAddress}

Get the SNMP configuration for a given IP address.

/snmpConfig/{ipAddress}?location={location}

Get the SNMP configuration for a given IP address at a given location.

/snmpConfig/{ipAddress}

Add or update the SNMP configuration for a given IP address.

version

version

v1

-

"v1", "v2c" or "v3" are valid arguments. If an invalid or empty argument is provided "v1" is used.

port

port

161

-

Integer > 0

retries

retry

1

-

Integer > 0

timeout

timeout

3000

-

Integer > 0

community

read-community

public

-

any string with a length >= 1

default

restricted to version

restriction

version

version

v1

-

"v1", "v2c" or "v3" are valid arguments. If an invalid or empty argument is provided "v1" is used.

port

port

161

-

Integer > 0

retries

retry

1

-

Integer > 0

timeout

timeout

3000

-

Integer > 0

maxVarsPerPdu

max-vars-per-pdu

10

-

Integer > 0

maxRepetitions

max-repetitions

2

-

Integer > 0

maxRequestSize

max-request-size

65535

-

Integer > 0

proxyHost

proxy-host

-

readCommunity

read-community

public

v1, v2c

writeCommunity

write-community

private

v1, v2c

securityName

security-name

opennmsUser

v3

securityLevel

security-level

noAuthNoPriv

v3

Integer value, which can be null, 1, 2, or 3. <ul><li>1 means noAuthNoPriv</li><li>2 means authNoPriv</li><li>3 means authPriv</li></ul> If you do not set the security level manually it is determined automatically: <ul><li>if no authPassPhrase set the securityLevel is 1</li><li>if a authPassPhrase and no privPassPhrase is set the security level is 2.</li><li>if a authPassPhrase and a privPassPhrase is set the security level is 3.</li></ul>

authPassPhrase

auth-passphrase

0p3nNMSv3

v3

authProtocol

auth-protocol

MD5

v3

only MD5, SHA, SHA-224, SHA-256, SHA-512 are valid arguments

privPassPhrase

privacy-passphrase

0p3nNMSv3

v3

privProtocol

privacy-protocol

DES

v3

only DES, AES, AES192 or AES256 are valid arguments.

engineId

engine-id

v3

contextEngineId

context-engine-id

v3

contextName

context-name

v3

enterpriseId

enterprise-id

v3

/snmpinterfaces

Get all SNMP interfaces for the given search criteria.

/users

Get a list of users.

/users/{username}

Get a specific user, by username.

/users

Add a user. If supplying a password it is assumed to be hashed or encrypted already, at least as of 1.12.5. To indicate that the supplied password uses the salted encryption algorithm rather than the older MD5 based algorithm, you need to pass an element named passwordSalt with text true after the password element (or key/value pairs if using JSON). Note: You may add the query parameter hashPassword=true to tell OpenNMS you are passing an unencrypted password; it will hash and salt the password when it is saved.

/users/{username}

Update an existing user’s full-name, user-comments, password, passwordSalt and duty-schedule values. Note: If you are setting the password, you may also add the query parameter hashPassword=true to tell OpenNMS you are passing an unencrypted password; it will hash and salt the password when it is saved.

/users/{username}/roles/{rolename}

Add a security role to the user. (new in OpenNMS 19)

/users/{username}

Delete a user.

/users/{username}/roles/{rolename}

Remove a security role from the user. (new in OpenNMS 19)

api/v2/userdefinedlinks

Get the list of UDLs.

api/v2/userdefinedlinks/{id}

Retrieve a specific UDL by database ID.

api/v2/userdefinedlinks

Add a new UDL.

api/v2/userdefinedlinks/{id}

Delete a UDL by database ID.

/config/snmptrap-nbi

Gets full content of the configuration.

/config/snmptrap-nbi/status

Gets the status of the SNMP Trap NBI (returns either true or false).

/config/snmptrap-nbi/destinations

Gets the name of all the existing destinations.

/config/snmptrap-nbi/destinations/{name}

Gets the content of the destination named {name}

/config/snmptrap-nbi/status?enabled=(true;false)

Sets the status of the SNMP Trap NBI.

/config/snmptrap-nbi

Updates the full content of the configuration.

/config/snmptrap-nbi/destinations

Adds a new or overrides an existing destination.

/config/snmptrap-nbi/destinations/{name}

Updates the content of the destination named {name}

/config/snmptrap-nbi/destinations/{name}

Updates the content of the destination named {name}

/config/email-nbi

Gets full content of the configuration.

/config/email-nbi/status

Gets the status of the Email NBI (returns either true or false).

/config/email-nbi/destinations

Gets the name of all the existing destinations.

/config/email-nbi/destinations/{name}

Gets the content of the destination named {name}

/config/email-nbi/status?enabled=(true;false)

Sets the status of the Email NBI.

/config/email-nbi/destinations

Adds a new or overrides an existing destination.

/config/email-nbi/destinations/{name}

Updates the content of the destination named {name}

/config/email-nbi/destinations/{name}

Updates the content of the destination named {name}

/config/javamail/default/readmail

Get the name of the default readmail config.

/config/javamail/default/sendmail

Get the name of the default sendmail config.

/config/javamail/readmails

Get the name of all the existing readmail configurations.

/config/javamail/sendmails

Get the name of all the existing sendmail configurations.

/config/javamail/end2ends

Get the name of all the existing end2end mail configurations.

/config/javamail/readmails/{name}

Get the content of the readmail configuration named {name}

/config/javamail/sendmails/{name}

Get the content of the sendmail configuration named {name}

/config/javamail/end2ends/{name}

Get the content of the end2end mail configuration named {name}

/config/javamail/readmails

Adds a new or overrides an existing readmail configuration.

/config/javamail/sendmails

Adds a new or overrides an existing sendmail configuration.

/config/javamail/end2ends

Adds a new or overrides an existing end2ends mail configuration.

config/javamail/default/readmail/{name}

Sets the readmail named {name} as the new default.

config/javamail/default/sendmail/{name}

Sets the sendmail named {name} as the new default.

/config/javamail/readmails/{name}

Updates the content of the readmail configuration named {name}

/config/javamail/sendmails/{name}

Updates the content of the sendmail configuration named {name}

/config/javamail/end2ends/{name}

Updates the content of the end2end mail configuration named {name}

/config/javamail/readmails/{name}

Removes the readmail configuration named {name}

/config/javamail/sendmails/{name}

Removes the sendmail configuration named {name}

/config/javamail/end2ends/{name}

Removes the end2end mail configuration named {name}

/config/syslog-nbi

Gets full content of the configuration.

/config/syslog-nbi/status

Gets the status of the Syslog NBI (returns either true or false).

/config/syslog-nbi/destinations

Gets the name of all the existing destinations.

/config/syslog-nbi/destinations/{name}

Gets the content of the destination named {name}

/config/syslog-nbi/status?enabled=(true;false)

Sets the status of the Syslog NBI.

/config/syslog-nbi

Updates the full content of the configuration.

/config/syslog-nbi/destinations

Adds a new or overrides an existing destination.

/config/syslog-nbi/destinations/{name}

Updates the content of the destination named {name}

/config/syslog-nbi/destinations/{name}

Updates the content of the destination named {name}

/opennms/api/v2/business-services

Provides a brief list of all defined Business Services

/opennms/api/v2/business-services/{id}

Returns the Business Service identified by id included the current operational state

/opennms/api/v2/business-services/egdes/{edgeId}

Returns the edge of the Business Service identified by edgeId

/opennms/api/v2/business-services/functions/map

Provides a list of supported Map Function definitions

/opennms/api/v2/business-services/functions/map/{name}

Returns the definition of the Map Function identified by name

/opennms/api/v2/business-services/functions/reduce/

Provides a list of supported Reduce Function definitions

/opennms/api/v2/business-services/functions/reduce/{name}

Returns the definition of the Reduce Function identified by name

/opennms/api/v2/business-services/{id}

Modifies an existing Business Service identified by id

/opennms/api/v2/business-services

Creates a new Business Service

/opennms/api/v2/business-services/{id}/ip-service-edge

Adds an edge of type IP Service to the Business Service identified by id

/opennms/api/v2/business-services/{id}/reduction-key-edge

Adds an edge of type Reduction Key to the Business Service identified by id

/opennms/api/v2/business-services/{id}/child-edge

Adds an edge of type Business Service to the Business Service identified by id

/opennms/api/v2/daemon/reload

Reload the configuration of the Business Service Daemon

/opennms/api/v2/business-services/{id}

Deletes the Business Service identified by id

/opennms/api/v2/business-services/{id}/edges/{edgeId}

Removes an edge with the identifier edgeId from the Business Service identified by id

/opennms/api/v2/discovery

Submits an one-time scan configuration

/situation-feedback/{situationId}

Get Situation Feedback for the Situation with AlarmId = {situationId}.

/situation-feedback/{situationId}

Submits feedback for the Situation identitified with AlarmId = {situationId}.