Apache Zeppelin Credential REST API
Overview
Apache Zeppelin provides several REST APIs for interaction and remote activation of zeppelin functionality.
All REST APIs are available starting with the following endpoint http://[zeppelin-server]:[zeppelin-port]/api
.
Note that Apache Zeppelin REST APIs receive or return JSON objects, it is recommended for you to install some JSON viewers such as JSONView.
If you work with Apache Zeppelin and find a need for an additional REST API, please file an issue or send us an email.
Credential REST API List
List Credential information
Description |
This GET method returns all key/value pairs of the credential information on the server. |
URL |
http://[zeppelin-server]:[zeppelin-port]/api/credential |
Success code |
200 |
Fail code |
500 |
sample JSON response
|
{
"status": "OK",
"message": "",
"body": {
"userCredentials":{
"entity1":{
"username":"user1",
"password":"password1"
},
"entity2":{
"username":"user2",
"password":"password2"
}
}
}
}
|
Create an Credential Information
Description |
This PUT method creates the credential information with new properties. |
URL |
http://[zeppelin-server]:[zeppelin-port]/api/credential/ |
Success code |
200 |
Fail code |
500 |
Sample JSON input |
{
"entity": "e1",
"username": "user",
"password": "password"
}
|
Sample JSON response |
|
Delete all Credential Information
Description |
This DELETE method deletes the credential information. |
URL |
http://[zeppelin-server]:[zeppelin-port]/api/credential |
Success code |
200 |
Fail code |
500 |
Sample JSON response |
|
Delete an Credential entity
Description |
This DELETE method deletes a given credential entity. |
URL |
http://[zeppelin-server]:[zeppelin-port]/api/credential/[entity] |
Success code |
200 |
Fail code |
500 |
Sample JSON response |
|