Intelligent Advisor Hub REST API
The Intelligent Advisor Hub REST API can be used to perform various administrative tasks, such as managing users, deployments, versions and connections. The Hub REST API is fully self-describing and versioned, and is available in the REST API for Intelligent Advisor in the Oracle Help Center. A summary is provided here.
Accessing the Intelligent Advisor Hub REST API
To access the Intelligent Advisor Hub REST API, you use standard HTTP operations on uniform resource identifiers (URIs). The launch URI is https://{your_site_interface}/opa-hub/api.
The Intelligent Advisor Hub REST API is versioned, starting from 12.2.6. You can use the URI above to see all of the versions available.
For information on the URI syntax for requests, see Accessing the Intelligent Advisor REST API.
API clients must access the REST API using OAuth2 tokens. For more information, see Authentication and Authorization and Refresh an API Access Token.
Resource methods
You can discover supported methods with OPTIONS. For example, OPTIONS https://{your_site_interface}/opa-hub/api/{version}/users/admin will return GET, PUT, PATCH, DELETE.
For more information, see Resource Methods.
Metadata catalog
An Oracle standard metadata-catalog schema is provided with structured URIs describing all REST API resources. The URI is https://{your_site_interface}/opa-hub/api/{version}/metadata-catalog. To get started, use GET https://{your_site_interface}/opa-hub/api/{version}/metadata-catalog and follow the hyperlinks for more details.
For more information, see Using the metadata catalog.
OpenAPI 2.0 description
An OpenAPI 2.0 description is available using the GET operation. This returns the resources and methods provided by the REST API in a single JSON payload.
For more information, see Accessing the Intelligent Advisor REST API.
To access information about a Hub, use GET https://{your_site_interface}>/opa-hub/api/{version}/about. This can be used to validate if a Hub URL is valid and to get some minimal information about it.