Summary of changes in the REST API for v2.1

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.

• Orchestrator
  • (New) POST /api/v1/maintenance/powerOption. Reboot or shut down the orchestrator server.
• Resources
  • POST /api/v1/boarding/management. Added a response body for managing and discovering servers in bulk.
  • GET /api/v1/managers-management/managers and GET /api/v1/managers-management/managers/{id}. Added the XClarity Management Hub 2.0 value to the type response attribute.
  • POST /api/v1/managers-management/managers. Add support to manage Lenovo XClarity Management Hub 2.0.
• Jobs
  • (New) GET /api/v1/jobs-management/schedules. Returns a list of all scheduled jobs.
  • (New) POST /api/v1/jobs-management/schedules. Creates a scheduled job.
  • (New) GET /api/v1/jobs-management/schedules/{id}. Returns information about a specific schedule job.
  • (New) DELETE /api/v1/jobs-management/schedules/{id}. Cancels a scheduled job.