Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Red Hat Cloud Providers API

Operations for listing available cloud providers and their regions for cluster deployment.

Red Hat Cloud Providers API is one of 75 APIs that Red Hat publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Cloud Providers. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a getting-started guide, a changelog, and a GitHub repository.

This API exposes 2 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 2.6.

Requests are made against a single base URL, https://ansible-platform.example.com.

2 operations 2 paths 3 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.6
Server
https://ansible-platform.example.com
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Red Hat Cloud Providers API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — OAuth 2.0 Bearer token for authenticating API requests to the automation controller.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Cloud Providers 2

Operations for listing available cloud providers and their regions for cluster deployment.

GET
/api/clusters_mgmt/v1/cloud_providers
Red Hat List Cloud Providers
listCloudProviders 2 params → 200401
GET
/api/clusters_mgmt/v1/cloud_providers/{cloud_provider_id}/regions
Red Hat List Cloud Provider Regions
listCloudProviderRegions 3 params → 200401404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are CloudRegionList (5 properties), Error (5 properties), CloudProviderList (5 properties). Each schema is shown below with its type and property counts.

CloudProviderList
object
A paginated list of cloud providers.
5 properties
Error
object
An error response from the API.
5 properties 4 required
CloudRegionList
object
A paginated list of cloud regions.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

red-hat-cloud-providers-api-openapi.yml Raw ↑

Other APIs Red Hat publishes across the network.

Red Hat Subscription Management API
Red Hat Advanced Cluster Management API
Red Hat Advanced Cluster Security API
Red Hat 3scale API Management
Red Hat Cost Management API
Red Hat Image Builder API
Red Hat Vulnerability Management API
Red Hat Patch API
Red Hat Compliance API
Red Hat Build of Apicurio Registry API
Red Hat Streams for Apache Kafka Bridge API
Red Hat Ansible Lightspeed API