REST API for Oracle Blockchain Platform on Oracle Cloud Infrastructure (Hyperledger Fabric v2.5)

Get Version of REST Proxy API

get

/restproxy/api/version

Get the version of the REST proxy API.

Request

There are no request parameters for this operation.

Response

Supported Media Types

application/json

200 Response

successful operation

Root Schema : schema

Type: object

Show Source

error: string
result(required): string
returnCode(required): string

Allowed Values: [ "Success", "Failure" ]

{
    "type":"object",
    "required":[
        "returnCode",
        "result"
    ],
    "properties":{
        "returnCode":{
            "$ref":"#/definitions/returnCode"
        },
        "error":{
            "type":"string"
        },
        "result":{
            "type":"string"
        }
    }
}

Examples

This endpoint is used to get the version of the REST proxy API.

The following example shows how to get the version of your REST proxy API by submitting a GET request on the REST resource using cURL.

curl -v -X GET \
  https://<rest proxy of your blockchain instance>/api/version \
  -H "Authorization: Bearer <OAuth_access_ token>"

For example,

curl -v -X GET \
  https://myvm.oracle.com:10001/restproxy/api/version \
  -H "Authorization: Bearer mF_9.B5f-4.1JqM"

Note:

You can find the REST proxy value of your blockchain instance from the Nodes tab of your instance console.

Example of the Response Body

The following example shows the contents of the response body in JSON format:

{
    "returnCode": "Success",
    "error": "",
    "result": "v2.0.0"
}