Rest API

xCAT provides REST API (also called a web services API) that is currently implemented as a front end (translation layer) to xcatd. This provides programmatic access to xCAT from any language. This document describes how to set it up and use it.

NOTE: This doc is working with xCAT 2.8.4 and later.

• Set Up Web Service for Rest API
  • Enable the HTTPS service for REST API
  • Enable the Certificate of HTTPs Server (Optional)
  • Extend the Timeout of Web Server
  • Set Up an Account for Web Service Access
• How to Use xCAT Rest API
  • The Resource Categories
  • The Authentication Methods for REST API
  • The Common Parameters for Resource URI
  • The Output of REST API request
  • Testing the API
  • Web Service Status Codes
  • References
• xCAT Rest API Resources
  • Token Resources
  • Node Resources
  • Osimage resources
  • Network Resources
  • Policy Resources
  • Group Resources
  • Global Configuration Resources
  • Service Resources
  • Table Resources