Sign in
Images

List Images

Returns all Image objects. You can select specific Image types only and sort the results by using URI parameters.

get/images

Request

  • Base URL: https://api.hetzner.cloud/v1
  • URL: https://api.hetzner.cloud/v1/images
  • Auth: HTTP bearer

Query parameters

sortstring[]

Sort resources by field and direction. May be used multiple times.

For more information, see "Sorting".

typestring[]

Filter resources by type. May be used multiple times.

The response will only contain the resources with the specified type.

[
  "snapshot"
]
statusstring[]

Filter resources by status. May be used multiple times.

The response will only contain the resources with the specified status.

[
  "available"
]
bound_tostring[]

Filter Images by their linked Server ID. May be used multiple times.

Only available for Images of type backup.

include_deprecatedboolean

Include deprecated Images.

namestring

Filter resources by their name.

The response will only contain the resources matching exactly the specified name.

label_selectorstring

Filter resources by labels.

The response will only contain resources matching the label selector. For more information, see "Label Selector".

architecture'x86' | 'arm'

CPU architecture of the Resource.

Example:x86

Filter resources by cpu architecture.

The response will only contain the resources with the specified cpu architecture.

pageinteger
Example:1

Page number to return. For more information, see "Pagination".

per_pageinteger
Example:25

Maximum number of entries returned per page. For more information, see "Pagination".

Response

Request succeeded.

Example response

{
  "images": [
    {
      "id": 42,
      "type": "snapshot",
      "status": "available",
      "name": "ubuntu-24.04",
      "description": "Ubuntu 24.04 Standard 64 bit",
      "image_size": 2.3,
      "disk_size": 10,
      "created": "2016-01-30T23:55:00Z",
      "created_from": {
        "id": 1,
        "name": "Server"
      },
      "os_flavor": "ubuntu",
      "os_version": "24.04",
      "deprecated": "2018-02-28T00:00:00Z",
      "deprecation": {
        "unavailable_after": "2023-09-01T00:00:00Z",
        "announced": "2023-06-01T00:00:00Z"
      },
      "labels": {
        "environment": "prod",
        "example.com/my": "label",
        "just-a-key": ""
      },
      "architecture": "x86"
    }
  ],
  "meta": {
    "pagination": {
      "page": 3,
      "per_page": 25,
      "previous_page": 2,
      "next_page": 4,
      "last_page": 4,
      "total_entries": 100
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.