scenarios

Idempotently halt all scenario runs and active attacks.

Changed on Feb 10, 2026

post/scenarios/halt

Request

Base URL
https://api.gremlin.com/v1
Auth
none declared
TypeScript
https://skmtc.dev/gremlin/apis/gremlin-api/docs/scenarios/halt/post.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

teamIdstring

Request body

reasonstring

The reason why this halt this requested.

referencestring

A reference to why this halt was requested.

Response

Scenario has begun halting

Changes

Feb 10, 2026f75796939e51 Revision changes
- info
  added the success response with the status
Apr 28, 20253a9d5d33c5b6 Revision changes
- info
  added the new optional query request parameter teamId

Operation history