Send Requests
Use the following guidelines when sending requests using the Oracle SOA Cloud Service REST API.
URL Structure
https://rest_server/resource-path
-
rest_server
is the REST server to contact for your identity domain or Cloud Account.To find the
rest_server
value for your region, see "REST API Endpoints for Platform Services" in Getting Started with Oracle Platform Services in the Oracle Cloud Infrastructure documentation. For example, if your region is Ashburn, the URL ishttps://psm.us.oraclecloud.com:443
. -
resource-path
is the relative path that defines the REST endpoint. For a complete list of REST endpoints, see All REST Endpoints.
The following example cURL command lists the instances in your identity domain:
curl -i -X GET -u joe@example.com:Mypassword1! -H "X-ID-TENANT-NAME:{identityDomainId}" https://psm.us.oraclecloud.com/paas/api/v1.1/instancemgmt/{identityDomainId}/services/SOA/instances
Supported Methods
You can perform basic CRUD operations (create, read, update, and delete) on your Oracle SOA Cloud Service instances using standard HTTP method requests, as summarized in the following table.
HTTP Method | Description |
---|---|
GET |
Retrieve information about the Oracle SOA Cloud Service instance or a service instance component, for example, a Managed Server. |
POST |
Create, stop, start, scale, backup, restore, or patch an Oracle SOA Cloud Service instance. |
PUT |
Update or delete an Oracle SOA Cloud Service instance, for example, scale up a node or apply a patch. |
DELETE |
Delete an Oracle SOA Cloud Service instance component, for example, delete a backup or Managed Server node. |
Supported Headers
The Oracle SOA Cloud Service 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 request body. Required for POST and PUT requests. |
or
|
X-ID-TENANT-NAME |
Identity domain name of the Oracle SOA Cloud Service instance, used for authentication. | X-ID-TENANT-NAME:ExampleIdentityDomain |