Querying All API Versions

Function

This API is used to query all API versions supported by CTS.

URI

GET /

Request Parameters

None

Response Parameters

Status code: 200

Table 1 Response body parameters

Parameter

Type

Description

versions

Array of Versions objects

List of all versions.
Table 2 Versions

Parameter

Type

Description

id

String

Specifies the version ID, for example, v1.

links

Array of LinksBody objects

Specifies the API URL.

version

String

If microversions are supported, set this parameter to the maximum microversion supported. Otherwise, leave this parameter empty.

status

String

Specifies the version status. CURRENT: widely used version. SUPPORTED: earlier version that is still supported. DEPRECATED: deprecated version which may be deleted later.

Value:

  • CURRENT
  • SUPPORTED
  • DEPRECATED

updated

String

The version release time in UTC. For example, the release time of v1 is 2014-06-28T12:20:21Z.

min_version

String

If microversions are supported, set this parameter to the minimum microversion supported. Otherwise, leave this parameter empty.
Table 3 LinksBody

Parameter

Type

Description

href

String

Specifies the reference address of the current API version.

rel

String

Specifies the relationship between the current API version and the referenced address.

Example Request

None

Example Response

Status code: 200

The request is successful.

{
  "versions" : [ {
    "id" : "v1.0",
    "links" : {
      "href" : "https://x.x.x.x/v1.0/",
      "rel" : "self"
    },
    "min_version" : "",
    "status" : "CURRENT",
    "updated" : "2018-09-30T00:00:00Z",
    "version" : ""
  }, {
    "id" : "v2.0",
    "links" : {
      "href" : "https://x.x.x.x/v2.0/",
      "rel" : "self"
    },
    "min_version" : "",
    "status" : "SUPPORTED",
    "updated" : "2018-09-30T00:00:00Z",
    "version" : ""
  } ]
}

Status Codes

Status Code

Description

200

The request is successful.

404

The server failed to find the requested resource.

500

The server encountered an unexpected condition which prevented it from fulfilling the request.

Error Codes

For details, see Error Codes.

Parent topic: API Version Management