Skip to content

dns_transparent_forwarder

Overview

API to add, delete, get, modify transparent DNS forwarders

Version information

Version : v2

URI scheme

Host :
BasePath : /sdwan/nitro/v2/config_editor/
Schemes : HTTP

Tags

  • dns_transparent_forwarder : Operations related to dns_transparent_forwarder

Paths

POST operation for dns_transparent_forwarder

POST /dns_transparent_forwarder

Description

Use this operation to add the transparent DNS forwarder

Responses

HTTP Code Description Schema
200 Resource successfully added dns_transparent_forwarder_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

Produces

  • application/json

Tags

  • dns_transparent_forwarder

Get operation for dns_transparent_forwarder

GET /dns_transparent_forwarder

Description

Use this operation to get the transparent DNS forwarders configured

Responses

HTTP Code Description Schema
200 API Successfully executed dns_transparent_forwarder_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_transparent_forwarder

PUT operation for dns_transparent_forwarder

PUT /dns_transparent_forwarder

Description

Use this operation to modify transparent DNS forwarder rule

Parameters

Type Name Schema
Body body
optional
dns_transparent_forwarder_request_schema

Responses

HTTP Code Description Schema
200 Resource modified added dns_transparent_forwarder_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

Consumes

  • application/json

Produces

  • application/json

Tags

  • dns_transparent_forwarder

DELETE operation for dns_transparent_forwarder

DELETE /dns_transparent_forwarder/{deletePathParam}

Description

Use this operation to delete transparent transparent DNS forwarder configured

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_transparent_forwarder_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_transparent_forwarder

Definitions

ErrorSchema

Name Schema
errorcode
optional
integer
errormessage
optional
string

application_name

The name of the application used in the transparent forwarder

Type : string

dns_service_name

The name for the DNS service used in the transparent forwarder

Type : string

dns_transparent_forwarder

Name Schema
application_name
optional
application_name
dns_service_name
optional
dns_service_name
id
optional
id
order
optional
order
package_name
optional
package_name
site_name
optional
site_name

dns_transparent_forwarder_delete_success_schema

Name Schema
dns_transparent_forwarder
optional
dns_transparent_forwarder

dns_transparent_forwarder

Name Description Schema
message
optional
Example : "resource deleted succesfully" string

dns_transparent_forwarder_post_success_schema

Name Schema
dns_transparent_forwarder
optional
dns_transparent_forwarder

dns_transparent_forwarder

Name Description Schema
message
optional
Example : "resource added succesfully" string

dns_transparent_forwarder_put_success_schema

Name Schema
dns_transparent_forwarder
optional
dns_transparent_forwarder

dns_transparent_forwarder

Name Description Schema
message
optional
Example : "resource modified succesfully" string

dns_transparent_forwarder_request_schema

Name Schema
dns_transparent_forwarder
optional
dns_transparent_forwarder

dns_transparent_forwarder_response_schema

Type : < dns_transparent_forwarder_response_schema > array

dns_transparent_forwarder_response_schema

Name Schema
application_name
optional
application_name
dns_service_name
optional
dns_service_name
id
optional
id
is_auto
optional
is_auto
order
optional
order
package_name
optional
package_name
site_name
optional
site_name

id

Auto-generated ID to uniquely identify the DNS forwarder

Type : integer

is_auto

To indicate that this is auto-generated

Type : boolean

order

The tranparent DNS forwarder rule order

Type : integer

package_name

Config package name using which the API operation should be performed.

Type : string

site_name

Site Name

Type : string