Discovering Management Resources

The Oracle ILOM REST API tree is a dynamic data structure of resources. Starting at the root resource (/rest/v1) the entire REST API is discoverable through uniform resource identifier (URI) links leading to other resources. As you can see in the following GET request example, the root resource does not represent a specific management resource. It does, however, represents a collection of URI links to the top-level management resources in Oracle ILOM.

GET /rest/v1
{
      "Target": "/rest/v1",
      "Targets": [
        {"name": "about", "uri": "/rest/v1/about"},
        {"name": "faults", "uri": "/rest/v1/faults"},
        {"name": "SYS", "uri": "/rest/v1/SYS"},
        {"name": "HOST", "uri": "/rest/v1/HOST"},
        {"name": "System", "uri": "/rest/v1/System"},
        {"name": "SP", "uri": "/rest/v1/SP"}
      ]
}

A machine-readable description of all the Oracle ILOM REST API resources, in a Swagger data model 2.0 format, is downloadable from the Oracle ILOM SP using the URL: https://<ILOM SP IP address>:443/swagger.json.

Note:

The Swagger model describes every available resource in the Oracle ILOM REST API, including the applicable HTTP methods, the media type, the request and response body formats, as well as the response status values. While this document (Oracle ILOM Web Service REST API User's Guide) provides some examples of requests and responses, the Swagger model is the definitive resource to obtain all details of requests and responses for all Oracle ILOM REST API resources. Tools such as the Swagger UI, provide a user-friendly browser-based presentation of the swagger.json file (also known as swagger model), which enables developers to execute and monitor API requests sent, as well as the results received. For more details about using the Swagger UI tool, see Appendix: Using Swagger UI to Access Oracle ILOM Web Service REST API.