deblan/pdnsmanager
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Updated API Functions (markdown)

Lukas Metzger 2018-01-05 16:06:41 +01:00
parent 77b4394d96
commit 41609ccb06
1 changed files with 7 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
API-Functions.md

@ -6,7 +6,13 @@
* Search functions are executed as a GET request with URL parameters.
* API functions that return data do so via json objects.
* API fucntions that accept data do so via json objects in the request body.
* API functions do not return a Success or error state, this information is passed by the HTTP Status Code.
API results should be indicated with the matching HTTP status code. Specific codes are described next to the API, but here are some general errors.
| code | result |
| --- | --- |
| 400 | The provided request is invalid, can be invalid json, or missing fields |
| 403 | Either no authentication headers are supplied or the user has not enough permissions |
# API Functions