Delete a Jupyter Notebook or Directory

DELETE /api/v1.2/jupyter_notebooks/contents/<Path>/<Name>

Use this API to delete a Jupyter notebook or directory. Before deleting a jupyter notebook, you must ensure that the notebook does not have any active command or active schedules associated with the notebook.

Note

This API is not available by default. Create a ticket with Qubole Support to enable this API on your QDS account.

Note

You can delete only empty directories.

Required Role

The following users can make this API call:

  • Users who belong to the system-user or system-admin group.

  • Users who belong to a group associated with a role that allows update on Jupyter Notebook and directory. See Managing Groups and Managing Roles for more information.

Path Parameters

Parameter

Description

Path

Location of Jupyter notebook or directory.

Name

Name of the Jupyter notebook with extension(.ipynb) or directory.

Request API Syntax

curl -i -X DELETE -H "X-AUTH-TOKEN: <token>" -H "Content-Type: application/json" -H "Accept: application/json" \
"https://api.qubole.com/api/v1.2/jupyter_notebooks/contents/<Path>/<Name>"

Note

The above syntax uses https://api.qubole.com as the endpoint. Qubole provides other endpoints to access QDS that are described in Supported Qubole Endpoints on Different Cloud Providers.

Sample API Request

curl -i -X DELETE -H "X-AUTH-TOKEN: $AUTH_TOKEN" -H "Content-Type: application/json" -H "Accept: application/json" \
"https://api.qubole.com/api/v1.2/jupyter_notebooks/contents/Users/[email protected]/note1.ipynb"