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

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

Path parameters

Parameter
notebookReference	A qualified reference to the notebook. See referencing resources for more information.

This endpoint extends the general API structure

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.

Response body

Returns the JSON-encoded "get" representation of a notebook resource.