dns_service¶
Overview¶
API to add, delete, get, modify DNS services
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/config_editor/
Schemes : HTTP
Tags¶
- dns_service : Operations related to dns_service
Paths¶
POST operation for dns_service¶
POST /dns_service
Description¶
Use this operation to add DNS service
Parameters¶
| Type | Name | Schema |
|---|---|---|
| Body | body optional |
dns_service_request_schema |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource successfully added | dns_service_post_success_schema |
| 400 | Failed: bad input parameter | ErrorSchema |
| 401 | Unauthorized: Failed Authentication | ErrorSchema |
| 403 | Unauthorized: Forbidden | ErrorSchema |
| 405 | Failed: Data format unacceptable | ErrorSchema |
| 415 | Failed: Data format unacceptable | ErrorSchema |
| 500 | Failed: Internal Server Error | ErrorSchema |
Consumes¶
application/json
Produces¶
application/json
Tags¶
- dns_service
Get operation for dns_service¶
GET /dns_service
Description¶
Use this operation to get the DNS services configured
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | dns_service_response_schema |
| 400 | Failed: bad input parameter | ErrorSchema |
| 401 | Unauthorized: Failed Authentication | ErrorSchema |
| 403 | Unauthorized: Forbidden | ErrorSchema |
| 405 | Failed: Data format unacceptable | ErrorSchema |
| 415 | Failed: Data format unacceptable | ErrorSchema |
| 500 | Failed: Internal Server Error | ErrorSchema |
Produces¶
application/json
Tags¶
- dns_service
PUT operation for dns_service¶
PUT /dns_service
Description¶
Use this operation to modify DNS services
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource modified added | dns_service_put_success_schema |
| 400 | Failed: bad input parameter | ErrorSchema |
| 401 | Unauthorized: Failed Authentication | ErrorSchema |
| 403 | Unauthorized: Forbidden | ErrorSchema |
| 405 | Failed: Data format unacceptable | ErrorSchema |
| 415 | Failed: Data format unacceptable | ErrorSchema |
| 500 | Failed: Internal Server Error | ErrorSchema |
Produces¶
application/json
Tags¶
- dns_service
DELETE operation for dns_service¶
DELETE /dns_service/{deletePathParam}
Description¶
Use this operation to delete DNS service
Parameters¶
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | deletePathParam required |
Object Primary Key for DELETE operation | object |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource delete added | dns_service_delete_success_schema |
| 400 | Failed: bad input parameter | ErrorSchema |
| 401 | Unauthorized: Failed Authentication | ErrorSchema |
| 403 | Unauthorized: Forbidden | ErrorSchema |
| 405 | Failed: Data format unacceptable | ErrorSchema |
| 415 | Failed: Data format unacceptable | ErrorSchema |
| 500 | Failed: Internal Server Error | ErrorSchema |
Produces¶
application/json
Tags¶
- dns_service
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
dns_service¶
| Name | Schema |
|---|---|
| dns_service_name optional |
dns_service_name |
| id optional |
id |
| package_name optional |
package_name |
| primary_dns_server_ip optional |
primary_dns_server_ip |
| secondary_dns_server_ip optional |
secondary_dns_server_ip |
dns_service_delete_success_schema¶
| Name | Schema |
|---|---|
| dns_service optional |
dns_service |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
dns_service_name¶
The name for the DNS service
Type : string
dns_service_post_success_schema¶
| Name | Schema |
|---|---|
| dns_service optional |
dns_service |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
dns_service_put_success_schema¶
| Name | Schema |
|---|---|
| dns_service optional |
dns_service |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
dns_service_request_schema¶
| Name | Schema |
|---|---|
| dns_service optional |
dns_service |
dns_service_response_schema¶
Type : < dns_service_response_schema > array
| Name | Schema |
|---|---|
| dns_service_name optional |
dns_service_name |
| id optional |
id |
| is_auto optional |
is_auto |
| package_name optional |
package_name |
| primary_dns_server_ip optional |
primary_dns_server_ip |
| secondary_dns_server_ip optional |
secondary_dns_server_ip |
id¶
Auto-generated ID to uniquely identify the DNS service
Type : integer
is_auto¶
to indicate that this is auto-generated
Type : boolean
package_name¶
Config package name using which the API operation should be performed.
Type : string
primary_dns_server_ip¶
The IP Address of the Primary DNS server
Type : string
secondary_dns_server_ip¶
The IP Address of the secondary DNS server
Type : string