Elgato_dark/zeppelin
1
0
Fork 0
mirror of https://github.com/apache/zeppelin synced 2026-05-24 09:38:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
zeppelin/docs/usage/rest_api/credential.md
cuspymd 9a6fac8b46 [ZEPPELIN-5341] Apply syntax highlight for sample JSON in REST API documents 
### What is this PR for?
Apply syntax highlight for sample JSON in REST API documents

### What type of PR is it?
[Documentation]

### What is the Jira issue?
* https://issues.apache.org/jira/browse/ZEPPELIN-5341

### How should this be tested?
* Checked updated documents locally

### Screenshots (if appropriate)
Before
![image](https://user-images.githubusercontent.com/8870299/116114020-f43f8780-a6f3-11eb-8d5f-7074adc307c0.png)

After
![image](https://user-images.githubusercontent.com/8870299/116114055-fc97c280-a6f3-11eb-9270-69795da0e82b.png)

### Questions:
* Does the licenses files need update? No
* Is there breaking changes for older versions? No
* Does this needs documentation? No

Author: cuspymd <cuspymd@gmail.com>

Closes #4101 from cuspymd/improve-rest-doc and squashes the following commits:

def642512 [cuspymd] Apply syntax highlight for sample JSON in REST API documents
2021-05-03 16:04:26 +08:00

4.1 KiB
Raw Permalink Blame History

layout title description group
page Apache Zeppelin Credential REST API This page contains Apache Zeppelin Credential REST API information. usage/rest_api

{% include JB/setup %}

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 
{
  "status": "OK"
}

### 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 
{"status":"OK"}

### 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 
{"status":"OK"}