IBM TS7785 REST API

This section provides information about Representational State Transfer (RESTful) API.

Connecting to the TS7785 API
The TS7785 REST model Application Programming Interface (API) consists of commands that are used to read system resources. The RESTful API uses HTTPS (Hypertext Transfer Protocol Secure) to provide an encrypted channel between the client and the server. You must create a token for authentication.
Example script
Python example for TS7785 REST API authentication and clusters endpoint queries.
Run API queries and understand JSON response formats
Use HTTP GET requests to query the TS7785 REST API and interpret the JSON-formatted responses that are returned.
API Description Document
Download the machine-readable API description document from the TS7785 to use as a reference for building programs and parsing RESTful API responses.
Error Handling
Review the HTTP response status codes that the TS7785 RESTful API returns to identify and handle errors in your requests.
REST API endpoint versioning
The REST API uses two request headers, X-API-Version and X-API-Release, to control the generation version and endpoint version independently. Breaking changes are delivered in new API versions. Additive changes are available across all supported versions.
REST API Pagination
Use pagination parameters with the REST API to control the amount of data that is returned and to retrieve specific items from a response.

Parent topic: Management interfaces: GUI and REST API