Stream a Gateway container archive

GET

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

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>'

• Your Gateway instance

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.

Media typeapplication/vnd.wiolett.gwca

string format: binary

400

Bad request

Media typeapplication/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

Media typeapplication/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

Media typeapplication/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

Media typeapplication/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

Conflict

Media typeapplication/json

object

code

required

Error code

string

message

required

Human-readable error message

string

details

Additional error details

Example

{
  "code": "CONFLICT",
  "message": "Resource already exists"
}

422

Unprocessable entity

Media typeapplication/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

Media typeapplication/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"
}