Rename a Jupyter Notebook or Directory

PATCH /api/v1.2/jupyter_notebooks/contents/<Path>/<Name>

Use this API to rename a Jupyter notebook or a directory.

Note

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

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 the Jupyter notebook to be renamed.
Name	Name of the Jupyter notebook with extension (`.ipynb`) or directory. It is a string that can accept alpha-numerical characters and the following special characters: `+`, `-`, `_`, `@`, and `\|`.

Parameters

Parameter	Description
path	New path and new name of the Jupyter notebook to be renamed including the extension(.ipynb).

Request API Syntax

curl -i -X PATCH -H "X-AUTH-TOKEN: <token>" -H "Content-Type: application/json" -H "Accept: application/json" -d '{"path": "<NewPath>/<NewName>"}' \
 "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 PATCH -H "X-AUTH-TOKEN: $AUTH_TOKEN" -H "Content-Type: application/json" -H "Accept: application/json" -d '{"path": "Users/[email protected]/rename_note1.ipynb"}' \
 "https://api.qubole.com/api/v1.2/jupyter_notebooks/contents/Users/[email protected]/note1.ipynb"