Use API documentation to develop Red Hat services

You can use Hybrid Cloud Console API documentation to help you develop Red Hat services that are part of the Red Hat Hybrid Cloud Console. You can easily find API code for the Hybrid Cloud Console services that you use. The documentation provides examples of each API in different coding languages.

About this task

The API documentation is available from:

  • The API Catalog and Documentation page on the Red Hat Developer web site: You can access the API documentation from this page without a Red Hat account.
  • The API documentation page on the Hybrid Cloud Console: The documentation available through this page has some useful features such as versioning that are not yet available on the Red Hat Developer web site.
  • The help panel in the Hybrid Cloud Console: The help panel allows you to keep the API documentation open in the console user interface while you work.

Procedure

  1. Use one of the following methods to view the Hybrid Cloud Console API documentation:
    • View the API documentation on the Red Hat Developer web site.
    • View the API documentation on the API documentation page on the Hybrid Cloud Console.
    • Open the API documentation in the Hybrid Cloud Console help panel. In the Hybrid Cloud Console, click the Help button to open the help panel, then select the APIs tab.
  2. Perform any of the following tasks:
    • To view the API documentation for a service, click the service name link.
    • To download the API documentation for a specific service, click the Download icon on the service row (console only).
    • To download the API documentation for more than one service, select the services, then click Download selected (console only).