Use cURL

cURL is an open source, command-line tool for transferring data with URL syntax, supporting various protocols including HTTP and HTTPs. The examples within this document use cURL to demonstrate how to access the Oracle SOA Cloud Service REST API.

For information about downloading and installing cURL, see Install cURL. For more information about authentication requirements, see Authentication.

Invoke cURL and specify one or more of the command-line options defined in the following table, as required, to direct its execution.

This table summarizes the cURL options used in the command examples.
cURL Option Description

-d, --data @file.json

Specifies the request body, or data, either directly or by referring to a JSON file on the local machine.

-F, --form @file.json

Specifies form data, either directly or by referring to a JSON file on the local machine.

-H

Defines a request header.

-i

Displays response header information.

-u, --user

Specifies the user name and password for the Oracle SOA Cloud Service account.

-X

Indicates the type of request (for example, GET, POST, and so on).

The following cURL command examples retrieve the details of the ExampleService service instance:

curl -i -X GET -u username:userPassword1! -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/api/v1.1/instancemgmt/domainName/services/soa/instances/ExampleService

Note:

The command in the example uses the URL structure https://rest_server_url/resource-path, where rest_server_url is the REST server to contact for your identity domain or Cloud Account. See Send Requests.