v1

latestOpenAPI 3.0.1Gremlin License2026-08-06397451577.0 KB
scenarios

Idempotently halt the specified scenario run.

Requires the privilege MINIMUM_TEAM_PRIVILEGES

post/scenarios/halt/{guid}/runs/{runNumber}

Path parameters

guidstring required

This value represents the globally unique identifier of the record to fetch.

runNumberinteger required

Query parameters

teamIdstring required

Required when using company session token.

Request body

reasonstring

The reason why this halt this requested.

referencestring

A reference to why this halt was requested.

Response

Scenario has begun halting