doc-exports/docs/eip/api-ref/eip_openstackapi_0002.html

Querying API Versions

Function

This API is used to query all available versions of a native OpenStack API.

URI

GET /

Request Parameters

None

Example Request

GET https://{Endpoint}/

Response Parameters

Table 1 Response parameter

Parameter	Type	Description
versions	Array of version objects	Specifies the API version list. For details, see Table 2.

Table 2 version objects

Parameter	Type	Description
status	String	Specifies the API version status. Possible values are as follows: CURRENT STABLE DEPRECATED
id	String	Specifies the API version.
links	Array of link objects	Specifies the link list. For details, see Table 3.

Table 3 link objects

Parameter	Type	Description
href	String	Specifies the API link.
rel	String	Specifies the relationship between the API link and the API version.

Example Response

{
    "versions": [
        {
            "status": "CURRENT", 
            "id": "v2.0", 
            "links": [
                {
                    "href": "https://{Endpoint}/v2.0", 
                    "rel": "self"
                }
            ]
        }
    ]
}

Status Code

See Status Codes.

Error Code

See Error Codes.

Parent topic: API Version Information