find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/red-hat-openshift-clusters-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Red Hat OpenShift Cluster Manager Clusters API
  description: The OpenShift Cluster Manager (OCM) API provides programmatic access to the Red Hat Hybrid Cloud Console for managing OpenShift clusters at scale. It supports creating, updating, and deleting clusters; managing cluster add-ons; configuring identity providers and role bindings; monitoring cluster health and metrics; and managing subscriptions and quotas. Used by the OCM CLI, the Hybrid Cloud Console web UI, and partners building cluster management automation.
  version: '1'
  contact:
    name: Red Hat OpenShift Support
    url: https://access.redhat.com/support
  termsOfService: https://www.redhat.com/en/about/agreements
servers:
- url: https://api.openshift.com
  description: OpenShift Cluster Manager API
security:
- bearerAuth: []
tags:
- name: Clusters
  description: Manage OpenShift clusters across cloud providers
paths:
  /api/clusters_mgmt/v1/clusters:
    get:
      operationId: listClusters
      summary: List Clusters
      description: Returns a list of OpenShift clusters registered with the Cluster Manager. Supports filtering by cloud provider, region, version, and state. Results are paginated.
      tags:
      - Clusters
      parameters:
      - name: page
        in: query
        description: Page number for pagination (1-indexed)
        schema:
          type: integer
          default: 1
      - name: size
        in: query
        description: Number of results per page
        schema:
          type: integer
          default: 100
      - name: search
        in: query
        description: SQL-like search expression for filtering
        schema:
          type: string
      - name: order
        in: query
        description: SQL-like ORDER BY clause
        schema:
          type: string
      responses:
        '200':
          description: List of clusters returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterList'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: createCluster
      summary: Create Cluster
      description: Creates a new OpenShift cluster on the specified cloud provider and region. Supports ROSA (AWS), ARO (Azure), and other OpenShift flavors.
      tags:
      - Clusters
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Cluster'
      responses:
        '201':
          description: Cluster creation initiated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Cluster'
        '400':
          description: Invalid cluster configuration
        '401':
          $ref: '#/components/responses/Unauthorized'
  /api/clusters_mgmt/v1/clusters/{cluster_id}:
    get:
      operationId: getCluster
      summary: Get Cluster
      description: Returns detailed information about a specific OpenShift cluster.
      tags:
      - Clusters
      parameters:
      - $ref: '#/components/parameters/clusterId'
      responses:
        '200':
          description: Cluster details returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Cluster'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    patch:
      operationId: updateCluster
      summary: Update Cluster
      description: Updates an existing cluster configuration (partial update).
      tags:
      - Clusters
      parameters:
      - $ref: '#/components/parameters/clusterId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClusterPatch'
      responses:
        '200':
          description: Cluster updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Cluster'
    delete:
      operationId: deleteCluster
      summary: Delete Cluster
      description: Deletes an OpenShift cluster. This operation is irreversible.
      tags:
      - Clusters
      parameters:
      - $ref: '#/components/parameters/clusterId'
      responses:
        '204':
          description: Cluster deletion initiated
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    Error:
      type: object
      properties:
        kind:
          type: string
        id:
          type: string
        href:
          type: string
        code:
          type: string
        reason:
          type: string
    Cluster:
      type: object
      properties:
        kind:
          type: string
          default: Cluster
        id:
          type: string
        href:
          type: string
        name:
          type: string
        display_name:
          type: string
        cloud_provider:
          type: object
          properties:
            id:
              type: string
        region:
          type: object
          properties:
            id:
              type: string
        version:
          type: object
          properties:
            id:
              type: string
            raw_id:
              type: string
        state:
          type: string
          enum:
          - ready
          - installing
          - uninstalling
          - error
          - hibernating
        creation_timestamp:
          type: string
          format: date-time
        managed:
          type: boolean
        multi_az:
          type: boolean
        nodes:
          type: object
          properties:
            compute:
              type: integer
            infra:
              type: integer
            master:
              type: integer
        api:
          type: object
          properties:
            url:
              type: string
        console:
          type: object
          properties:
            url:
              type: string
    ClusterList:
      type: object
      properties:
        kind:
          type: string
          default: ClusterList
        page:
          type: integer
        size:
          type: integer
        total:
          type: integer
        items:
          type: array
          items:
            $ref: '#/components/schemas/Cluster'
    ClusterPatch:
      type: object
      properties:
        display_name:
          type: string
        nodes:
          type: object
          properties:
            compute:
              type: integer
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Authentication required or invalid token
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  parameters:
    clusterId:
      name: cluster_id
      in: path
      required: true
      description: The cluster identifier
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
externalDocs:
  description: OpenShift Cluster Manager API Documentation
  url: https://api.openshift.com/