dns_proxy¶
Overview¶
API to add, modify, delete, and get configuration for dns proxy
Version information¶
Version : v2
URI scheme¶
Host :
BasePath : /sdwan/nitro/v2/config_editor/
Schemes : HTTP
Tags¶
- dns_proxy : Operations related to dns_proxy
Paths¶
POST operation for dns_proxy¶
POST /dns_proxy
Description¶
Use this operation to add the DNS proxy
Parameters¶
| Type | Name | Schema |
|---|---|---|
| Body | body optional |
dns_proxy_request_schema |
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource successfully added | dns_proxy_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_proxy
Get operation for dns_proxy¶
GET /dns_proxy
Description¶
Use this operation to get the DNS proxy configuration
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | API Successfully executed | dns_proxy_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_proxy
PUT operation for dns_proxy¶
PUT /dns_proxy
Description¶
Use this operation to modify the DNS proxy
Responses¶
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Resource modified added | dns_proxy_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_proxy
DELETE operation for dns_proxy¶
DELETE /dns_proxy/{deletePathParam}
Description¶
Use this operation to delete the DNS proxy
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_proxy_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_proxy
Definitions¶
ErrorSchema¶
| Name | Schema |
|---|---|
| errorcode optional |
integer |
| errormessage optional |
string |
default_dns_service¶
Type : string
dns_forwarder¶
The DNS service name
Type : < dns_forwarder > array
| Name | Description | Schema |
|---|---|---|
| application_name optional |
Application Name or Custom domain created | string |
| dns_service_name optional |
The DNS service name | string |
| id optional |
Auto-generated ID to uniquely identify application object | integer |
| is_auto optional read-only |
to indicate that this is auto-generated | boolean |
| order optional |
The DNS forwarder rule order | integer |
dns_proxy¶
| Name | Schema |
|---|---|
| default_dns_service optional |
default_dns_service |
| dns_forwarder optional |
dns_forwarder |
| dns_proxy_interface optional |
dns_proxy_interface |
| dns_proxy_name optional |
dns_proxy_name |
| id optional |
id |
| package_name optional |
package_name |
| site_name optional |
site_name |
dns_proxy_delete_success_schema¶
| Name | Schema |
|---|---|
| dns_proxy optional |
dns_proxy |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource deleted succesfully" |
string |
dns_proxy_interface¶
The Virtual Interface Name
Type : < dns_proxy_interface > array
| Name | Description | Schema |
|---|---|---|
| dns_proxy_interface_name optional |
The name of the dns proxy virtual interface | string |
| id optional |
Auto-generated ID to uniquely identify the Virtual interface name | integer |
dns_proxy_name¶
The name of the DNS proxy
Type : string
dns_proxy_post_success_schema¶
| Name | Schema |
|---|---|
| dns_proxy optional |
dns_proxy |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource added succesfully" |
string |
dns_proxy_put_success_schema¶
| Name | Schema |
|---|---|
| dns_proxy optional |
dns_proxy |
| Name | Description | Schema |
|---|---|---|
| message optional |
Example : "resource modified succesfully" |
string |
dns_proxy_request_schema¶
| Name | Schema |
|---|---|
| dns_proxy optional |
dns_proxy |
dns_proxy_response_schema¶
Type : < dns_proxy_response_schema > array
| Name | Schema |
|---|---|
| default_dns_service optional |
default_dns_service |
| dns_forwarder optional |
dns_forwarder |
| dns_proxy_interface optional |
dns_proxy_interface |
| dns_proxy_name optional |
dns_proxy_name |
| id optional |
id |
| package_name optional |
package_name |
| site_name optional |
site_name |
id¶
Object id for DNS proxy
Type : integer
package_name¶
Package name to be used for the API operations
Type : string
site_name¶
Site Name to add DNS proxy
Type : string