Show API version

Overview

Shows information about specified Storage API version

Classification

  • Show

API Operation Object

  • Version

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{api_endpoint}/{version_id}

HTTP Request Header

Format

X-Auth-Token: <token>

HTTP Request Body

  • none

Response

HTTP Response Header

Response Code

Response Codes
Code Description Error? Note
200 OK No Returned if there is only a version listed
400 Bad Request Yes  
401 Unauthorized Yes  
500 Internal Server Error Yes  

HTTP Response Body

Response Parameter

Response Parameters
Key Value
api_error_message Error Message
version Version object
status CURRENT or SUPPORTED
updated Timestamp of update for the API version
media-types Array of Media-type objects
id Version ID (e.g. v1.0)

Sample API Request and Response

Sample API Request

curl -s -i -X GET https://storage-jp1.ecl.api.ntt.com/v1.0 -H 'Content-type: application/json' -H 'Accept: application/json' -H 'X-Auth-Token: bd0343af86a74e5cb9867a69729675ba'

Sample API Response

HTTP/1.1 200 OK
Date: Thu, 21 Apr 2016 05:17:44 GMT
Content-Type: application/json
Content-Length: 229
Connection: keep-alive
Set-Cookie: TS0183560f=01cce65ce14513a630a7ec0f47d29ce2ec6db92e77a959f0185f874d0d9c082973752cc483; Path=/

{
 "api_error_message": "",
 "version" :
{
  "status": "CURRENT",
  "updated": "2016-01-16T10:42:23+0000",
  "media_types": [
    {
      "base": "application/json",
      "type": "application/vnd.ecl2.volume+json;version=1"
    }
  ],
  "id": "v1.0"
}

}