Help Center/ Database and Application Migration UGO/ API Reference/ API/ API Version Management/ Querying API Versions
Updated on 2023-02-13 GMT+08:00
View PDF
Share

Querying API Versions

Function

This API is used to query API versions.

URI

GET /

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token obtained from IAM.

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

versions

Array of Table 3 objects

List of detailed API version information.
Table 3 VersionDetails

Parameter

Type

Description

id

String

Version ID.

links

String

URL for displaying version information.

version

String

API microversion information.

status

String

Version status.

Default value: CURRENT

Value:

  • CURRENT
  • SUPPORTED
  • DEPRECATED

updated

String

Version update time.

Example Request

GET https://{endpoint}/

Example Response

Status code: 200

Request succeeded.

{ 
  "versions" : [ { 
    "id" : "v1", 
    "links" : "", 
    "version" : "", 
    "status" : "CURRENT", 
    "updated" : "2021-05-24T05:44:04Z" 
  } ] 
}

Status Codes

Status code

Description

200

Request succeeded.

Error Codes

For details, see Error Codes.

Parent topic: API Version Management