# Azure Red Hat OpenShift Hosted Control Planes management API

> Azure Red Hat OpenShift Hosted Control Planes management API on Apizie: 35 endpoints (List the operations for the provider, Lists all OpenShift versions available to install in the specified location., Gets an available OpenShift version to install in the specified location., Lists a mapping of OpenShift versions to identity requirements, which include operatorName,…, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/cloud:azure-arm-redhatopenshift/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:azure-arm-redhatopenshift`
- Category: Cloud
- Status: byok
- Source: https://learn.microsoft.com/rest/api/azure/
- Page: https://apizie.tech/api/cloud/azure-arm-redhatopenshift
- OpenAPI: https://apizie.tech/api/cloud/azure-arm-redhatopenshift/openapi.json

Azure Resource Manager API for Red Hat OpenShift Hosted Control Planes: manage these Azure resources in your subscription with a Microsoft Entra access token.

## Endpoints

### List the operations for the provider
`GET https://apizie.tech/v1/cloud:azure-arm-redhatopenshift/operations-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |

### Lists all OpenShift versions available to install in the specified location.
`GET https://apizie.tech/v1/cloud:azure-arm-redhatopenshift/open-shift-versions-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| location | string | yes | The name of the Azure region. |

### Gets an available OpenShift version to install in the specified location.
`GET https://apizie.tech/v1/cloud:azure-arm-redhatopenshift/open-shift-versions-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| location | string | yes | The name of the Azure region. |
| openShiftVersion | string | yes | The desired version value of the OpenShiftVersion resource. |

### Lists a mapping of OpenShift versions to identity requirements, which include operatorName,…
`GET https://apizie.tech/v1/cloud:azure-arm-redhatopenshift/platform-workload-identity-role-sets-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| location | string | yes | The name of the Azure region. |

### Gets a mapping of an OpenShift version to identity requirements, which includes operatorName,…
`GET https://apizie.tech/v1/cloud:azure-arm-redhatopenshift/platform-workload-identity-role-set-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| location | string | yes | The name of the Azure region. |
| openShiftMinorVersion | string | yes | The desired version value of the PlatformWorkloadIdentityRoleSet resource. |

### Lists OpenShift clusters in the specified subscription.
`GET https://apizie.tech/v1/cloud:azure-arm-redhatopenshift/open-shift-clusters-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |

### Lists OpenShift clusters in the specified subscription and resource group.
`GET https://apizie.tech/v1/cloud:azure-arm-redhatopenshift/open-shift-clusters-list-by-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |

### Gets a OpenShift cluster with the specified subscription, resource group and resource name.
`GET https://apizie.tech/v1/cloud:azure-arm-redhatopenshift/open-shift-clusters-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| resourceName | string | yes | The name of the OpenShift cluster resource. |

### Creates or updates a OpenShift cluster with the specified subscription, resource group and resource name.
`POST https://apizie.tech/v1/cloud:azure-arm-redhatopenshift/open-shift-clusters-create-or-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| resourceName | string | yes | The name of the OpenShift cluster resource. |
| body | object | yes | JSON request body |

### Creates or updates a OpenShift cluster with the specified subscription, resource group and resource name.
`POST https://apizie.tech/v1/cloud:azure-arm-redhatopenshift/open-shift-clusters-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| resourceName | string | yes | The name of the OpenShift cluster resource. |
| body | object | yes | JSON request body |

### Deletes a OpenShift cluster with the specified subscription, resource group and resource name.
`POST https://apizie.tech/v1/cloud:azure-arm-redhatopenshift/open-shift-clusters-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| resourceName | string | yes | The name of the OpenShift cluster resource. |

### Lists admin kubeconfig of an OpenShift cluster with the specified subscription, resource group and resource…
`POST https://apizie.tech/v1/cloud:azure-arm-redhatopenshift/open-shift-clusters-list-admin-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| resourceName | string | yes | The name of the OpenShift cluster resource. |

### Lists credentials of an OpenShift cluster with the specified subscription, resource group and resource name.
`POST https://apizie.tech/v1/cloud:azure-arm-redhatopenshift/open-shift-clusters-list-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| resourceName | string | yes | The name of the OpenShift cluster resource. |

### List HcpOpenShiftCluster resources by subscription ID
`GET https://apizie.tech/v1/cloud:azure-arm-redhatopenshift/hcp-open-shift-clusters-list-by-subscription` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |

### List HcpOpenShiftVersion resources by SubscriptionLocationResource
`GET https://apizie.tech/v1/cloud:azure-arm-redhatopenshift/hcp-open-shift-versions-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| location | string | yes | The name of the Azure region. |

### Get a HcpOpenShiftVersion
`GET https://apizie.tech/v1/cloud:azure-arm-redhatopenshift/hcp-open-shift-versions-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| location | string | yes | The name of the Azure region. |
| hcpOpenShiftVersionName | string | yes | The name of the HcpOpenShiftVersion |

### List HcpOperatorIdentityRoleSet resources by SubscriptionLocationResource
`GET https://apizie.tech/v1/cloud:azure-arm-redhatopenshift/hcp-operator-identity-role-sets-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| location | string | yes | The name of the Azure region. |

### Get a HcpOperatorIdentityRoleSet
`GET https://apizie.tech/v1/cloud:azure-arm-redhatopenshift/hcp-operator-identity-role-sets-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| location | string | yes | The name of the Azure region. |
| hcpOperatorIdentityRoleSetName | string | yes | The OpenShift minor version these identities are required for. |

### List HcpOpenShiftCluster resources by resource group
`GET https://apizie.tech/v1/cloud:azure-arm-redhatopenshift/hcp-open-shift-clusters-list-by-resource-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |

### Get a HcpOpenShiftCluster
`GET https://apizie.tech/v1/cloud:azure-arm-redhatopenshift/hcp-open-shift-clusters-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hcpOpenShiftClusterName | string | yes | The name of the HcpOpenShiftCluster |

### Create a HcpOpenShiftCluster
`POST https://apizie.tech/v1/cloud:azure-arm-redhatopenshift/hcp-open-shift-clusters-create-or-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hcpOpenShiftClusterName | string | yes | The name of the HcpOpenShiftCluster |
| body | object | yes | JSON request body |

### Update a HcpOpenShiftCluster
`POST https://apizie.tech/v1/cloud:azure-arm-redhatopenshift/hcp-open-shift-clusters-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hcpOpenShiftClusterName | string | yes | The name of the HcpOpenShiftCluster |
| body | object | yes | JSON request body |

### Delete a HcpOpenShiftCluster
`POST https://apizie.tech/v1/cloud:azure-arm-redhatopenshift/hcp-open-shift-clusters-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hcpOpenShiftClusterName | string | yes | The name of the HcpOpenShiftCluster |

### List ExternalAuth resources by HcpOpenShiftCluster
`GET https://apizie.tech/v1/cloud:azure-arm-redhatopenshift/external-auths-list-by-parent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hcpOpenShiftClusterName | string | yes | The name of the HcpOpenShiftCluster |

### Get a ExternalAuth
`GET https://apizie.tech/v1/cloud:azure-arm-redhatopenshift/external-auths-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hcpOpenShiftClusterName | string | yes | The name of the HcpOpenShiftCluster |
| externalAuthName | string | yes | The name of the ExternalAuth |

### Create a ExternalAuth
`POST https://apizie.tech/v1/cloud:azure-arm-redhatopenshift/external-auths-create-or-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hcpOpenShiftClusterName | string | yes | The name of the HcpOpenShiftCluster |
| externalAuthName | string | yes | The name of the ExternalAuth |
| body | object | yes | JSON request body |

### Update a ExternalAuth
`POST https://apizie.tech/v1/cloud:azure-arm-redhatopenshift/external-auths-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hcpOpenShiftClusterName | string | yes | The name of the HcpOpenShiftCluster |
| externalAuthName | string | yes | The name of the ExternalAuth |
| body | object | yes | JSON request body |

### Delete a ExternalAuth
`POST https://apizie.tech/v1/cloud:azure-arm-redhatopenshift/external-auths-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hcpOpenShiftClusterName | string | yes | The name of the HcpOpenShiftCluster |
| externalAuthName | string | yes | The name of the ExternalAuth |

### List NodePool resources by HcpOpenShiftCluster
`GET https://apizie.tech/v1/cloud:azure-arm-redhatopenshift/node-pools-list-by-parent` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hcpOpenShiftClusterName | string | yes | The name of the HcpOpenShiftCluster |

### Get a NodePool
`GET https://apizie.tech/v1/cloud:azure-arm-redhatopenshift/node-pools-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hcpOpenShiftClusterName | string | yes | The name of the HcpOpenShiftCluster |
| nodePoolName | string | yes | The name of the NodePool |

### Create a NodePool
`POST https://apizie.tech/v1/cloud:azure-arm-redhatopenshift/node-pools-create-or-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hcpOpenShiftClusterName | string | yes | The name of the HcpOpenShiftCluster |
| nodePoolName | string | yes | The name of the NodePool |
| body | object | yes | JSON request body |

### Update a NodePool
`POST https://apizie.tech/v1/cloud:azure-arm-redhatopenshift/node-pools-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hcpOpenShiftClusterName | string | yes | The name of the HcpOpenShiftCluster |
| nodePoolName | string | yes | The name of the NodePool |
| body | object | yes | JSON request body |

### Delete a NodePool
`POST https://apizie.tech/v1/cloud:azure-arm-redhatopenshift/node-pools-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hcpOpenShiftClusterName | string | yes | The name of the HcpOpenShiftCluster |
| nodePoolName | string | yes | The name of the NodePool |

### Request a temporary admin kubeconfig for the cluster
`POST https://apizie.tech/v1/cloud:azure-arm-redhatopenshift/hcp-open-shift-clusters-request-admin-credential` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hcpOpenShiftClusterName | string | yes | The name of the HcpOpenShiftCluster |
| body | object | yes | JSON request body |

### Revoke all credentials issued by requestAdminCredential
`POST https://apizie.tech/v1/cloud:azure-arm-redhatopenshift/hcp-open-shift-clusters-revoke-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| api-version | string | no | The API version to use for this operation. |
| subscriptionId | string | yes | The ID of the target subscription. The value must be an UUID. |
| resourceGroupName | string | yes | The name of the resource group. The name is case insensitive. |
| hcpOpenShiftClusterName | string | yes | The name of the HcpOpenShiftCluster |

## Example
```
curl "https://apizie.tech/v1/cloud:azure-arm-redhatopenshift/operations-list" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Azure Red Hat OpenShift Hosted Control Planes management API?
Create a free Apizie key, then send GET https://apizie.tech/v1/cloud:azure-arm-redhatopenshift/operations-list with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Azure Red Hat OpenShift Hosted Control Planes management API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Azure Red Hat OpenShift Hosted Control Planes management itself also needs your own key from azure.com.

### Can AI agents use the Azure Red Hat OpenShift Hosted Control Planes management API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:azure-arm-redhatopenshift.

### What is the status of the Azure Red Hat OpenShift Hosted Control Planes management API?
Needs your own provider key (bring your own key)