Updated API Setup (markdown)
parent
3db787f5d3
commit
ee1a2cb0cb
40
API-Setup.md
40
API-Setup.md
|
@ -1 +1,39 @@
|
||||||
Setup api
|
# Setup
|
||||||
|
|
||||||
|
This API is only used for the initial setup.
|
||||||
|
|
||||||
|
## Get list of users
|
||||||
|
`POST /setup`
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"db": {
|
||||||
|
"host": "localhost",
|
||||||
|
"user": "pdns",
|
||||||
|
"password": "pdns",
|
||||||
|
"database": "localhost",
|
||||||
|
"port": 3306
|
||||||
|
},
|
||||||
|
"admin": {
|
||||||
|
"name": "initaladmin",
|
||||||
|
"password: "foo"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Response
|
||||||
|
| code | result |
|
||||||
|
| --- | --- |
|
||||||
|
| 204 | Everything was successful the answer is therefore empty |
|
||||||
|
| 400 | The supplied body was empty |
|
||||||
|
| 404 | If the application has already been setup |
|
||||||
|
| 422 | One of the required fields is missing |
|
||||||
|
| 500 | Error on setup, message in data! |
|
||||||
|
|
||||||
|
If an error occurred a message is returned.
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"error": "Error message!"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
Loading…
Reference in a new issue