Send Requests

Use the following guidelines when sending requests using the REST API for the Management Service in Oracle API Platform Cloud Service.

URL Structure

Access the Management Service REST resources using the following URL structure:
https://<subdomain>.<domain>.com:<port>/apiplatform/management/v1/<resource-path>
Where:
  • <subdomain.domain>.com:<port> is the host and port where the Oracle API Platform Cloud Service Management Service is running.

  • <resource-path> is the relative path that defines the resource.

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 Management Service in Oracle API Platform Cloud Service:

  • application/json

Supported Headers

The REST API for the Management Service in Oracle API Platform Cloud Service 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