Send Requests
Use the following guidelines when sending requests using the Oracle Blockchain Platform REST API.
URL Structure
https://<rest_server_url:port/<resource-path>
-
<rest_server_url:port>
is the URL for the REST proxy which is listed in the Oracle Blockchain Platform console.In the console, open the Nodes page and look for the REST proxy node. In the Route column, a URL including port and a REST proxy number will be listed.
-
<resource-path>
: Relative path that defines the REST endpoint. For example:/bcsgw/rest/v1/transaction/query
For a complete list of REST endpoints, see All REST Endpoints.
Supported Methods
You can perform basic transaction-related operations on Oracle Blockchain Platform using standard HTTP method requests, as summarized in the following table.
HTTP Method | Description |
GET |
Retrieve information about the blockchain. |
POST |
Invoke a transaction on the blockchain, or create a new blockchain node object. |
PATCH |
Update the blockchain node. |
DELETE |
Delete a blockchain node. |
Media Types
The following media types are supported by the Oracle Blockchain Platform REST API:
-
application/json
Supported Headers
The Oracle Blockchain Platform 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/json |