xCAT
latest
  • Overview
  • Install Guides
  • Get Started
  • Admin Guide
  • Advanced Topics
    • Chain
    • Cluster Maintenance
    • Migrate xCat Management node
    • Confluent
    • Go Conserver
    • Docker
    • Domain Name Resolution
    • GPUs
    • High Availability
    • Hierarchical Clusters / Large Cluster Support
    • Software Kits
    • Mixed Cluster
    • Networking
    • PDUs
    • Port Usage
    • xCAT probe
    • RAID
    • Rest API
      • Set Up Web Service for Rest API
      • How to Use xCAT Rest API
      • xCAT Rest API Resources
    • Security
    • Performance Tuning
    • SoftLayer
    • System Clone (sysclone)
    • Zones
    • xcat-inventory
  • Questions & Answers
  • Reference Implementation
  • Troubleshooting
  • Developers
  • Need Help
  • Security Notices
xCAT
  • Docs »
  • Advanced Topics »
  • Rest API
  • Edit on GitHub

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 protocol for REST API
    • Enable the Certificate of HTTPs Server (Optional)
    • 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
Next Previous

© Copyright 2015-2022, IBM Corporation Revision 6b8c6691.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: latest
Versions
latest
stable
2.16.5
2.16.4
2.16.3
2.16.2
2.16.1
2.16.0
2.15.1
2.15.0
2.14.6
2.14.5
2.14.4
2.14.3
2.14.2
2.14.1
2.14.0
2.13.11
2.12
2.11
2.9
Downloads
pdf
html
epub
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.