GET /images

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

Servers

Query parameters

Name Type Required Description
page Integer No

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

Default value: 1

name String No

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

architecture String No

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

Possible values:

  • "arm"
  • "x86"
sort String No

Sort resources by field and direction. Can be used multiple times. For more information, see "Sorting".

Possible values:

  • "created:desc"
  • "id"
  • "id:asc"
  • "name:asc"
  • "created"
  • "name"
  • "id:desc"
  • "name:desc"
  • "created:asc"
label_selector String No

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

per_page Integer No

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

Default value: 25

type String No

Filter resources by type. Can be used multiple times. The response will only contain the resources with the specified type.

Possible values:

  • "system"
  • "backup"
  • "snapshot"
  • "app"
status String No

Filter resources by status. Can be used multiple times. The response will only contain the resources with the specified status.

Possible values:

  • "available"
  • "unavailable"
  • "creating"
bound_to String No

Can be used multiple times. Server ID linked to the Image. Only available for Images of type backup

include_deprecated Boolean No

Can be used multiple times.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.