# stop

## Overview

This endpoint is used for programmatically stopping a (running) notebook within a workflow. Will return an InvalidRequest error if the transform is not queued or running.

## HTTP Request

```http
POST /api/v1/notebooks/:notebookReference/stop
```

## Path parameters

<table><thead><tr><th width="302.5">Parameter</th><th></th></tr></thead><tbody><tr><td>notebookReference</td><td>A qualified reference to the notebook. See <a href="../../referencing-resources">referencing resources</a> for more information.</td></tr></tbody></table>

{% hint style="info" %}
This endpoint extends the [general API structure](https://docs.redivis.com/api/rest-api/general-structure)
{% endhint %}

## Request body

The request body for this endpoint should be empty

## Authorization

Edit access to the dataset is required. Your access token must have the following scope:

* workflow\.write

[Learn more about authorization.](https://docs.redivis.com/api/rest-api/authorization)

## Response body

Returns the JSON-encoded "get" representation of a [notebook resource](https://docs.redivis.com/api/resource-definitions/notebook).