Plan target resource mappings for a Gateway container archive

POST

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

curl --request POST \
  --url https://gateway.example.com/api/docker/nodes/550e8400-e29b-41d4-a716-446655440000/containers/archive/plan \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "networks": [ { "name": "example", "driver": "example", "subnet": "example", "gateway": "example", "createable": true, "createNew": true, "requiresMapping": true } ], "mounts": [ { "type": "bind", "source": "example", "target": "example", "readOnly": true, "driver": "example", "labels": { "additionalProperty": "example" }, "createNew": true, "requiresMapping": true } ], "ports": [ { "containerPort": 1, "hostPort": 1, "protocol": "tcp" } ] }'

• Your Gateway instance

Authorizations

• bearerAuth

Parameters

Path Parameters

nodeId

required

string

>= 1 characters

Example

550e8400-e29b-41d4-a716-446655440000

Request Body^required

JSON request body

Media typeapplication/json

object

networks

required

Array<object>

<= 64 items

object

name

required

string

>= 1 characters <= 512 characters

driver

string

<= 512 characters

subnet

string

<= 512 characters

gateway

string

<= 512 characters

createable

required

boolean

createNew

boolean

requiresMapping

boolean

mounts

required

Array<object>

<= 256 items

object

type

required

string

Allowed values: bind volume

source

required

string

>= 1 characters <= 4096 characters

target

required

string

>= 1 characters <= 4096 characters

readOnly

required

boolean

driver

string

<= 512 characters

labels

object

key

additional properties

string

createNew

boolean

requiresMapping

boolean

ports

required

Array<object>

<= 256 items

object

containerPort

required

integer

>= 1 <= 65535

hostPort

required

integer

<= 65535

protocol

required

string

Allowed values: tcp udp

Responses

200

Successful response

Media typeapplication/json

object

data

required

Resource object. Exact fields depend on the endpoint.

object

id

string

name

string

key

additional properties

Example

{
  "data": {
    "id": "nginx-prod",
    "name": "nginx-prod",
    "image": "nginx:1.27",
    "state": "running",
    "ports": [
      "80/tcp"
    ]
  }
}

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"
}