Jump to

• Request
• Response
• Examples

Get version information for the node

get

/apiplatform/gatewaynode/v1/version

Returns the version information of the gateway node.

Any user can request this resource.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json
• text/plain

200 Response

The node's version.

Body ()

Returns Version information in a JSON.

Root Schema : VersionDetails

Type: string

Returns Version information in a JSON.

500 Response

Unexpected error.

Body ()

Error Definition.

Root Schema : Error

Type: object

Error Definition.

Show Source

• detail(optional): string
  Detailed error message.
• errorCode(optional): string
  Application-specific error code.
• errorDetails(optional): array errorDetails
  Additional errors.
• errorPath(optional): string
• instance(optional): string
  URI to the link that provides more detail about the error.
• status(optional): string
  HTTP status code.
• title: string
  Summary error message.
• type: string
  Error type.

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type."
        },
        "title":{
            "type":"string",
            "description":"Summary error message."
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message."
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error."
        },
        "errorCode":{
            "type":"string",
            "description":"Application-specific error code."
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code."
        },
        "errorDetails":{
            "type":"array",
            "description":"Additional errors.",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    },
    "description":"Error Definition."
}

Nested Schema : errorDetails

Type: array

Additional errors.

Show Source

• Array of: object Error
  Error Definition.

{
    "type":"array",
    "description":"Additional errors.",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

Back to Top

Examples

The following example shows how to retrieve version information for a gateway node by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL

curl -i -X GET 
-H "Authorization: Bearer access_token
https://example.com/apiplatform/gatewaynode/v1/version

Example of Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Date: Tue, 18 Jul 2017 14:50:26 GMT
Transfer-Encoding: chunked
Content-Type: application/json

Example of Response Body

The following example shows the contents of the response body in JSON format, including the version of the gateway node.

{
    "cloudVersion": "17.3.5",
    "buildDate": "2017-07-17T07:25:07-0700",
    "version": "2.0.0",
    "branch": "develop",
    "revision": "28780f3c02594c61b8bc2baab158416190e76131"
}

Back to Top