Client Access to REST API Management Resources
Client access to management REST API resources are made through an HTTP request. Each client request sent to the server must include the following: HTTP verb, resource path, HTTP 1.1 version, and all required headers including the Host header. For example:
<HTTP verb> <resource_path> HTTP/1.1 <Header Name>: <Header Value>
Where:
-
The HTTP verb indicates the type of operation to perform, for instance,
GET
,POST
,PATCH
, andDELETE
. -
The resource_path portion of the URL always begins with /rest/v<version> followed by the target resource to be acted upon. For example:
/rest/v1/System
When constructing the resource path portion of the URL, follow these guidelines:
-
All resource path names are case-insensitive, with the exception of the entities under the /SYS resource. In this case, the /SYS resource and all its entities are case-sensitive.
Note:
For a descriptive list of /SYS NAC names, refer to the Oracle Service Manual provided for your server. -
Forward slash (/) characters can be included in the resource path portion of the URL to indicate a hierarchical relationship between resources (for example: /top-level_resource_name/sub-level_resource_name/property_name).
-
Resource paths are not considered valid if they end with a trailing forward slash '/' character. For instance, the following resource path would be considered invalid: /rest/v1/System/
-
-
The Header Name and Header Value passes additional information about the request to the server. For further details, see Common Request Header Fields.