---
title: "Idempotently halt the specified active attack."
method: POST
path: "/attacks/{guid}/halt"
tags: ["attacks"]
---

# Idempotently halt the specified active attack.

`POST /attacks/{guid}/halt`

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

## Path parameters

- `guid` string, 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 `default`

default response

- TaskResponse[]
  - `orgId` string
  - `guid` string
  - `args` string[]
  - `stage` 'InvalidArgument' | 'TargetNotFound' | 'Successful' | 'UserHalted' | 'ClientAborted' | 'LostCommunication' | 'InitializationFailed' | 'TeardownFailed' | 'HaltFailed' | 'Failed' | 'Pending' | 'Distributed' | 'Initializing' | 'HaltDistributed' | 'InterruptTriggered' | 'RollbackTriggered' | 'RollbackStarted' | 'Running' | 'TearingDown' | 'Halt'
  - `createSource` 'WebApp' | 'Api' | 'Scheduled' | 'Manual' | 'Spinnaker' | 'Concord' | 'GremlinFeeder' | 'GremlinSdkPython' | 'Scenario' | 'Chao' | 'K8sBackend' | 'Website' | 'Neotys' | 'IntegrationClient' | 'Validation'
  - `triggerSource` 'MANUAL' | 'RUN_ALL' | 'SCHEDULED' | 'RECURRING_SCHEDULE'
  - `kind` 'WebApp' | 'Api' | 'Scheduled' | 'Manual' | 'Spinnaker' | 'Concord' | 'GremlinFeeder' | 'GremlinSdkPython' | 'Scenario' | 'Chao' | 'K8sBackend' | 'Website' | 'Neotys' | 'IntegrationClient' | 'Validation'
  - `owningTeamId` string
  - `createSourceDetail` 'Onboarding'
  - `infraTarget` object
  - `infraCommand` object
  - `targets` string[]
  - `targetContainers` object
  - `stageLifecycle` 'Active' | 'Halting' | 'Complete' | 'Error'
  - `createUser` string
  - `executionSummaries` object
  - `executionStageSummary` object
  - `tags` object
  - `multiSelectTags` object
  - `labels` object
  - `multiSelectLabels` object
  - `targetType` 'Host' | 'Container' | 'Docker' | 'Kubernetes'
  - `attackConfiguration` AttackConfiguration
    - `command` ServiceCommand, required
      - `infraCommandType` 'CPU' | 'IO' | 'Memory' | 'Disk' | 'Thread_Bomb' | 'Blackhole' | 'DNS' | 'Latency' | 'Packet_Loss' | 'Collect_Certs' | 'Shutdown' | 'Time_Travel' | 'Process_Killer' | 'Process_Exhaustion' | 'GPU' | 'Unknown'
      - `infraCommandArgs` InfraCommandArgs
        - `type` 'CPU' | 'IO' | 'Memory' | 'Disk' | 'Thread_Bomb' | 'Blackhole' | 'DNS' | 'Latency' | 'Packet_Loss' | 'Collect_Certs' | 'Shutdown' | 'Time_Travel' | 'Process_Killer' | 'Process_Exhaustion' | 'GPU' | 'Unknown'
        - `unknownArgs` object
        - `duplicateArgs` object[]
        - `cliArgs` string[]
        - `lengthOrZero` integer
    - `targets` ServiceTarget[], required
      - `serviceId` string
      - `targetingStrategy` TargetingStrategy, required
        - `type` string, required
    - `sampling` TargetSampling
      - `type` string, required
  - `startTime` string, date-time
  - `endTime` string, date-time
  - `initializationEndTime` string, date-time
  - `commandTemplateId` string
  - `targetTemplateId` string
  - `scenarioId` string
  - `scenarioRunNumber` integer
  - `scenarioStepNumber` integer
  - `scenarioNodeGuid` string
  - `serviceId` string
  - `k8sAttackId` string
  - `annotations` object
  - `totalClients` integer
  - `clientMetricsEnabledCount` integer
  - `providers` string[]
  - `trafficImpactMapping` TrafficImpactMapping
    - `multiSelectTags` object
    - `dependencyIds` string[]
  - `includeNewClients` boolean
  - `continueOnEmptyTargets` boolean
  - `dynamicallyResolvedIps` string[]
  - `displayErrorMessage` string
  - `executionFailureReasons` ExecutionFailureReasons
    - `executionIdToReason` object
  - `createdAt` string, date-time
  - `updatedAt` string, date-time

## Other responses

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

---

[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/versions/36ee938323f0/schema)