Este conteúdo não está disponível no idioma selecionado.

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"
Copy to Clipboard Toggle word wrap
The following examples show the response for this command in both XML and JSON syntax.
XML Response

<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>
Copy to Clipboard Toggle word wrap

JSON Response

{
   "supported_api_versions": [
        1.0,
        1.1,
        1.2,
        1.3,
        1.4
        1.5
        1.6
    ],
    "version": "1.6"
}
Copy to Clipboard Toggle word wrap

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.
XML Clients

Accept: application/xml; version=1.5
Copy to Clipboard Toggle word wrap

JSON Clients

Accept: application/json; version=1.5
Copy to Clipboard Toggle word wrap

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.
XML Response for Unsupported Version

<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>
Copy to Clipboard Toggle word wrap

JSON Response for Unsupported Version

{
    "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"
}
Copy to Clipboard Toggle word wrap

Voltar ao topo
Red Hat logoGithubredditYoutubeTwitter

Aprender

Experimente, compre e venda

Comunidades

Sobre a documentação da Red Hat

Ajudamos os usuários da Red Hat a inovar e atingir seus objetivos com nossos produtos e serviços com conteúdo em que podem confiar. Explore nossas atualizações recentes.

Tornando o open source mais inclusivo

A Red Hat está comprometida em substituir a linguagem problemática em nosso código, documentação e propriedades da web. Para mais detalhes veja o Blog da Red Hat.

Sobre a Red Hat

Fornecemos soluções robustas que facilitam o trabalho das empresas em plataformas e ambientes, desde o data center principal até a borda da rede.

Theme

© 2025 Red Hat