Promote between environments

POST

/api/apps/{id}/promotions

curl --request POST \
  --url https://opfield.example.com/api/apps/550e8400-e29b-41d4-a716-446655440000/promotions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "sourceEnvironmentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "targetEnvironmentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "items": [ "example" ], "previewDigest": "example" }'

• Your Opfield instance

Runs the selected items (pairKey from the preview) one after another in the background: containers are recreated and deployments blue-green deployed with the source image by digest, Compose projects get a new revision of the source YAML with pinned images (their own variables kept) and are applied, Pages projects activate a copy of the source artifact. Each item succeeds or fails on its own; nothing is rolled back. Refused with 409 PROMOTION_PREVIEW_STALE when what runs changed since the preview, and 409 APP_ISOLATED while the target is isolated. apps:promote on the target environment.

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string

>= 1 characters

Example

550e8400-e29b-41d4-a716-446655440000

Request Body^required

JSON request body

Media typeapplication/json

object

sourceEnvironmentId

required

string format: uuid

targetEnvironmentId

required

string format: uuid

items

required

Array<string>

>= 1 items <= 200 items

previewDigest

required

string

>= 1 characters <= 128 characters

Example^generated

{
  "sourceEnvironmentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "targetEnvironmentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "items": [
    "example"
  ],
  "previewDigest": "example"
}

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