Skip to main content

Connector API calls

The Red Hat OpenShift connector makes API calls to the OpenShift Container Platform APIs and KubeVirt APIs to retrieve data. These calls are documented below.

Cluster client based API calls​

Users​

Uses the GET operation to list or watch objects of kind User.

URI: /apis/user.openshift.io/v1/users/

For more information, refer to OpenShift container platform API docs .

Nodes​

Uses the GET operation to retrieve node information for OpenShift

URI: /api/v1/nodes

For more information, refer to OpenShift container platform API docs .

Virtual machines​

Uses the GET operation to retrieve the virtual machine list from kubevirt.io api

URI: /apis/kubevirt.io/v1/virtualmachines

For more information, refer to Kubevirt API docs .

Namespaces​

Uses the GET operation to retrieve a list of cluster namespaces for OpenShift.

URI: /api/v1/namespaces

For more information, refer to OpenShift container platform API docs .

Persistent volume​

Uses the GET operation to retrieve a list of cluster persistent volumes for OpenShift.

URI: /api/v1/persistentvolumes

For more information, refer to OpenShift container platform API docs .

Cluster​

Uses the GET operation to retrieve the detailed cluster information.

URI: /apis/config.openshift.io/v1/clusterversions/version

For more information, refer to OpenShift container platform API docs .

BareMetal installation information​

note

This endpoint is currently not in use for the feature, but is provided as additional information for testing purposes.

Uses the GET operation to retrieve IPI installation BareMetal environment information. If the client uses the cloud systems, this cannot be available for request.

URI: /apis/metal3.io/v1alpha1/baremetalhosts

For more information, refer to OpenShift container platform API docs .

Subscription based API calls​

note

To access the subscription API endpoints listed below, you must log in to your Red Hat account .

Token​

Uses the GET operation to retrieve the token with client credentials.

URI: https://sso.redhat.com/auth/realms/redhat-external/protocol/openid-connect/token

For more information, refer to Red Hat Management API documentation .

Subscription list​

Uses the GET operation to retrieve the client's Red Hat subscription list.

URI: https://api.access.redhat.com/management/v1/subscriptions

For more information, refer to Red Hat Management API documentation .