Experiments

Cancel experiment

Cancel an experiment, ending it without a winning variant. The experiment moves to CANCELLED status, the supplied reason is recorded in its conclusion as the decision reason, and the experiment is unlinked from the feature flag allocations that exposed it, which stops its exposure. An experiment that has already completed its rollout, had its code removed, or been canceled cannot be canceled again. Canceling is not reversible: an experiment cannot be returned to a running state afterward. It is also not idempotent: canceling an already-canceled experiment returns 409, so a retry after a timeout cannot be distinguished from a cancellation made by someone else.

post/api/v2/experiments/{experiment_id}/cancel

Request

Path parameters

experiment_idstring uuid required

The UUID of the experiment.

Example:550e8400-e29b-41d4-a716-446655440000

Request body

Example request

{
  "data": {
    "attributes": {
      "reason": "Experiment configuration was incorrect"
    },
    "type": "cancel-experiment-request"
  }
}

Response

The experiment was canceled and unlinked from its feature flag allocations.

Changes

Changes to this operation have not been checked yet.