Summary of changes in the REST API for v1.3

This documentation includes new methods and parameters that apply to the current XClarity Orchestrator release and later. If you are using an earlier release of XClarity Orchestrator, you can use the REST API Reference PDF for a list of methods and parameters that apply to that specific release. To find PDFs for the release that you need, see PDF files.

The following methods were added or updated in this release.

• Authentication and authorization
  • (New) GET /api/v1/auth/functions. Return a list of all functions, organized by category and function set.
  • (New) GET /api/v1/auth/roles. Return a list of all roles.
  • (New) GET /api/v1/auth/roles/{id}. Return information about a specific role.
• Resources
  • GET /api/v1/connector/managers/{id}. Added the authSource response attribute to return the name of the authorization source for VMware vRealize Operations Manager resource managers.
  • POST /api/v1/connector/managers. Added support to connect to vRealize Operations Manager as a resource manager.
  • (New) GET /api/v1/connector/vrealizeAuthSources. Returns a list of authorization source for a specific vRealize Operations Manager resource manager.
  • GET /api/v1/data/devices and GET /api/v1/data/devices/{id}. Added the tips response attribute to return the number of tech tips that are associated with the device.
  • (New) GET /api/v1/data/techTips. Returns a list of tech tips that are associated with a specific device.
• Analytics
  • (New) GET /customAlerts/metrics. Return a list of metrics that can be used in custom alert rules.
  • (New) GET /api/v1/customAlerts/rules. Returns a list of all custom alert rules.
  • (New) POST /api/v1/customAlerts/rules. Creates a custom alert rule.
  • (New) GET /api/v1/customAlerts/rules/{id}. Returns information about a specific custom alert rule.
  • (New) PUT /api/v1/customAlerts/rules/{id}. Modifies a specific custom alert rule.
  • (New) PATCH /api/v1/customAlerts/rules/{id_list}. Enables or disables one or more custom alert rules.
  • (New) DELETE /api/v1/customAlerts/rules/{id_list}. Deletes one or more custom alert rules.
• Service and support
  • (New) DELETE /api/v1/knowledge/devices/{id}. Unmanage a specific device that is managed offline.