---
updatedAt: 2026-06-19T13:07:52.000Z
agentTools:
  projectIndex: https://docs.sixfab.com/llms.txt
---

# Containers

Retrieve all user containers of the ALPON device.

**Possible Error Codes:**
- **AssetNotFound:** The asset with the specified ID was not found.
- **AssetNotAlponDevice:** The device is not an ALPON device.

# OpenAPI definition

```json
{
  "openapi": "3.0.2",
  "info": {
    "title": "Sixfab Developer API",
    "contact": {
      "name": "Sixfab Inc.",
      "url": "https://sixfab.com",
      "email": "hello@sixfab.com"
    },
    "version": "0.1.0",
    "x-logo": {
      "url": "/logo"
    }
  },
  "servers": [
    {
      "url": "https://api.sixfab.com/v1"
    }
  ],
  "paths": {
    "/assets/{asset_id}/alpon/containers": {
      "get": {
        "tags": [
          "ALPON"
        ],
        "summary": "Containers",
        "description": "Retrieve all user containers of the ALPON device.\n\n**Possible Error Codes:**\n- **AssetNotFound:** The asset with the specified ID was not found.\n- **AssetNotAlponDevice:** The device is not an ALPON device.",
        "operationId": "get_user_containers_assets__asset_id__alpon_containers_get",
        "parameters": [
          {
            "description": "Serial Number, UUID, SIM SID or SIM ICCID",
            "required": true,
            "schema": {
              "title": "Asset Id",
              "type": "string",
              "description": "Serial Number, UUID, SIM SID or SIM ICCID"
            },
            "name": "asset_id",
            "in": "path"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UserContainersResponseModel"
                }
              }
            }
          },
          "400": {
            "description": "Device is not an ALPON device",
            "content": {
              "application/json": {
                "example": {
                  "message": "Device is not an ALPON device",
                  "code": "AssetNotAlponDevice"
                }
              }
            }
          },
          "404": {
            "description": "Asset not found",
            "content": {
              "application/json": {
                "example": {
                  "message": "Asset not found",
                  "code": "AssetNotFound"
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          }
        },
        "security": [
          {
            "APIKeyHeader": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "HTTPValidationError": {
        "title": "HTTPValidationError",
        "type": "object",
        "properties": {
          "detail": {
            "title": "Detail",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ValidationError"
            }
          }
        }
      },
      "UserContainerModel": {
        "title": "UserContainerModel",
        "required": [
          "name",
          "image",
          "status",
          "host_network",
          "privileged"
        ],
        "type": "object",
        "properties": {
          "name": {
            "title": "Name",
            "type": "string",
            "description": "Name of the container."
          },
          "image": {
            "title": "Image",
            "type": "string",
            "description": "Docker image of the container."
          },
          "status": {
            "title": "Status",
            "type": "string",
            "description": "Status of the container."
          },
          "host_network": {
            "title": "Host Network",
            "type": "boolean",
            "description": "Is the container using host network."
          },
          "privileged": {
            "title": "Privileged",
            "type": "boolean",
            "description": "Is the container running in privileged mode."
          },
          "env": {
            "title": "Environment Variables",
            "type": "object",
            "additionalProperties": {
              "type": "string"
            },
            "description": "Environment variables for the container."
          },
          "ports": {
            "title": "Ports",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/UserContainerPortModel"
            },
            "description": "List of ports used by the container."
          },
          "volumes": {
            "title": "Volumes",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/UserContainerVolumeModel"
            },
            "description": "List of volumes mounted in the container."
          }
        }
      },
      "UserContainerPortModel": {
        "title": "UserContainerPortModel",
        "type": "object",
        "properties": {
          "host_port": {
            "title": "Host Port",
            "type": "integer",
            "description": "The port the container is exposed on"
          },
          "target_port": {
            "title": "Target Port",
            "type": "integer",
            "description": "The port the container is listening on"
          }
        }
      },
      "UserContainerVolumeModel": {
        "title": "UserContainerVolumeModel",
        "type": "object",
        "properties": {
          "local": {
            "title": "Local Volume Path",
            "type": "string",
            "description": "Local volume path."
          },
          "target": {
            "title": "Target Volume Path",
            "type": "string",
            "description": "Target volume path."
          },
          "readonly": {
            "title": "Read-Only",
            "type": "boolean",
            "description": "Is the volume read-only.",
            "default": false
          }
        }
      },
      "UserContainersResponseModel": {
        "title": "UserContainersResponseModel",
        "required": [
          "containers"
        ],
        "type": "object",
        "properties": {
          "containers": {
            "title": "Containers",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/UserContainerModel"
            },
            "description": "List of user containers."
          }
        }
      },
      "ValidationError": {
        "title": "ValidationError",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "type": "object",
        "properties": {
          "loc": {
            "title": "Location",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "msg": {
            "title": "Message",
            "type": "string"
          },
          "type": {
            "title": "Error Type",
            "type": "string"
          }
        }
      }
    },
    "securitySchemes": {
      "APIKeyHeader": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-Key"
      }
    }
  }
}
```