Send Requests

Use the following guidelines when sending requests using the Oracle Application Container Cloud REST API for Managing Application Caches.

URL Structure

Access the Oracle Application Container Cloud REST resources using the following URL structure:
https://apaas.{region}.oraclecloud.com/paas/api/v1.1/instancemgmt/{identityDomainId}/services/caching/instances/
where:
  • apaas.{region}.oraclecloud.com is the host where Oracle Application Container Cloud is running. The region is us for subscribers in the United States. If you are unsure of your host name, locate Oracle Application Container Cloud in the My Services console, click Details, and look at the REST Endpoint value.

    The Service URL listed in the welcome email you receive with your trial or purchased subscription also contains this host. Here is an example Service URL:

    https://apaas.us.oraclecloud.com/paas

    All the examples in this document use apaas.us.oraclecloud.com for the Oracle Application Container Cloud host system.

  • paas/api/v1.1/instancemgmt/{identityDomainId}/services/caching/instances/ is the fixed prefix for Oracle Application Container Cloud REST resources. For a complete list of resources, see REST Endpoints.

Supported Methods

You can perform operations on Oracle Application Container Cloud using standard HTTP method requests, as summarized in the following table.

HTTP Method Description
GET Retrieve configuration and status information about a cache or job.
POST Create, scale, start, restart, or stop a cache.
PUT Delete a cache.

Media Types

The following media types are supported by the REST API:

  • application/vnd.com.oracle.oracloud.provisioning.Service+json (for requests)

  • application/json (for responses)

Supported Headers

The REST API 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/vnd.com.oracle.oracloud.provisioning.Service+json
X-ID-TENANT-NAME Name of the identity domain for your subscription to Oracle Application Container Cloud. X-ID-TENANT-NAME:ExampleIdentityDomain