list containers

GET

/api/v1/container

Controller:

github.com/raghavyuva/nixopus-api/internal/features/container/controller.(*ContainerController).ListContainers

Middlewares:

• github.com/go-fuego/fuego.defaultLogger.middleware
• github.com/raghavyuva/nixopus-api/internal/routes.(*Router).SetupRoutes.(*Router).setupAuthentication.func2
• github.com/raghavyuva/nixopus-api/internal/routes.(*Router).applyMiddleware.func1
• github.com/raghavyuva/nixopus-api/internal/routes.(*Router).applyMiddleware.func2
• github.com/raghavyuva/nixopus-api/internal/routes.(*Router).applyMiddleware.func3

---

Parameters

Header Parameters

Accept

Typestring

Responses

OK

Content-Type

{

"data": {

"containers": [

{

"command": "string",

"created": "string",

"host_config": {

"cpu_shares": 0,

"memory": 0,

"memory_swap": 0

},

"id": "string",

"image": "string",

"ip_address": "string",

"labels": {

},

"mounts": [

{

"destination": "string",

"mode": "string",

"source": "string",

"type": "string"

}

],

"name": "string",

"networks": [

{

"aliases": [

"string"

],

"gateway": "string",

"ip_address": "string",

"mac_address": "string",

"name": "string"

}

],

"ports": [

{

"private_port": 0,

"public_port": 0,

"type": "string"

}

],

"state": "string",

"status": "string"

}

],

"image": "string",

"name": "string",

"page": 0,

"page_size": 0,

"search": "string",

"sort_by": "string",

"sort_order": "string",

"status": "string",

"total_count": 0

},

"message": "string",

"status": "string"

}

GET

/api/v1/container

Samples

cURL

curl -X GET http://localhost/api/v1/container

JavaScript

fetch("http://localhost/api/v1/container")
  .then(response => response.json())
  .then(data => console.log(data));

PHP

file_get_contents("http://localhost/api/v1/container");

Python

import requests
response = requests.get("http://localhost/api/v1/container")
print(response.json())

Powered by VitePress OpenAPI