---
title: "Set Health Mode"
method: PATCH
path: "/org/health"
tags: ["org"]
---

# Set Health Mode

`PATCH /org/health`

## Request

- Base URL: `https://api.meetadmiral.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.meetadmiral.com/org/health`
- Auth: none declared

Health mode and the paths to keep tags off (app/health_mode.py). Owners only, like the name: it
decides what Admiral stores about the workspace's leads. The paths take effect on the next Tag Manager
install; one already published keeps what it was published with until it is installed again.

## Request body

- HealthBody
  - `health_mode` boolean, required
  - `excluded_paths` string[]

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/meetadmiral/apis/admiral-api.md) · [All operations](https://skmtc.dev/meetadmiral/apis/admiral-api/llms.txt) · [OpenAPI document](https://skmtc.dev/meetadmiral/apis/admiral-api/revisions/3cf1ee58ce50?raw)