v5.0_DNS
- Ramya Raman
Returns a list of all DNS in the system, with its main configuration data.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/dns/config
Example Request
GET
{
"data": [
{
"uuid": "498501a9-2327-4ab3-bf2c-ae2f2e1ff32c",
"label": "Google",
"groups": [],
"created": "2022-03-17T09:00:36.671Z",
"modified": "2022-03-20T13:52:55.298Z",
"host": "8.8.8.8"
},
{
"uuid": "26e417a8-1249-4b63-b5bd-4ce27c2b6fad",
"label": "new_DNS",
"groups": [
"grp1"
],
"created": "2022-03-17T10:33:40.319Z",
"modified": "2022-03-23T10:49:41.382Z",
"host": "1.1.1.1"
}
],
"metadata": {
"item_count": 2,
"total_items": 2,
"current_page": 1,
"sort_by": [
{
"field": "label",
"direction": "ASC"
}
],
"links": {
"current": "http://192.168.10.53/api/5.0/dns/config"
}
}
}
GET dns/config/{uuid}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | GET |
Returns an extended single DNS configuration view, specified by the required {uuid} parameter.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/dns/config/{{uuid}}
Parameters
Parameter | Data Type | Description |
|---|---|---|
uuid | string | The UUID of the desired dns. |
Example Request
GET
{
"data": {
"uuid": "26e417a8-1249-4b63-b5bd-4ce27c2b6fad",
"label": "new_DNS",
"groups": [
"grp1"
],
"created": "2022-03-17T10:33:40.319Z",
"modified": "2022-03-23T10:49:41.382Z",
"host": "1.1.1.1"
},
"metadata": {}
}
DELETE dns/config/{uuid}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | DELETE |
Delete a specific DNS configuration.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/dns/config/{{uuid}}
Parameters
Parameter | Data Type | Description |
|---|---|---|
uuid | string | The UUID of the DNS to be deleted. |
Example Request
DELETE
{
"data": {
"success": true
},
"metadata": {}
}
PUT dns/config/{uuid}
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | PUT |
Edit a DNS configuration.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/dns/config/{{uuid}}
Parameters
Parameter | Data Type | Description |
|---|---|---|
uuid | string | The UUID of the DNS to be edited. |
Example Request
PUT
Body
Response
Add a new dns, configured according to the attached data request.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/dns/config
Example Request
POST
Body
Response
POST dns/config multi
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | POST |
Add multiple dns, configured according to the attached data request.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/dns/config
Example Request
POST
Body
Response
PUT dns/config multi
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | PUT |
Edit multiple dns, configured according to the attached data request.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/dns/config
Example Request
POST
Body
Response
DELETE dns/config multi
Resource Information
Requires Authentication? | |
Response Formats | json |
HTTP Methods | DELETE |
Delete multiple DNS configuration.
Resource URL
https://{{ip_address}}:{{port}}/api/{{version}}/dns/config
Example Request
DELETE
Body
Response