# stop_publish

Source: https://modulify.ai/docs/api/publishing/stop-publish

Stops a publish that is still running, so nothing from it reaches the live site.

- Title: Stop a publish that is running
- Scope: `publish:write`
- Access: Destructive
- Endpoint: `POST /v1/stop_publish`

The build is abandoned, its machines are torn down and the deployment is recorded as `cancelled`. Whatever was already published stays up untouched. Leave out `deploymentId` to stop whatever is running now.

A publish whose status has reached `deploying` is switching traffic over and can no longer be stopped. It is refused with `This publish is already going live and can no longer be stopped!` rather than half-canceled, and with nothing running the call answers `There is no publish running to stop!` See [Stopping a publish](https://modulify.ai/docs/publish/publish-a-site#stopping-a-publish).

## Request

Call it with a `POST` to `https://api.modulify.ai/v1/stop_publish`, sending the inputs below as a JSON object. The token needs the `publish:write` scope.

> **Warning**
>
> This method is marked destructive: it deletes or overwrites data. Check the inputs before you call it, and send an [Idempotency-Key](https://modulify.ai/docs/api/idempotency) header whenever you might retry it.

```bash
curl -X POST https://api.modulify.ai/v1/stop_publish \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"projectId":"PROJECT_ID"}'
```

Over MCP, the same method is the [stop_publish tool](https://modulify.ai/docs/mcp/publishing/stop-publish).

## Inputs

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `projectId` | string | Yes | The site id. |
| `deploymentId` | string | No | A specific publish to stop. Leave it out for whatever is running now. |

## Response

Every call answers with the [JSON envelope](https://modulify.ai/docs/api/requests-and-responses#the-response) of `success`, `message`, `data`, `code` and `version`. `data` holds the result described above, and on a method that returns a total, `count` carries it. The [response headers](https://modulify.ai/docs/api/requests-and-responses#headers-on-every-method-call) carry the call's `X-Request-Id` and what is left of your per-minute budget in `X-RateLimit-Limit`, `X-RateLimit-Remaining` and `X-RateLimit-Reset`. [Errors](https://modulify.ai/docs/api/errors) explains every status code a call can answer with.