Event

Update deployment event

Changed on

Update selective attributes on existing deployment event (backend only)

patch/events/deployment/{id}

Request

  • Base URL: https://api.mabl.com
  • URL: https://api.mabl.com/events/deployment/{id}
  • Auth: one of:
    • HTTP basic
    • API key in header Authorization

Path parameters

idstring required

The ID of the event to update

Headers

If-Matchstring

If-Match header according to http/1.1 spec section 14.24

Request body

Response

Updated entity

idstring required

Unique ID for the deployment event

environment_idstring

ID of the environment associated with this deployment

environment_namestring

Name of the environment associated with this deployment. Absent when the deployment carries no environment or the environment has since been deleted.

application_idstring

ID of the application associated with this deployment

application_namestring

Name of the application associated with this deployment. Absent when the deployment carries no application or the application has since been deleted.

workspace_idstring required

ID of the workspace associated with this deployment

event_timeinteger

Epoch millisecond timestamp at which the deployment occurred

received_timeinteger

Epoch millisecond timestamp the event was received at

revisionstring

Source code revision

branchstring

The mabl branch the event named, from branch or source_control_tag, even when mabl has no such branch. Absent when the event named none. The branch each selected test ran on is in test_selection.resolved_tests

propertiesobject

Arbitrary key-value pairs used to pass additional information about this deployment

plan_overridesobject

Optional overrides specified for the stored properties of any triggered plans

plan_labelsstring[]

If specified, only plans matching the given labels were executed

actionsobject

Optional actions specified for mabl to take on this deployment

Changes

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property ////// to the response with the status