Rollback a deployment

POST

/api/docker/nodes/{nodeId}/deployments/{deploymentId}/rollback

curl --request POST \
  --url https://gateway.example.com/api/docker/nodes/550e8400-e29b-41d4-a716-446655440000/deployments/550e8400-e29b-41d4-a716-446655440000/rollback \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "force": true }'

• Your Gateway instance

Serves the previous release from the standby slot. The release keeps the current managed database and storage links: their networks come from the current configuration (a link added since stays, a link removed since is not reattached) and their secrets are merged at deploy time. Rolling back to another image on a deployment with host bind mounts needs docker:containers:mounts.

Authorizations

• bearerAuth

Parameters

Path Parameters

nodeId

required

string

>= 1 characters

Example

550e8400-e29b-41d4-a716-446655440000

deploymentId

required

string

>= 1 characters

Example

550e8400-e29b-41d4-a716-446655440000

Request Body

Optional JSON request body

Media typeapplication/json

object

force

boolean

Example^generated

{
  "force": true
}

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": "550e8400-e29b-41d4-a716-446655440000",
    "name": "api",
    "image": "registry.example.com/api:1.2.3",
    "activeColor": "blue",
    "status": "running"
  }
}

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