Preflight a Docker node migration

POST

/api/docker/migrations/preflight

curl --request POST \
  --url https://gateway.example.com/api/docker/migrations/preflight \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "resource": { "type": "container", "containerName": "example" }, "sourceNodeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "targetNodeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "keepSource": false }'

• Your Gateway instance

Authorizations

• bearerAuth

Request Body^required

JSON request body

Media typeapplication/json

object

resource

required

One of:

object

object

type

required

string

Allowed values: container

containerName

required

string

>= 1 characters <= 255 characters

object

object

type

required

string

Allowed values: deployment

deploymentId

required

string format: uuid

sourceNodeId

required

string format: uuid

targetNodeId

required

string format: uuid

keepSource

boolean

Responses

200

Sanitized migration preflight report

Media typeapplication/json

object

data

required

object

fingerprint

required

string

resourceType

required

string

Allowed values: container deployment

resourceName

required

string

sourceResourceId

required

string

scopeResourceId

required

string

sourceNodeId

required

string format: uuid

targetNodeId

required

string format: uuid

targetNodeSlug

required

string

keepSource

required

boolean

sourceState

required

string

blockers

required

Array<object>

object

code

required

string

message

required

string

resource

string

warnings

required

Array<object>

object

code

required

string

message

required

string

resource

string

plannedChanges

required

Array<string>

capacity

required

object

requiredBytes

required

integer

availableBytes

required

integer | null

marginBytes

required

integer

sufficient

required

boolean

artifacts

required

Array<object>

object

kind

required

string

Allowed values: image volume

sourceIdentity

required

string

targetIdentity

required

string

sizeBytes

required

integer | null

deletionPlan

required

Array<object>

object

type

required

string

Allowed values: container deployment volume

name

required

string

sizeBytes

integer

proxyHosts

required

Array<object>

object

id

required

string format: uuid

enabled

required

boolean

maintenanceAlreadyEnabled

required

boolean

verificationPlan

required

Array<string>

environmentKeyCount

required

integer

secretKeyCount

required

integer

Example

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Example resource",
    "createdAt": "2024-01-01T12:00:00.000Z",
    "updatedAt": "2024-01-01T12:30:00.000Z"
  }
}

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