Send Requests
Use these guidelines when sending requests using the Oracle Java Cloud Service REST API.
URL Structure
Use the following URL structure to access the Oracle Java Cloud Service REST endpoints:
https://rest_server/endpoint-path
-
endpoint-path
is the relative path that defines the REST resource. For a complete list of REST endpoints, see All REST Endpoints. -
rest_server
is the REST server to contact for your cloud account. The value depends on the default data region of your cloud account, as shown in the following table. If necessary, get the REST server URL from your Oracle Cloud Account administrator.REST Server Data Region psm.us.oraclecloud.com
- US East (Ashburn)
- US West (Phoenix)
- Canada Southeast (Montreal)
- Canada Southeast (Toronto)
psm.europe.oraclecloud.com
- Germany Central (Frankfurt)
- Netherlands Northwest (Amsterdam)
- Saudi Arabia West (Jeddah)
- Switzerland North (Zurich)
- UK South (London)
psm.aucom.oraclecloud.com
- Australia East (Sydney)
- Australia West (Melbourne)
- India West (Mumbai)
- India South (Hyderabad)
- Japan Central (Osaka)
- Japan East (Tokyo)
- South Korea Central (Seoul)
- South Korea North (Chuncheon)
psm.brcom-central-1.oraclecloud.com
- Brazil East (Sao Paulo)
psm-cloudaccountname.console.oraclecloud.com
All regions
cloudaccountname
is your tenant name or cloud account name.psm-cacct-accountid.console.oraclecloud.com
All regions
accountid
is the alphanumeric ID of your tenant name or cloud account.Note:
You can findcloudaccountname
oraccountid
in the Welcome email sent to your cloud account administrator, and also in the browser URL address bar when you access the Java Cloud Service console.
Request Methods
You can perform basic CRUD operations (create, read, update, and delete) on a resource by using standard HTTP methods, as summarized in the following table.
HTTP Method | Description |
---|---|
POST |
Create, stop, start, scale out, backup, or restore an Oracle Java Cloud Service instance. |
GET |
Retrieve information about an Oracle Java Cloud Service instance or a service instance component. |
PUT |
Delete an Oracle Java Cloud Service instance or update a service instance, for example, scale in or apply a patch. |
DELETE |
Delete an Oracle Java Cloud Service instance component, for example, delete a backup. |
Request Media Types
Unless specified otherwise, the Oracle Java Cloud Service REST API supports application/json
.
Headers
The Oracle Java Cloud Service REST API supports headers that may be passed in the header section of an HTTP request or response.
Header | Description and Example |
---|---|
|
Media type for the response body. Note that unless an operation specifies otherwise, the type is Example:
|
|
Media type of the request body. Required for POST and PUT requests. Examples:
|
|
Identity domain ID of the Oracle Java Cloud Service instance. Must be supplied for authentication. Example:
|
|
How to validate the Oracle Cloud account user, using HTTP Basic or OAuth 2.0 authentication.
|