---
title: "Idempotently halt the specified scenario run."
method: POST
path: "/scenarios/halt/{guid}/runs/{runNumber}"
tags: ["scenarios"]
---

# Idempotently halt the specified scenario run.

`POST /scenarios/halt/{guid}/runs/{runNumber}`

Requires the privilege [`MINIMUM_TEAM_PRIVILEGES`](https://www.gremlin.com/docs/user-management/access-control/#privileges)

## Path parameters

- `guid` string, required
- `runNumber` integer, required

## Query parameters

- `teamId` string, required

## Request body

- HaltRequest
  - `reason` string — The reason why this halt this requested.
  - `reference` string — A reference to why this halt was requested.

## Response `202`

Scenario has begun halting

## Other responses

- `401` — Authorization header missing or malformed. Please provide proper credentials in the authorization header.
- `403` — User requires privilege for target team: MINIMUM_TEAM_PRIVILEGES
- `404` — scenario not found

---

[API](https://skmtc.net/gremlin/apis/gremlin-api.md) · [All operations](https://skmtc.net/gremlin/apis/gremlin-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gremlin/gremlin-api/revisions/4473fbff84f0/schema)