List Distribution Images

Name
get
Type
/v1/distributions
Description
Send a GET request to list distribution images.

Request

Example

curl -X GET "https://api.simplystack.com/v1/distributions" \
  -H "Content-Type: application/json" \
  -H "Authorization: Token d359ad9cc9422b5ff07aede0cd2707da4ff82be0" \

Response

JSON object with key named distributions which is an array of the following attributes for the distributions object:

Container Attributes

Name
name
Type
string
Description
The name of the container object.
Name
images
Type
array
Description
The entire image object of the distribution.

Image Response

In addition to the distribution object, an array of the images object of the following attributes will be returned:

Image Response Attributes

Name
id
Type
integer
Description
Container image unique integer identifier.
Name
slug
Type
string
Description
Container image unique string identifier.
Name
version
Type
string
Description
Version and type of the distribution image.
Name
default
Type
string
Description
A boolean value of the distribution image default.
Name
size_ids
Type
array
Description
Available size IDs of the image.
Name
available
Type
boolean
Description
A boolean value indicates that the distribution is available for installation.
Name
extra_price
Type
decimal
Description
Value of the extra price of the distribution image in US$.

Example

json

{
  "distributions": [
    {
      "images": [
        "name": "Ubuntu",
        {
          "name": "18.04.5 x64",
          "slug": "ubuntu-18-04-5-x64",
          "available": true,
          "default": false,
          "extra_price": "0.0000",
          "size_ids": [
            1,
            2,
            3,
            4,
            5,
            6,
            7,
            8
          ]
        },
        {
          "name": "20.04.1 x64",
          "slug": "ubuntu-20-04-1-x64",
          "available": true,
          "default": true,
          "extra_price": "0.0000",
          "size_ids": [
            1,
            2,
            3,
            4,
            5,
            6,
            7,
            8
          ]
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "current_page": 1,
      "next_page": null,
      "pages": 1,
      "per_page": 25,
      "previous_page": null,
      "total": 2
    },
    "query": null,
    "sort": null
  }
}

List container images Overview