---
title: "Set the incident mode of an NHI policy"
method: PUT
path: "/v1/nhi/policies/{policy_name}"
tags: ["NHI Policies"]
---

# Set the incident mode of an NHI policy

`PUT /v1/nhi/policies/{policy_name}`

## Request

- Base URL: `https://api.gitguardian.com`
- URL: `https://api.gitguardian.com/v1/nhi/policies/{policy_name}`
- Auth: HTTP bearer

Set the incident mode of an NHI policy for the workspace.

Incidents are created only once NHI incident promotion is active for the workspace. Before that, the mode is stored and no incident is created.

When a policy starts to create incidents, only the breaches recorded after that point create incidents. The breaches recorded before, and the breaches recorded while promotion was not active, do not.

When a policy goes to or from `hidden`, GitGuardian checks the policy again for the workspace.

The workspace must have full NHI governance activation.
The API token must have the Manager access level or above, or be a service account token.

## Path parameters

- `policy_name` string, required

## Request body

- object
  - `incident_mode` 'hidden' | 'tag_only' | 'creates_incidents', required: - `hidden`: the breaches are not shown. - `tag_only`: the breaches show as a tag on the identity. - `creates_incidents`: the breaches also create secret incidents.

## Response `200`

The policy, with its new mode.

- object
  - `name` string, required
  - `incident_mode` 'hidden' | 'tag_only' | 'creates_incidents', required: - `hidden`: the breaches are not shown. - `tag_only`: the breaches show as a tag on the identity. - `creates_incidents`: the breaches also create secret incidents.
  - `is_incident_mode_fixed` boolean, required: Whether the incident mode of this policy is fixed and cannot be changed.

## Other responses

- `400`: Invalid mode, or the mode of this policy is fixed.
- `401`: Invalid API key
- `403`: Permission denied
- `404`: Policy not found
- `503`: API under maintenance

## Changes

- **2026-10-27** `13e7ff1b964d`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/gitguardian/apis/gitguardian-api/changes/v1/nhi/policies/:policy_name/put.md)

---

[API](https://skmtc.dev/gitguardian/apis/gitguardian-api.md) - [All operations](https://skmtc.dev/gitguardian/apis/gitguardian-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gitguardian/apis/gitguardian-api/revisions/5829df7b9045?raw)