Create a Folder¶
-
POST/api/v1.2/folders/¶
Use this API to create a notebook or dashboard folder. For more information, see Using Folders in Notebooks and Dashboards.
Required Role¶
The following users can make this API call:
- Users who belong to the system-admin or system-user group.
- Users who belong to a group associated with a role that allows submitting a command. See Managing Groups and Managing Roles for more information.
Parameters¶
Note
Parameters marked in bold below are mandatory. Others are optional and have default values.
| Parameter | Description |
|---|---|
| name | It is the name of the folder. It is a string and can accept alpha-numerical characters. |
| location | It is the location of the folder. By default, it goes to Users/current_user_email_id folders. For more information on notebook folders, see Using Folders in Notebooks. The accepted folder locations are: Users/current_user_email_id, Common, and Users/other_user_email_id based on permissions. The default location is Users/current_user_email_id and it is equivalent to My Home on the Notebooks UI. You need privileges to create/edit notebooks in Common and Users/other_user_email_id. For more information, see Managing Folder-level Permissions. |
| type | It denotes if the type is Notebooks or Dashboards. Its value must be notes for a Notebook folder
and notebook_dashboards for a Dashboard folder. |
Request API Syntax¶
curl -i -X POST -H "X-AUTH-TOKEN: $AUTH_TOKEN" -H "Content-Type: application/json" -H "Accept: application/json" \
-d '{"name":"<Name>", "location":"<Location>", "type": "<notes/notebook_dashboards>"}' \ "https://gcp.qubole.com/api/v1.2/folders"
Sample API Requests¶
Here is an example to create a notebook folder.
curl -i -X POST -H "X-AUTH-TOKEN: $AUTH_TOKEN" -H "Content-Type: application/json" -H "Accept: application/json" \
-d '{"name":"Folder1", "location":"Users/[email protected]/Notebooks", "type": "notes"}' \ "https://gcp.qubole.com/api/v1.2/folders"
Here is an example to create a Dashboard folder.
curl -i -X POST -H "X-AUTH-TOKEN: $AUTH_TOKEN" -H "Content-Type: application/json" -H "Accept: application/json" \
-d '{"name":"Folder1", "location":"Users/[email protected]/DashboardUser", "type": "notebook_dashboards"}' \ "https://gcp.qubole.com/api/v1.2/folders"