Send Requests

Use the following guidelines when sending requests using the REST API for the Gateway Controller in Oracle API Platform Cloud Service - Classic.

URL Structure

Access the Gateway Controller REST resources using the following URL structure:
https://<subdomain>.<domain>.com:<port>/apiplatform/gatewaynode/v1/<resource-path>
Where:
  • <subdomain.domain>.com:<port> : Host and port where the gateway node is running.

  • <resource-path> : Relative path that defines the resource.

Note:

Gateway Controller endpoints are available for each node that you install. Requests sent to any of these endpoints for a node apply to that node only.

Supported Methods

You can perform basic CRUD operations (create, read, update, and delete) using standard HTTP method requests, as summarized in the following table.

HTTP Method Description
GET Retrieve information about a resource.
POST Add information for a resource.
PUT Update a resource.
DELETE Delete information associated with a resource.

Media Types

The following media types are supported by the REST API for the Gateway Controller in Oracle API Platform Cloud Service - Classic:

  • application/json

Supported Headers

The REST API for the Gateway Controller in Oracle API Platform Cloud Service - Classic supports the following headers that may be passed in the header section of the HTTP request or response.

Header Description Example
Content-Type Media type of the body of the request. Required for POST and PUT requests. Content-Type: application/json