List Versions information

Overview

List VPN versions. Now, supported version is only 2.

Classification

  • Get

API Operation Object

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{api_endpoint}

HTTP Request Header

Accept: application/json
Content-Type: application/json
X-Auth-Token: <token>

HTTP Request Body

Format

  • None

Request Parameter

Input Parameters
name style format description required/optional default value response code for invalid parameter
token Header Authentication token string Keystone authentication token. required - 401

Response

HTTP Response Header

Format

HTTP/1.1 200 OK
  • <response_code>: see “HTTP Responses” section
  • <message>: message based on the response code

Response Code

Response Codes
response code condition
200 Normal end. Request is completed.
401 Unauthorized. Token is invalid.
405 Request URL or method is invalid.
415 Bad media type. It is allowed ‘application/json’ only as media type.
503 Service is unavailable.

HTTP Response Body

Format

{
  "versions": [
    {
      "status": "CURRENT",
      "id": "v2",
      "links": [
        {
          "href": "<href>",
          "rel": "<rel>"
        }
      ]
    }
  ]
}

Response Parameter

Response Parameters
item format description
versions Version Array Baremetal Server API versions information list. Now, supported version is only 2.

Sample Request and Response

Sample API Request

Request URI

https://baremetal-server-jp1-ecl.api.ntt.com

Request Header

GET / HTTP/1.1
User-Agent: curl/7.35.0
Host: 192.168.150.51:8774
Accept: application/json
Content-Type: application/json
X-Auth-Token: 62d528dc0cca4827b0ed465efe1c2588

Request Body

  • None

Sample API Response

Response Header

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: <content-length>
Date: Thu, 17 Jul 2014 04:21:06 GMT

Response Body

{
  "versions": [
    {
      "status": "CURRENT",
      "id": "v2",
      "links": [
        {
          "href": "https://baremetal-server-jp1-ecl.api.ntt.com/v2",
          "rel": "self"
        }
      ]
    }
  ]
}