latestOpenAPI 3.0.1Gremlin License2026-08-18401455582.4 KB

c6a54006c14b

failure-flags.experiments

Get Experiment by ID.

Requires the privilege EXPERIMENTS_READ

get/failure-flags/experiments/{id}

Path parameters

idstring required

Query parameters

teamIdstring required

Required when using company session token.

Response

Get an Experiment by team and ID

idstring
teamIdstring
namestring required
staticTargetingboolean
durationstring required

The duration expressed as a variant of ISO 8601 with the following simplifications:

  1. no leading 'PT' (eg. 5m or 10h)
  2. valid time units are exclusively: m, h, d, s
ratenumber float
effectobject
state'IN_PROGRESS' | 'COMPLETED' | 'HALTED' | 'FAILED'
stateReasonstring
createdAtstring date-time
startTimestring date-time
protectedboolean

Example response

{
  "app": {
    "labels": {
      "foo": [
        "bar",
        "baz"
      ]
    },
    "runtimeLabels": {
      "zones": [
        "us-west-1a",
        "us-west-1b"
      ]
    }
  },
  "flag": {
    "labels": {
      "foo": [
        "bar",
        "baz"
      ]
    },
    "runtimeLabels": {
      "zones": [
        "us-west-1a",
        "us-west-1b"
      ]
    }
  },
  "duration": "30m"
}