Using the Red Hat Insights API

Procedure

1. From the Red Hat Hybrid Cloud Console, Click the Settings icon and select Service Accounts.
2. Click Create service account to set up the account.
3. Enter a Service account name and a Short description, and click Create. The Red Hat Hybrid Cloud Console creates the service account and displays the unique Client ID and Client secret for the account.

4. Copy the generated Client ID and Client secret values to a secure location. You need to specify these credentials when configuring a connection to a service.

   Important

   The Client secret displays only once, so ensure that you have successfully and securely saved the copied credentials before closing the credentials window.

5. After you save the Client ID and secret to a secure location, select the confirmation check box in the credentials window and close the window. The service account and its Client ID appear on the Service Accounts page.

6. Add the service account to the applicable User Access Groups.

   Note

   Service accounts do not inherit permissions from Default access groups, so you must place them in a User Group to grant them access permissions.

7. At the command line, use a curl command with Red Hat single sign-on (SSO) to generate an access token. Use the service account credentials that you generated in place of <client_id> and <client_secret>.

   curl https://sso.redhat.com/auth/realms/redhat-external/protocol/openidconnect/token -d "grant_type=client_credentials" -d "scope=api.console" -d client_id=<client_id> -d client_secret=<client_secret>

   Copy to Clipboard Toggle word wrap
   Note

   For more information about Red Hat SSO and generating access tokens, see Transition of Red Hat Hybrid Cloud Console APIs from basic authentication to token-based authentication via service accounts.

8. Red Hat Single Sign-On (SSO) responds with a JSON object containing an access token. You can use this access token to make authenticated requests to APIs. To make a request, include the access token generated in the previous step in an Authorization: Bearer HTTP header in your request. Substitute the access token for <access_token>.

   Authorization: Bearer <access_token>

   Copy to Clipboard Toggle word wrap

Procedure

1. Log in to the Red Hat Customer Portal with your username and password.

   Note

   You can no longer log in to your Red Hat account with your email unless your email is your Red Hat login. For more information, see Finding your Red Hat login.

2. Navigate to the Red Hat API Tokens page.
3. Click Generate Token to generate an offline token.

4. At the command line, use a curl command to generate an access token. Use the offline token that you generated in place of <offline_token>.

   curl https://sso.redhat.com/auth/realms/redhat-external/protocol/openidconnect/token -d grant_type=refresh_token -d client_id=rhsm-api -d refresh_token=<offline_token>

   Copy to Clipboard Toggle word wrap
5. Copy the generated access token and save it in a secure location. You can use this access token to make authenticated requests to APIs.

6. To make a request, include the access token in an Authorization: Bearer HTTP header in your API call. Substitute the access token for <access_token>.

   Authorization: Bearer <access_token>

   Copy to Clipboard Toggle word wrap

Procedure

1. Open the API catalog in a web browser. The API catalog lists available APIs for Insights and other services.
2. Select Advisor from the catalog. The Insights Advisor API page opens. The page lists the base URL of the Advisor API and any requirements for authentication.

3. Under the Operations list, click the drop-down arrow next to GET /api/insights/v1/account.

   The description for the operation includes parameters you can use to refine your API call, and also expected responses from the server. In addition, the panel on the right side of the page has sample code to perform the API call in many languages.

4. In the panel, click the drop-down and select CURL from the list of options. The panel displays sample code for the GET operation, formatted as a curl command.

5. Copy the sample code and paste it into your command line or into an existing code file where you want to invoke the GET command.

   # curl --request GET \
   --url https://console.redhat.com/api/insights/v1/account/ \
   --header 'Authorization: Bearer <token>' \
   --header 'Content-Type: application/json'

   Copy to Clipboard Toggle word wrap
6. Paste your access token in place of <token>.
7. Press Enter to invoke the command.

Procedure

1. Open the API catalog in a web browser. The API catalog lists available APIs for Insights and other services.
2. Select Advisor from the catalog. The Insights Advisor API page opens. The page lists the base URL of the Advisor API and any requirements for authentication.
3. Under the Operations list, click the drop-down arrow next to GET /api/insights/v1/account. The description for the operation includes parameters you can use to refine your API call, as well as expected responses from the server. In addition, the panel on the right side of the page generates an example API call for the GET operation in multiple programming languages.
4. In the panel, click the drop-down and select the programming language that you prefer (for example, Python) from the list of options. The panel displays sample code for the GET operation, formatted in Python syntax.

5. Copy the sample code and paste it into a Python code file where you want to invoke the GET command. For example:

   import requests
   
   url = "https://console.redhat.com/api/insights/v1/account/"
   
   headers = {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
   }
   
   response = requests.get(url, headers=headers)
   
   print(response.json())

   Copy to Clipboard Toggle word wrap
6. Paste your authorization key for authentication in place of <token>.
7. Press Enter to run your code.

Procedure

1. Navigate to the API documentation page in the Red Hat Hybrid Cloud Console.
2. Select the application that you want to use from the list (for example, Advisor). The page for the application displays, with a list of all the operations you can request for that application.
3. Select the operation that you want to perform (for example, Advisor > account > GET /api/insights/v1/account).
4. Click the drop-down arrow for the operation. The Swagger documentation page describes the operation and lists the parameters you can use to refine your request. The page also shows the JSON format for a successful server response.
5. Click Try It Out. The page displays the format of a successful server response. If the operation you selected requires a value for a parameter (for example, org_id), enter the value in the blank.

6. Click Execute. The page displays a curl request to the server, the request URL, and the server response.

   1. To copy the curl request to the clipboard, click the clipboard icon on the right side of the curl request.
   2. To copy the server response to the clipboard, click the clipboard icon in the top right corner.
   3. To download the server response as a JSON file, click Download.
7. Optional: To clear the server response and retry the command, click Clear.