Stream a Gateway container archive

GET

/api/docker/nodes/{nodeId}/containers/{containerId}/archive

const url = 'https://gateway.example.com/api/docker/nodes/550e8400-e29b-41d4-a716-446655440000/containers/550e8400-e29b-41d4-a716-446655440000/archive?imageMode=portable&includeWritableLayer=false&includeEnvironment=true&includeSecrets=false';
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://gateway.example.com/api/docker/nodes/550e8400-e29b-41d4-a716-446655440000/containers/550e8400-e29b-41d4-a716-446655440000/archive?imageMode=portable&includeWritableLayer=false&includeEnvironment=true&includeSecrets=false' \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth

Parameters

Path Parameters

nodeId

required

string

>= 1 characters

Example

550e8400-e29b-41d4-a716-446655440000

containerId

required

string

>= 1 characters

Example

550e8400-e29b-41d4-a716-446655440000

Query Parameters

imageMode

string

default: portable

Allowed values: portable registry

includeWritableLayer

boolean

includeEnvironment

boolean

default: true

includeSecrets

boolean

Responses

200

GWCA v1 stream. Volume contents are never included.

application/vnd.wiolett.gwca

string format: binary

400

Bad request

application/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "VALIDATION_ERROR",
  "message": "Request validation failed",
  "details": [
    {
      "path": [
        "name"
      ],
      "message": "Required"
    }
  ]
}

401

Authentication required

application/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNAUTHORIZED",
  "message": "Authentication required"
}

403

Forbidden

application/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "FORBIDDEN",
  "message": "Insufficient permissions"
}

404

Not found

application/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "NOT_FOUND",
  "message": "Resource not found"
}

409

The container cannot be exported as a standalone archive. DOCKER_ARCHIVE_COMPOSE_CONTAINER: it belongs to a Compose project and is managed through that project. GPU_ARCHIVE_UNSUPPORTED: it has GPU mappings.

application/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "DOCKER_ARCHIVE_COMPOSE_CONTAINER",
  "message": "This container belongs to Compose project shop and cannot be exported as a container archive; manage it through the Compose project instead",
  "details": {
    "nodeId": "550e8400-e29b-41d4-a716-446655440000",
    "containerId": "shop-web-1",
    "projectName": "shop",
    "projectId": null
  }
}

422

Unprocessable entity

application/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "UNPROCESSABLE_ENTITY",
  "message": "Request could not be processed"
}

500

Internal server error

application/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "INTERNAL_ERROR",
  "message": "Internal server error"
}