Quick Start
Complete these tasks to set up your environment and use the REST API to configure or query Oracle Communications Unified Assurance microservices.
Prerequisites
Prerequisite | More Information |
---|---|
Install Unified Assurance and set up a microservices cluster. | See:
|
Set up authentication for the REST API. | Authenticate |
Install the Unified Assurance Discovery Service microservice and the following prerequisite microservices:
|
Discovery Service in Unified Assurance Implementation Guide |
Task 1: Obtain account information
From your AAA administrator, obtain the account credentials for accessing the REST API. The default account is api.
Task 2: Send a request
You can send a simple cURL request to ensure that your connection works. For example, if you want to get the status of discovery, you can use one of the following requests, depending on your authentication method.
For basic authentication:
curl -u api:password -X GET https://host:port/discovery/request/status/
For TLS authentication:
curl --cert user-api.crt --key user-api.key -X GET https://host:port/discovery/request/status/
where:
- api:password are the user name and password for accessing the API
- user-api.crt and user-api.key are the TLS certificate and key for the API user
-
host:port
are the host and port where the API is running
If you have not initiated any discovery jobs, your request should be accepted, and you will get a 204 response code.