Monitoring health of Aria Operations using API (Services, nodes, locator, Casa, Collector, Analytics, etc)
search cancel

Monitoring health of Aria Operations using API (Services, nodes, locator, Casa, Collector, Analytics, etc)

book

Article ID: 377784

calendar_today

Updated On:

Products

VMware Aria Suite VMware Aria Operations 8.x

Issue/Introduction

Aria Operations provides a set of APIs that allow users to interact programmatically with the platform.
These APIs facilitate automation, integration, and custom application development.

Environment

VMware Aria Operations 8.x

Resolution

Use the APIs with Get calls. 

Set Up Authentication
Most APIs require some form of authentication. This could be an API key, OAuth token, or other methods. Ensure you have the necessary credentials.

Make API Calls
Use tools like Postman, curl, or your programming language's HTTP libraries to make requests to the API endpoints.

For ex: curl -X GET "https://<IP/FQDN>/suite-api/api/deployment/node/status?services=locator" -H "Authorization: Bearer <YOUR_TOKEN>"

Service Status Calls
        https://<IP/FQDN>/suite-api/api/deployment/node/status?services=locator
    https://<IP/FQDN>/suite-api/api/deployment/node/status?services=casa
    https://<IP/FQDN>/suite-api/api/deployment/node/status?services=ui
    https://<IP/FQDN>/suite-api/api/deployment/node/status?services=collector
    https://<IP/FQDN>/suite-api/api/deployment/node/status?services=analytics
    https://<IP/FQDN>/suite-api/api/deployment/node/status?services=api
    https://<IP/FQDN>/suite-api/api/deployment/node/status?services=adminui

Multiple Services Status Calls
      https://<IP/FQDN>/suite-api/api/deployment/node/status?services=analytics&services=collector
    https://<IP/FQDN>/suite-api/api/deployment/node/status?services=casa&services=ui&services=adminui

Node Status Call
    https://<IP/FQDN>/suite-api/api/deployment/node/status

NOTE: Replace <IP/FQDN> with the actual IP address or fully qualified domain name of your Aria Operations Master or ELB.