REST API Client Requirements for the CloudControl API

Overview

This article outlines the fundamental requirements for REST clients that are suitable to use for making successful requests to the CloudControl API.

The article applies equally for REST clients that are embedded in code integrations as for those that are intended for human use, although the latter is the primary focus of this outline.

Requirements

CloudControl is a REST-style stateless API and requires that each REST client supports the ability to:

1. communicate over HTTPS.
2. set an arbitrary request URL.
3. specify HTTP BASIC Authorization header.
4. specify HTTP Request Headers and respective values.
5. specify HTTP Request Parameters.
6. specify arbitrary Request Body content. 
   1. *API 0.9 supports a combination of HTTP FORM and XML requests.
   2. *API 2 supports either JSON or XML on any request.
7. copy and paste request samples, and values from responses.

*The request format is of less relevance if accessing Reports APIs. Refer to the API documentation for detailed information.

Nice to have REST Client features

1. JSON request and response formatting for ease of reading.
2. XML request and response formatting for ease of reading.
3. The ability to save and substitute variables, e.g. an API host.
4. The ability to save, organize and reuse requests, e.g. Get Network Domain.

Example REST Client

Postman REST Client (https://www.getpostman.com/) was used for all screenshots in API integration articles on this documentation website.

Troubleshooting

For detailed API usage please refer to the API documentation.

The most likely error scenarios that Users encounter when first attempting to use the CloudControl REST API are: 

1. Incorrectly configured Authorization Request Header
2. Incorrect API URL
   1. Missing \{org-id\}
3. Incorrect Request Method
4. Missing Accept Request Header
5. Typographic Error in JSON or XML content.

How do I Determine the ID of a Cloud Account or Other Cloud Resource

Recently Updated

• Page:
  Introduction to Usage Reporting
• Page:
  Cloud Backup - Introduction
• Page:
  Introduction to Geographic Regions
• Page:
  Introduction to the Import / Export Function
• Page:
  Introducing the Red Hat Update Infrastructure v3