Accessing the Network Performance Management Web API

Learn how to use the Oracle Communications Unified Assurance Network Performance Management (NPM) Web API to interact with the discovery and thresholding processes.

Accessing the API Information

You can access the OpenAPI specification for the NPM Web API at the following location:

https://<hostFQDN>/docs/rest-api-guides/web-api-rest-api-guide

where <hostFQDN> is the host FQDN for your presentation server.

Setting Up REST API Authentication and Authentication

To access a particular endpoint, add the user to a group that is assigned a role with the appropriate permissions. See Authentication Options and Adding User Accounts in Unified Assurance Security Guide for information about roles, users, and user groups in Unified Assurance.

The following roles are already defined:

SSL certificates provide authentication for the NPM Web API. The SSL certificate for the api user is generated by default. To set up authentication for other users, generate an SSL certificate using the CreateSSLCertificate application, specifying User for the --type option and the appropriate user name for the --CN option. See CreateSSLCertificate in Unified Assurance Implementation Guide for more information on generating SSL certificates.

Sending Requests

You can use cURL or your preferred REST client to send requests. To send cURL commands, you must include the certificate details. For example, to check if the API is running, run the following cURL command:

curl --cacert /$A1BASEDIR/etc/ssl/BundleCA.crt --cert /$A1BASEDIR/etc/ssl/User-api.crt --key /$A1BASEDIR/etc/ssl/User-api.key -X GET https://<hostFQDN>:9443/api/openapi/discovery/v1/discoveryJob

For more information about cURL, including how to install and run commands, see the cURL documentation.

If you want to use a different REST client, download the NPM Web OpenAPI JSON definition according to the instructions in Accessing the API Information.