Help Center/ ROMA Connect/ API Reference/ Public Resource APIs/ Public Management/ Obtaining Service API Versions
Updated on 2025-07-18 GMT+08:00
View PDF

Obtaining Service API Versions

Function

This API is used to obtain service API versions. No authentication is required.

URI

GET /

Request Parameters

None

Response Parameters

Status code: 200

Table 1 Response body parameters

Parameter

Type

Description

versions

Array of Version objects

API versions of the service.

scene

String

Scene information.
Table 2 Version

Parameter

Type

Description

id

String

API version ID, for example, v1.

version

String

Maximum microversion of the API. This parameter is left blank if the microversion is not supported.

min_version

String

Minimum microversion of the API. This parameter is left blank if the microversion is not supported.

status

String

API version status. The options are as follows:

  • CURRENT: recommended version.

  • SUPPORTED: an old version that is still supported.

  • DEPRECATED: deprecated version, which may be deleted later.

updated

Number

UTC time when the API version was released.

links

links object

URL of the API version.
Table 3 links

Parameter

Type

Description

rel

String

Usage.

href

String

URL for this usage.

Example Requests

None

Example Responses

Status code: 200

OK

{
  "versions" : [ {
    "min_version" : "",
    "links" : {
      "rel" : "self",
      "href" : "https://roma.example.com/v1"
    },
    "id" : "v1",
    "updated" : "2018-06-28T12:20:21Z",
    "version" : "",
    "status" : "SUPPORTED"
  }, {
    "min_version" : "",
    "links" : {
      "rel" : "self",
      "href" : "https://roma.example.com/v2"
    },
    "id" : "v2",
    "updated" : "2020-06-28T12:20:21Z",
    "version" : "",
    "status" : "CURRENT"
  } ],
  "scene" : null
}

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.

Parent topic: Public Management