Update a deployment

PUT

/deployments/{id}

• Current canonical versioned path (F3.API.01)

Authorizations

• bearerAuth
• apiTokenAuth

Parameters

Path Parameters

id

required

string

DocumentId

Request Body ^required

object

data

object

name

required

string

environment

required

string

Allowed values: development staging production preview

service_name

required

string

version

string

strategy

string

Allowed values: blue_green rolling canary

traffic_split_pct

integer

rollback_on_error

boolean

status

string

Allowed values: pending in_progress running success completed failed rolled_back cancelled

deployed_by

string

started_at

string format: date-time

finished_at

string format: date-time

completed_at

string format: date-time

duration_seconds

integer

change_request_id

string

deployment_url

string

error_log

string

organisation

One of:

string

DocumentId reference to api::organisation.organisation

string

object

object

key

additional properties

any

cloud_instance

One of:

string

DocumentId reference to api::cloud-instance.cloud-instance

string

object

object

key

additional properties

any

Responses

200

Updated

object

data

object

name

required

string

environment

required

string

Allowed values: development staging production preview

service_name

required

string

version

string

strategy

string

Allowed values: blue_green rolling canary

traffic_split_pct

integer

rollback_on_error

boolean

status

string

Allowed values: pending in_progress running success completed failed rolled_back cancelled

deployed_by

string

started_at

string format: date-time

finished_at

string format: date-time

completed_at

string format: date-time

duration_seconds

integer

change_request_id

string

deployment_url

string

error_log

string

organisation

One of:

string

DocumentId reference to api::organisation.organisation

string

object

object

key

additional properties

any

cloud_instance

One of:

string

DocumentId reference to api::cloud-instance.cloud-instance

string

object

object

key

additional properties

any

documentId

string

id

integer

createdAt

string format: date-time

updatedAt

string format: date-time

publishedAt

string format: date-time

nullable

400

Validation error

401

Missing or invalid authentication

403

Not authorized (tenant scope or capability)

404

Not found