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

Updated API Records (markdown)

Lukas Metzger 2018-01-05 17:01:14 +01:00
parent cd48ee3ba1
commit cc626cfe12
1 changed files with 80 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

80
API-Records.md

@ -36,3 +36,83 @@
]
}
```
## Create new record
`POST /records`
### Body
```json
{
"name": "dns.example.com",
"type": "A",
"content": "1.2.3.4",
"priority": 0,
"ttl": 86400
}
```
### Response
| code | result |
| --- | --- |
| 201 | Everything was successful, domain has been created |
| 422 | One of the required fields is missing |
```json
{
"id": 21,
"name": "dns.example.com",
"type": "A",
"content": "1.2.3.4",
"priority": 0,
"ttl": 86400
}
```
## Delete domain
`DELETE /records/{id}`
### Response
| code | result |
| --- | --- |
| 204 | Everything was successful, the answer body is therefore empty |
| 404 | The given record id does not exist |
## Get single record
`GET /record/{id}`
### Response
| code | result |
| --- | --- |
| 200 | Call was successful |
| 404 | The given record id does not exist |
```json
{
"id": 21,
"name": "dns.example.com",
"type": "A",
"content": "1.2.3.4",
"priority": 0,
"ttl": 86400
}
```
## Update record
`PUT /records/{id}`
### Body
```json
{
"name": "dns.example.com",
"type": "A",
"content": "1.2.3.4",
"priority": 0,
"ttl": 86400
}
```
### Response
| code | result |
| --- | --- |
| 204 | Everything was successful, the answer body is therefore empty |
| 404 | The given domain id does not exist |
| 422 | One of the required fields is missing |