List Dashboards

GET /api/v1.2/notebooks/<note_id>/list_dashboards

Use this API to list dashboards for a notebook. To view all the dashboards associated with the notebook using the Notebooks UI, see Viewing All Dashboards.

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 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

note_id

Id of the notebook for which the dashboards have to be listed.

Request API Syntax

curl -X GET  -H 'X-AUTH-TOKEN: <AUTH TOKEN>'  -H 'Content-Type: application/json'  -H 'Accept: application/json'
"https://api.qubole.com/api/v1.2/notebooks/<note_id>/list_dashboards"

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 -X GET  -H 'X-AUTH-TOKEN: <AUTH TOKEN>'  -H 'Content-Type: application/json'  -H 'Accept: application/json'
"https://api.qubole.com/api/v1.2/notebooks/97480/list_dashboards"