List Container Images
- Name
get
- Type
- /v1/containers
- Description
Send a
GET
request to list container images.
Request
Example
curl -X GET "https://api.simplystack.com/v1/containers" \
-H "Content-Type: application/json" \
-H "Authorization: Token d359ad9cc9422b5ff07aede0cd2707da4ff82be0" \
Response
JSON object with key named container
which is an array of the following attributes for the containers 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 container.
Image Attributes
In addition to the container
object, an array of the image
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 container image.
- Name
default
- Type
- string
- Description
A boolean value of the container 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 container is available for installation.
- Name
extra_price
- Type
- decimal
- Description
Value of the extra price of the container image in US$.
Example
json
{
"containers": [
{
"images": [
{
"available": true,
"default": true,
"extra_price": "0.0000",
"size_ids": [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11],
"slug": "coreos-2303-3-0",
"version": "2303.3.0 (stable)"
}
],
"name": "CoreOS"
},
{
"images": [
{
"available": true,
"default": true,
"extra_price": "0.0000",
"size_ids": [2, 3, 4, 6, 7, 8, 9, 10, 11],
"slug": "rancheros-1-5-5",
"version": "1.5.5"
}
],
"name": "RancherOS"
}
],
"meta": {
"pagination": {
"current_page": 1,
"next_page": null,
"pages": 1,
"per_page": 25,
"previous_page": null,
"total": 2
},
"query": null,
"sort": null
}
}