2.2. Version

Every OpenShift REST API call returns the current API version, and other versions that are supported. The following example shows how to use the cURL command to return the API version.

$ curl "https://openshift.redhat.com/broker/rest/api"

The following examples show the response for this command in both XML and JSON syntax.

<response>
  <status>ok</status>
  <version>1.6</version>
  <supported-api-versions>
    <supported-api-version>1.0</supported-api-version>
    <supported-api-version>1.1</supported-api-version>
    <supported-api-version>1.2</supported-api-version>
    <supported-api-version>1.3</supported-api-version>
    <supported-api-version>1.4</supported-api-version>
    <supported-api-version>1.5</supported-api-version>
    <supported-api-version>1.6</supported-api-version>
  </supported-api-versions>
</response>

{
   "supported_api_versions": [
        1.0,
        1.1,
        1.2,
        1.3,
        1.4
        1.5
        1.6
    ],
    "version": "1.6"
}

If a specific API version is required, the client must include the HTTP header with the response request. The following examples show response requests in both XML and JSON syntax.

Accept: application/xml; version=1.5

Accept: application/json; version=1.5

If the version requested by the client is not supported, the server responds with the HTTP status code 406, as shown in the following examples in XML and JSON syntax.

<response>
  <messages>
    <message>
      <text>Requested API version 2.0 is not supported.  Supported versions are 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6</text>
      <severity>error</severity>
    </message>
  </messages>
  <version>1.6</version>
  <supported-api-versions>
    <supported-api-version>1.0</supported-api-version>
    <supported-api-version>1.1</supported-api-version>
    <supported-api-version>1.2</supported-api-version>
    <supported-api-version>1.3</supported-api-version>
    <supported-api-version>1.4</supported-api-version>
    <supported-api-version>1.5</supported-api-version>
    <supported-api-version>1.6</supported-api-version>
  </supported-api-versions>
  <status>not_acceptable</status>
</response>

{
    "data": null,
    "messages": [
        {
            "exit_code": null,
            "field": null,
            "severity": "error",
            "text": "Requested API version 2.0 is not supported. Supported versions are 1.0, 1.1, 1.2, 1.3, 1.4, 1.5, 1.6"
        }
    ],
    "status": "not_acceptable",
    "supported_api_versions": [
        1.0,
        1.1,
        1.2,
        1.3,
        1.4,
        1.5,
        1.6
    ],
    "type": null,
    "version": "1.6"
}