Chapter 5. Systems lifecycle in the inventory application

Procedure

1. Open the Red Hat Lightspeed API Catalog in a web browser.
2. Select Managed Inventory from the catalog. The Red Hat Lightspeed Host Inventory REST Interface page displays.
3. Under the Operations list, click the drop-down arrow next to GET /account/staleness/defaults. The description for the operation includes 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 languages.
4. In the panel, click the drop-down and select the language 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 call the GET command. For example:

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

6. Paste your access token for authentication in place of <token>.

7. Run your code. If the server returns a response of 200, your API call was successful. In addition to a successful response and an optional description of the operation, the server returns the data you requested. The response looks similar to the following:

   {
   "id": "system_default",
   "org_id": "7931872",
   "conventional_time_to_stale": 104400,
   "conventional_time_to_stale_warning": 604800,
   "conventional_time_to_delete": 1209600,
   "created": null,
   "updated": null
   }

   Tip

   If the code returns a response other than 200, refer to Response Codes to determine how the API call failed and how to remedy the reason for the failure.

Procedure

1. On the Hybrid Cloud Console, navigate to the API documentation page. The API Documentation page displays.
2. Select Managed Inventory from the list of services. The Detail page displays, and shows the operations you can perform using the https://console.redhat.com/api/inventory/v1 endpoint.
3. Click the drop-down arrow next to the GET /accounts/staleness/defaults operation. The GET request does not need input, so the list of parameters reads No parameters.
4. Click Try It Out. The page displays the format of a successful server response.
5. Click Execute. The page displays a curl request to the server, the request URL, and the server response.
6. To copy the curl request to the clipboard to reuse later, click the clipboard icon on the right side of the curl request. If needed, paste it into a text editor and save it.
7. To copy the server response to the clipboard, click the clipboard icon in the top right corner. If needed, paste it into a text editor and save it.

8. To download the server response as a JSON file, click Download.

   Note

   If the server returns a response of 403 or another unsuccessful response, check to make sure you have the correct RBAC permissions and try the request again.

   Optional: To clear the server response and retry the command, click Clear.

Procedure

1. Open the Red Hat Lightspeed API Catalog in a web browser.
2. Select Managed Inventory from the catalog. The Red Hat Lightspeed Host Inventory REST Interface page displays.
3. Click the drop-down arrow next to the POST /account/staleness operation. The description for the operation includes parameters you can use to refine your API call and expected responses from the server. In addition, the panel on the right side of the page generates an example API call for the POST request in multiple languages.
4. In the panel, click the drop-down and select the language you prefer (for example, python) from the list of options. The panel displays sample code for the POST request, formatted in python syntax.

5. Copy the sample code and paste it into a python code file where you want to call the POST request. For example:

   import requests
   
   url = "https://console.redhat.com/account/staleness"
   
   payload = {
         "conventional_time_to_delete": 1,
      "conventional_time_to_stale": 1,
      "conventional_time_to_stale_warning": 1,
   }
   headers = {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
   }
   
   response = requests.post(url, json=payload, headers=headers)
   
   print(response.json())

6. Add the custom staleness times you want to use in seconds in place of the values of 1 shown in the sample. Remember that a value of 1 in the API equals one second, not one day.
7. Paste your access token for authentication in place of <token>.
8. Run your code.

Procedure

1. On the Hybrid Cloud Console, navigate to the API documentation page. The API Documentation page displays.
2. Select Managed Inventory from the list of services. The Detail page displays, and shows the operations you can perform using the link:https://console.redhat.com/api/inventory/v1 endpoint.
3. Click the drop-down arrow next to the POST /accounts/staleness operation.
4. Click Try It Out. The page displays the format of a successful server response.
5. Add custom staleness values in place of the number 1 for each parameter in the request body. Remember that the value of 1 in the API equals 1 second, not 1 day.
6. Click Execute. The page displays a curl request to the server, the request URL, and the server response.
7. To copy the curl request to the clipboard, click the clipboard icon on the right side of the curl request.
8. To copy the server response to the clipboard, click the clipboard icon in the top right corner.

9. To download the server response as a JSON file, click Download.

   Note

   If the server returns a response of 403 or another unsuccessful response, check to make sure you have the correct RBAC permissions and try the request again.

   Optional: To clear the server response and retry the command, click Clear.