Jump to

• Request
• Response
• Examples

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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Operation successful

Body ()

Root Schema : schema

Type: object

Show Source

• error(optional): string
• result: string
• returnCode: string
  Allowed Values: [ "Success", "Failure" ]

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

Back to Top

Examples

This endpoint is used to get the version of the restproxy API.

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

curl -v -u <username>:<password> -X GET \
  https://<rest proxy of your blockchain instance>/api/version

For example,

curl -v -u obpuser:<password> -X GET \
  https://myvm.oracle.com:10001/restproxy/api/version

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"
}

Back to Top