Skip to content

Latest commit

 

History

History
66 lines (34 loc) · 3.82 KB

apis.md

File metadata and controls

66 lines (34 loc) · 3.82 KB

Backend APIs

The backend for the dashboard is node REST server that performs k8s calls on behalf of the frontend. The following are a list of current apis and there functionality.

Endpoints and methods

/builds

GET - Gets the list of current builds status. This returns an array of build status objects

/cluster-settings

GET - Retrieves the current cluster settings. This get returns a cluster settings object.

/cluster-settings/update

GET - Used to update the cluster settings. The url parameters for this get are each of the fields in the cluster settings object. Note that this GET will be updated to a POST in a future release.

/components

GET - Retrieves the list of installed components. The payload for this is an array of ODHApplication objects

/config

GET - Retrieves the dashboard config. This returns a Dashboard config object

/console

GET - Retrieves the list of console objects available for switching between apps. The returns an array of console link objects

/docs

GET - Retrieves the list of docs. The returns an array of document objects

/notebook

GET - Retrieves the list of notebooks. The returns an array of notebook objects

POST - Creates a notebook. The payload should be notebook object

/notebook/{notebook}

GET - Retrieves a specific notebook by it's id. This returns a single notebook object

DELETE - Deletes a specific notebook image using it's notebook id.

PUT - Updates a specific notebook by it's id. The payload should be the updated fields as shown in a notebook object

/quickstarts

GET - Retrieves the quick starts. This returns an array of QuickStart object

/segment-key

GET - Retrieves the segment key if tracking is enabled and a key is available. This returns a Segment Key object

/status

GET - Retrieves the current status of the odh dashboard application. This returns a Kube Status object

/validate-isv

GET - Use to validate if an ISV is enabled. Note that this should be updated to a put in a future release.

/validate-isv/results

GET - Retrieves the current status of an ISV.