List containers

GET

/v1/container/

const url = 'https://example.com/v1/container/';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/v1/container/ \
  --header 'Authorization: Bearer <token>'

Return all containers for the current account.

Authorizations

jwtAuth
basicAuth

Parameters

Query Parameters

container_id

string

container_image_id

string

container_image_name

string

container_status

string

cursor

string

The pagination cursor value.

deleted

boolean

docker_id

string

docker_status

string

host

string format: uuid

name

string

page_size

integer

Number of results to return per page.

search

string

A search term.

Responses

200

application/json

object

next

string format: uri

nullable

previous

string format: uri

nullable

results

required

Array<object>

A ModelSerializer that takes an additional fields argument that controls which fields should be displayed.

object

command

string

cpu_current_value

required

number format: double

nullable

deleted_at

string format: date-time

nullable

docker_api_version

string

<= 10 characters

container_created_at

string format: date-time

nullable

container_finished_at

string format: date-time

nullable

container_id

string

<= 100 characters

container_image_id

string

<= 100 characters

container_image_name

string

<= 256 characters

container_inspect

string

container_started_at

string format: date-time

nullable

container_status

string

container_runtime

string

<= 50 characters

host

required

string format: uuid

required

string format: uuid

io_read_bytes_current_value

required

number format: double

nullable

io_write_bytes_current_value

required

number format: double

nullable

memory_current_status

required

integer

nullable

memory_current_value

required

number format: double

nullable

name

string

<= 256 characters

net_bits_recv_current_value

required

number format: double

nullable

net_bits_sent_current_value

required

number format: double

nullable

docker_id

string

docker_image_id

string

docker_image_name

string

docker_created_at

string format: date-time

nullable

docker_finished_at

string format: date-time

nullable

docker_started_at

string format: date-time

nullable

docker_inspect

string

docker_status

string

Example

{
  "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
  "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3"
}