OpenStack API Documentation

Image Service Versions

API versions

GET
/versions

List API versions

Lists information about all Image service API versions supported by this deployment, including the URIs.

Normal response codes: 200

Request

There are no request parameters.

Response Example

{
    "versions": [
        {
            "id": "v2.6",
            "links": [
                {
                    "href": "http://glance.openstack.example.org/v2/",
                    "rel": "self"
                }
            ],
            "status": "CURRENT"
        },
        {
            "id": "v2.5",
            "links": [
                {
                    "href": "http://glance.openstack.example.org/v2/",
                    "rel": "self"
                }
            ],
            "status": "SUPPORTED"
        },
        {
            "id": "v2.4",
            "links": [
                {
                    "href": "http://glance.openstack.example.org/v2/",
                    "rel": "self"
                }
            ],
            "status": "SUPPORTED"
        },
        {
            "id": "v2.3",
            "links": [
                {
                    "href": "http://glance.openstack.example.org/v2/",
                    "rel": "self"
                }
            ],
            "status": "SUPPORTED"
        },
        {
            "id": "v2.2",
            "links": [
                {
                    "href": "http://glance.openstack.example.org/v2/",
                    "rel": "self"
                }
            ],
            "status": "SUPPORTED"
        },
        {
            "id": "v2.1",
            "links": [
                {
                    "href": "http://glance.openstack.example.org/v2/",
                    "rel": "self"
                }
            ],
            "status": "SUPPORTED"
        },
        {
            "id": "v2.0",
            "links": [
                {
                    "href": "http://glance.openstack.example.org/v2/",
                    "rel": "self"
                }
            ],
            "status": "SUPPORTED"
        }
    ]
}
GET
/

List API versions

Lists information about all Image service API versions supported by this deployment, including the URIs.

Normal response codes: 300

Request

There are no request parameters.

Response Example

{
    "versions": [
        {
            "id": "v2.6",
            "links": [
                {
                    "href": "http://glance.openstack.example.org/v2/",
                    "rel": "self"
                }
            ],
            "status": "CURRENT"
        },
        {
            "id": "v2.5",
            "links": [
                {
                    "href": "http://glance.openstack.example.org/v2/",
                    "rel": "self"
                }
            ],
            "status": "SUPPORTED"
        },
        {
            "id": "v2.4",
            "links": [
                {
                    "href": "http://glance.openstack.example.org/v2/",
                    "rel": "self"
                }
            ],
            "status": "SUPPORTED"
        },
        {
            "id": "v2.3",
            "links": [
                {
                    "href": "http://glance.openstack.example.org/v2/",
                    "rel": "self"
                }
            ],
            "status": "SUPPORTED"
        },
        {
            "id": "v2.2",
            "links": [
                {
                    "href": "http://glance.openstack.example.org/v2/",
                    "rel": "self"
                }
            ],
            "status": "SUPPORTED"
        },
        {
            "id": "v2.1",
            "links": [
                {
                    "href": "http://glance.openstack.example.org/v2/",
                    "rel": "self"
                }
            ],
            "status": "SUPPORTED"
        },
        {
            "id": "v2.0",
            "links": [
                {
                    "href": "http://glance.openstack.example.org/v2/",
                    "rel": "self"
                }
            ],
            "status": "SUPPORTED"
        }
    ]
}

Version History

Rocky changes

  • version 1.1 is DELETED
  • version 1.0 is DELETED

Queens changes

  • version 2.6 is CURRENT
  • version 2.5 is SUPPORTED

Pike changes

  • version 2.6 is EXPERIMENTAL

Ocata changes

  • version 2.5 is CURRENT
  • version 2.4 is SUPPORTED

Newton changes

  • version 2.4 is CURRENT
  • version 2.3 is SUPPORTED
  • version 1.1 is DEPRECATED
  • version 1.0 is DEPRECATED

Kilo changes

  • version 2.3 is CURRENT
  • version 1.1 is SUPPORTED

Havana changes

  • version 2.2 is CURRENT
  • version 2.1 is SUPPORTED

Grizzly changes

  • version 2.1 is CURRENT
  • version 2.0 is SUPPORTED

Folsom changes

  • version 2.0 is CURRENT

Diablo changes

  • version 1.1 is CURRENT
  • version 1.0 is SUPPORTED

Bexar changes

  • version 1.0 is CURRENT

What happened to the v1 API?

The Image Service API version 1 was DEPRECATED in the OpenStack Newton release and removed during the development cycle for the Rocky release. The last OpenStack release containing the Image Service API v1 was the Queens release.

The source files for the Image Service API Reference are contained in the OpenStack Glance source code repository. The files for the version 1 reference are no longer in the current development branch, but they may still be found in the stable branches in the repository.

If you would like to consult the Image Service API version 1 Reference, you can check out a stable branch from the repository, build it locally, and use a web browser to read the generated HTML files.

Building the API Reference

You’ll need to have the following installed on your system:

  • python
  • git
  • tox

Then:

  1. Go to the Glance repository mirror on GitHub: https://github.com/openstack/glance

  2. Clone the repository to your local system.

  3. Checkout the stable/queens branch of glance.

  4. From the root directory, use tox to build the api-reference:

    tox -e api-ref

  5. The HTML version of the Image Service API Reference will be located in the api-ref/build/html directory. Use your browser to open the index.html file in that directory and you’ll be able to browse the API Reference.

Creative Commons Attribution 3.0 License

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.