/notebook

get
list notebooks

https://xxxx.yyyy.zzzz.com/notebook/{workspace}
This route lists all running notebooks within kaos.
Request
Response
Request
Path Parameters
workspace
required
string
selected workspace
Response
200: OK

post
create notebooks

https://xxxx.yyyy.zzzz.com/notebook/{workspace}
This route creates a new notebook instance.
Request
Response
Request
Path Parameters
workspace
required
string
selected workspace
Query Parameters
user
optional
string
user for tracking ownership of notebook
Body Parameters
data
required
string
binary source bundle
Response
200: OK

post
get build logs

https://xxxx.yyyy.zzzz.com/notebook/{workspace}/build/{job_id}/logs
This route provides access to logs from building the source notebook image.
Request
Response
Request
Path Parameters
workspace
required
string
selected workspace
job_id
required
string
selected building job_id
Response
200: OK

delete
remove notebook

https://xxxx.yyyy.zzzz.com/notebook/{notebook_name}
This route deletes a running notebook instance.
Request
Response
Request
Path Parameters
notebook_name
required
string
selected notebook name
Response
200: OK