Help Center/ EventGrid/ API Reference/ APIs/ API Version Management/ Obtaining the API Version List
Updated on 2023-05-24 GMT+08:00
View PDF

Obtaining the API Version List

Function

This API is used to obtain the list of API versions supported by the service.

URI

GET /

Request Parameters

None

Response Parameters

Status code: 200

Table 1 Response body parameters

Parameter

Type

Description

versions

Array of versions objects

Versions.
Table 2 versions

Parameter

Type

Description

id

String

Version number, for example, v1

links

Array of links objects

URL.

version

String

If the APIs of the given version support micro-versions, set this parameter to the supported maximum micro-version. If not, leave this parameter blank.

min_version

String

If the APIs of the given version support micro-versions, set this parameter to the supported minimum micro-version. If not, leave this parameter blank.

status

String

Version status, which can be CURRENT (recommended), SUPPORTED (earlier version that is still supported), or DEPRECATED (deprecated version, which may be deleted later).

Enumeration values:

  • CURRENT

  • SUPPORTED

  • DEPRECATED

updated

String

UTC time when the version is released.
Table 3 links

Parameter

Type

Description

href

String

href property.

rel

String

rel property.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Operation successful.

Error Codes

See Error Codes.

Parent topic: API Version Management