GamebeastDocs
Dashboard
Project APIExperiments (V2)

Terminate experiment

POST
/application/{applicationId}/v2/experiments/{experimentId}/terminate

Immediately terminate an active or scheduled experiment. Releases path locks and advances the catalog generation so SDK fetches no longer include it.

Authorization

personalAccessTokenAuth
AuthorizationBearer <token>

Personal access token (prefixed gb_pat_). Acts on behalf of its owner and can never exceed the owner's own permissions. Send it as Authorization: Bearer <token>.

In: header

Path Parameters

applicationId*integer
Range0 < value <= 9007199254740991
experimentId*integer
Range0 < value <= 9007199254740991

Header Parameters

environment_id*number

Gamebeast environment ID

Response Body

application/json

curl -X POST "https://example.com/application/1/v2/experiments/1/terminate" \  -H "environment_id: 0"
{  "id": 1,  "applicationId": 1,  "environmentId": 1,  "baseConfigurationId": 1,  "name": "string",  "description": "string",  "access": "public",  "unitType": "user",  "autoAssignment": true,  "assignmentMode": "weightedHash",  "permanentEnrollment": true,  "targeting": {    "version": 1,    "root": null  },  "requiredProperties": [    "string"  ],  "state": "scheduled",  "startsAt": "2019-08-24T14:15:22Z",  "endsAt": "2019-08-24T14:15:22Z",  "terminatedAt": "2019-08-24T14:15:22Z",  "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",  "terminatedBy": "67700905-d026-410e-9812-5c6358f2720f",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "groups": [    {      "id": 1,      "label": "string",      "color": "string",      "iconName": "string",      "weight": -9007199254740991,      "ordinal": 0,      "changeset": {        "id": 1,        "version": 1,        "baseConfigurationId": 1,        "baseContentHash": "string",        "operations": [          {            "id": 1,            "index": 0,            "op": "set",            "path": "string",            "value": null,            "baseValue": null          }        ]      }    }  ]}