netgate-unbound API (24.02)

This YANG module provides a data-model for the Unbound service.

unbound-config

returns netgate.unbound.UnboundConfig

get /data/netgate-unbound:unbound-config

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config

Configuration for the Unbound DNS name resolver daemon.

Responses

200

netgate.unbound.UnboundConfig

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-unbound:unbound-config"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-unbound:unbound-config-wrapper":
{
- "netgate-unbound:unbound-config":
  {
  - "parameters":
    {
    "enable": false
    },
  - "daemon":
    {
    "forward-zones":
    {
    "zone":
    [
    {
    "forward-addresses":
    {
    "address":
    [
    {
    "auth-name": "string",
    "ip-address": "string",
    "port": 0
    }
    ]
    },
    "forward-hosts":
    {
    "host":
    [
    "string"
    ]
    },
    "forward-first": false,
    "forward-tls-upstream": false,
    "zone-name": "string"
    }
    ]
    },
    "server":
    {
    "num-queries-per-thread": 0,
    "outgoing-range": 4096,
    "prefetch": false,
    "serve-expired": false,
    "do-tcp": true,
    "harden-dnssec-stripped": false,
    "cache-min-ttl": 0,
    "msg-cache-size": 0,
    "incoming-num-tcp": 0,
    "use-caps-for-id": false,
    "unwanted-reply-threshold": 0,
    "edns-buffer-size": 0,
    "outgoing-num-tcp": 0,
    "local-zones":
    {
    "zone":
    [
    {
    "description": "string",
    "type": "deny",
    "hosts":
    {
    "host":
    [
    {
    "description": "string",
    "ip-address":
    [
    "string"
    ],
    "host-name": "string"
    }
    ]
    },
    "zone-name": "string"
    }
    ]
    },
    "outgoing-interfaces":
    {
    "ip-address":
    [
    "string"
    ]
    },
    "rrset-cache-size": 0,
    "access-control":
    {
    "access":
    [
    {
    "action": "allow",
    "ip-prefix": "string"
    }
    ]
    },
    "jostle-timeout": 0,
    "interfaces":
    {
    "interface":
    [
    {
    "port": 0,
    "ip-address": "string"
    }
    ]
    },
    "rrset-cache-slabs": 0,
    "infra-host-ttl": 0,
    "do-udp": true,
    "num-threads": 0,
    "cache-max-ttl": 0,
    "harden-glue": true,
    "infra-cache-numhosts": 0,
    "so-rcvbuf": 0,
    "infra-cache-slabs": 0,
    "port": 0,
    "key-cache-slabs": 0,
    "do-ip6": false,
    "do-ip4": true,
    "verbosity": 0,
    "msg-cache-slabs": 0,
    "prefetch-key": false,
    "hide-version": false,
    "hide-identity": true
    }
    }
  }
}

}

creates netgate.unbound.UnboundConfig

post /data/netgate-unbound:unbound-config

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config

Configuration for the Unbound DNS name resolver daemon.

Request Body schema: application/yang-data+json

netgate.unbound.UnboundConfig to be added to list

netgate-unbound:unbound-config

object (netgate.unbound.UnboundConfig)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-unbound:unbound-config":
{
- "parameters":
  {
  - "enable": false
  },
- "daemon":
  {
  - "forward-zones":
    {
    "zone":
    [
    {
    "forward-addresses":
    {
    "address":
    [
    {
    "auth-name": "string",
    "ip-address": "string",
    "port": 0
    }
    ]
    },
    "forward-hosts":
    {
    "host":
    [
    "string"
    ]
    },
    "forward-first": false,
    "forward-tls-upstream": false,
    "zone-name": "string"
    }
    ]
    },
  - "server":
    {
    "num-queries-per-thread": 0,
    "outgoing-range": 4096,
    "prefetch": false,
    "serve-expired": false,
    "do-tcp": true,
    "harden-dnssec-stripped": false,
    "cache-min-ttl": 0,
    "msg-cache-size": 0,
    "incoming-num-tcp": 0,
    "use-caps-for-id": false,
    "unwanted-reply-threshold": 0,
    "edns-buffer-size": 0,
    "outgoing-num-tcp": 0,
    "local-zones":
    {
    "zone":
    [
    {
    "description": "string",
    "type": "deny",
    "hosts":
    {
    "host":
    [
    {
    "description": "string",
    "ip-address":
    [
    "string"
    ],
    "host-name": "string"
    }
    ]
    },
    "zone-name": "string"
    }
    ]
    },
    "outgoing-interfaces":
    {
    "ip-address":
    [
    "string"
    ]
    },
    "rrset-cache-size": 0,
    "access-control":
    {
    "access":
    [
    {
    "action": "allow",
    "ip-prefix": "string"
    }
    ]
    },
    "jostle-timeout": 0,
    "interfaces":
    {
    "interface":
    [
    {
    "port": 0,
    "ip-address": "string"
    }
    ]
    },
    "rrset-cache-slabs": 0,
    "infra-host-ttl": 0,
    "do-udp": true,
    "num-threads": 0,
    "cache-max-ttl": 0,
    "harden-glue": true,
    "infra-cache-numhosts": 0,
    "so-rcvbuf": 0,
    "infra-cache-slabs": 0,
    "port": 0,
    "key-cache-slabs": 0,
    "do-ip6": false,
    "do-ip4": true,
    "verbosity": 0,
    "msg-cache-slabs": 0,
    "prefetch-key": false,
    "hide-version": false,
    "hide-identity": true
    }
  }
}

}

creates or updates netgate.unbound.UnboundConfig

put /data/netgate-unbound:unbound-config

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config

Configuration for the Unbound DNS name resolver daemon.

Request Body schema: application/yang-data+json

netgate.unbound.UnboundConfig to be added or updated

netgate-unbound:unbound-config-wrapper

object (netgate.unbound.UnboundConfigWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-unbound:unbound-config-wrapper":
{
- "netgate-unbound:unbound-config":
  {
  - "parameters":
    {
    "enable": false
    },
  - "daemon":
    {
    "forward-zones":
    {
    "zone":
    [
    {
    "forward-addresses":
    {
    "address":
    [
    {
    "auth-name": "string",
    "ip-address": "string",
    "port": 0
    }
    ]
    },
    "forward-hosts":
    {
    "host":
    [
    "string"
    ]
    },
    "forward-first": false,
    "forward-tls-upstream": false,
    "zone-name": "string"
    }
    ]
    },
    "server":
    {
    "num-queries-per-thread": 0,
    "outgoing-range": 4096,
    "prefetch": false,
    "serve-expired": false,
    "do-tcp": true,
    "harden-dnssec-stripped": false,
    "cache-min-ttl": 0,
    "msg-cache-size": 0,
    "incoming-num-tcp": 0,
    "use-caps-for-id": false,
    "unwanted-reply-threshold": 0,
    "edns-buffer-size": 0,
    "outgoing-num-tcp": 0,
    "local-zones":
    {
    "zone":
    [
    {
    "description": "string",
    "type": "deny",
    "hosts":
    {
    "host":
    [
    {
    "description": "string",
    "ip-address":
    [
    "string"
    ],
    "host-name": "string"
    }
    ]
    },
    "zone-name": "string"
    }
    ]
    },
    "outgoing-interfaces":
    {
    "ip-address":
    [
    "string"
    ]
    },
    "rrset-cache-size": 0,
    "access-control":
    {
    "access":
    [
    {
    "action": "allow",
    "ip-prefix": "string"
    }
    ]
    },
    "jostle-timeout": 0,
    "interfaces":
    {
    "interface":
    [
    {
    "port": 0,
    "ip-address": "string"
    }
    ]
    },
    "rrset-cache-slabs": 0,
    "infra-host-ttl": 0,
    "do-udp": true,
    "num-threads": 0,
    "cache-max-ttl": 0,
    "harden-glue": true,
    "infra-cache-numhosts": 0,
    "so-rcvbuf": 0,
    "infra-cache-slabs": 0,
    "port": 0,
    "key-cache-slabs": 0,
    "do-ip6": false,
    "do-ip4": true,
    "verbosity": 0,
    "msg-cache-slabs": 0,
    "prefetch-key": false,
    "hide-version": false,
    "hide-identity": true
    }
    }
  }
}

}

removes netgate.unbound.UnboundConfig

delete /data/netgate-unbound:unbound-config

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config

Configuration for the Unbound DNS name resolver daemon.

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-unbound:unbound-config"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns netgate.unbound.unboundconfig.Daemon

get /data/netgate-unbound:unbound-config/daemon

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon

The server attributes.

Responses

200

netgate.unbound.unboundconfig.Daemon

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-unbound:unbound-config/daemon"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-unbound:daemon-wrapper":
{
- "daemon":
  {
  - "forward-zones":
    {
    "zone":
    [
    {
    "forward-addresses":
    {
    "address":
    [
    {
    "auth-name": "string",
    "ip-address": "string",
    "port": 0
    }
    ]
    },
    "forward-hosts":
    {
    "host":
    [
    "string"
    ]
    },
    "forward-first": false,
    "forward-tls-upstream": false,
    "zone-name": "string"
    }
    ]
    },
  - "server":
    {
    "num-queries-per-thread": 0,
    "outgoing-range": 4096,
    "prefetch": false,
    "serve-expired": false,
    "do-tcp": true,
    "harden-dnssec-stripped": false,
    "cache-min-ttl": 0,
    "msg-cache-size": 0,
    "incoming-num-tcp": 0,
    "use-caps-for-id": false,
    "unwanted-reply-threshold": 0,
    "edns-buffer-size": 0,
    "outgoing-num-tcp": 0,
    "local-zones":
    {
    "zone":
    [
    {
    "description": "string",
    "type": "deny",
    "hosts":
    {
    "host":
    [
    {
    "description": "string",
    "ip-address":
    [
    "string"
    ],
    "host-name": "string"
    }
    ]
    },
    "zone-name": "string"
    }
    ]
    },
    "outgoing-interfaces":
    {
    "ip-address":
    [
    "string"
    ]
    },
    "rrset-cache-size": 0,
    "access-control":
    {
    "access":
    [
    {
    "action": "allow",
    "ip-prefix": "string"
    }
    ]
    },
    "jostle-timeout": 0,
    "interfaces":
    {
    "interface":
    [
    {
    "port": 0,
    "ip-address": "string"
    }
    ]
    },
    "rrset-cache-slabs": 0,
    "infra-host-ttl": 0,
    "do-udp": true,
    "num-threads": 0,
    "cache-max-ttl": 0,
    "harden-glue": true,
    "infra-cache-numhosts": 0,
    "so-rcvbuf": 0,
    "infra-cache-slabs": 0,
    "port": 0,
    "key-cache-slabs": 0,
    "do-ip6": false,
    "do-ip4": true,
    "verbosity": 0,
    "msg-cache-slabs": 0,
    "prefetch-key": false,
    "hide-version": false,
    "hide-identity": true
    }
  }
}

}

creates netgate.unbound.unboundconfig.Daemon

post /data/netgate-unbound:unbound-config/daemon

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon

The server attributes.

Request Body schema: application/yang-data+json

netgate.unbound.unboundconfig.Daemon to be added to list

daemon

object (netgate.unbound.unboundconfig.Daemon)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"daemon":
{
- "forward-zones":
  {
  - "zone":
    [
    {
    "forward-addresses":
    {
    "address":
    [
    {
    "auth-name": "string",
    "ip-address": "string",
    "port": 0
    }
    ]
    },
    "forward-hosts":
    {
    "host":
    [
    "string"
    ]
    },
    "forward-first": false,
    "forward-tls-upstream": false,
    "zone-name": "string"
    }
    ]
  },
- "server":
  {
  - "num-queries-per-thread": 0,
  - "outgoing-range": 4096,
  - "prefetch": false,
  - "serve-expired": false,
  - "do-tcp": true,
  - "harden-dnssec-stripped": false,
  - "cache-min-ttl": 0,
  - "msg-cache-size": 0,
  - "incoming-num-tcp": 0,
  - "use-caps-for-id": false,
  - "unwanted-reply-threshold": 0,
  - "edns-buffer-size": 0,
  - "outgoing-num-tcp": 0,
  - "local-zones":
    {
    "zone":
    [
    {
    "description": "string",
    "type": "deny",
    "hosts":
    {
    "host":
    [
    {
    "description": "string",
    "ip-address":
    [
    "string"
    ],
    "host-name": "string"
    }
    ]
    },
    "zone-name": "string"
    }
    ]
    },
  - "outgoing-interfaces":
    {
    "ip-address":
    [
    "string"
    ]
    },
  - "rrset-cache-size": 0,
  - "access-control":
    {
    "access":
    [
    {
    "action": "allow",
    "ip-prefix": "string"
    }
    ]
    },
  - "jostle-timeout": 0,
  - "interfaces":
    {
    "interface":
    [
    {
    "port": 0,
    "ip-address": "string"
    }
    ]
    },
  - "rrset-cache-slabs": 0,
  - "infra-host-ttl": 0,
  - "do-udp": true,
  - "num-threads": 0,
  - "cache-max-ttl": 0,
  - "harden-glue": true,
  - "infra-cache-numhosts": 0,
  - "so-rcvbuf": 0,
  - "infra-cache-slabs": 0,
  - "port": 0,
  - "key-cache-slabs": 0,
  - "do-ip6": false,
  - "do-ip4": true,
  - "verbosity": 0,
  - "msg-cache-slabs": 0,
  - "prefetch-key": false,
  - "hide-version": false,
  - "hide-identity": true
  }
}

}

creates or updates netgate.unbound.unboundconfig.Daemon

put /data/netgate-unbound:unbound-config/daemon

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon

The server attributes.

Request Body schema: application/yang-data+json

netgate.unbound.unboundconfig.Daemon to be added or updated

netgate-unbound:daemon-wrapper

object (netgate.unbound.unboundconfig.DaemonWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-unbound:daemon-wrapper":
{
- "daemon":
  {
  - "forward-zones":
    {
    "zone":
    [
    {
    "forward-addresses":
    {
    "address":
    [
    {
    "auth-name": "string",
    "ip-address": "string",
    "port": 0
    }
    ]
    },
    "forward-hosts":
    {
    "host":
    [
    "string"
    ]
    },
    "forward-first": false,
    "forward-tls-upstream": false,
    "zone-name": "string"
    }
    ]
    },
  - "server":
    {
    "num-queries-per-thread": 0,
    "outgoing-range": 4096,
    "prefetch": false,
    "serve-expired": false,
    "do-tcp": true,
    "harden-dnssec-stripped": false,
    "cache-min-ttl": 0,
    "msg-cache-size": 0,
    "incoming-num-tcp": 0,
    "use-caps-for-id": false,
    "unwanted-reply-threshold": 0,
    "edns-buffer-size": 0,
    "outgoing-num-tcp": 0,
    "local-zones":
    {
    "zone":
    [
    {
    "description": "string",
    "type": "deny",
    "hosts":
    {
    "host":
    [
    {
    "description": "string",
    "ip-address":
    [
    "string"
    ],
    "host-name": "string"
    }
    ]
    },
    "zone-name": "string"
    }
    ]
    },
    "outgoing-interfaces":
    {
    "ip-address":
    [
    "string"
    ]
    },
    "rrset-cache-size": 0,
    "access-control":
    {
    "access":
    [
    {
    "action": "allow",
    "ip-prefix": "string"
    }
    ]
    },
    "jostle-timeout": 0,
    "interfaces":
    {
    "interface":
    [
    {
    "port": 0,
    "ip-address": "string"
    }
    ]
    },
    "rrset-cache-slabs": 0,
    "infra-host-ttl": 0,
    "do-udp": true,
    "num-threads": 0,
    "cache-max-ttl": 0,
    "harden-glue": true,
    "infra-cache-numhosts": 0,
    "so-rcvbuf": 0,
    "infra-cache-slabs": 0,
    "port": 0,
    "key-cache-slabs": 0,
    "do-ip6": false,
    "do-ip4": true,
    "verbosity": 0,
    "msg-cache-slabs": 0,
    "prefetch-key": false,
    "hide-version": false,
    "hide-identity": true
    }
  }
}

}

removes netgate.unbound.unboundconfig.Daemon

delete /data/netgate-unbound:unbound-config/daemon

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon

The server attributes.

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-unbound:unbound-config/daemon"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns netgate.unbound.unboundconfig.daemon.ForwardZones

get /data/netgate-unbound:unbound-config/daemon/forward-zones

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/forward-zones

The forward-zone attributes.

Responses

200

netgate.unbound.unboundconfig.daemon.ForwardZones

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-unbound:unbound-config/daemon/forward-zones"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-unbound:forward-zones-wrapper":
{
- "forward-zones":
  {
  - "zone":
    [
    {
    "forward-addresses":
    {
    "address":
    [
    {
    "auth-name": "string",
    "ip-address": "string",
    "port": 0
    }
    ]
    },
    "forward-hosts":
    {
    "host":
    [
    "string"
    ]
    },
    "forward-first": false,
    "forward-tls-upstream": false,
    "zone-name": "string"
    }
    ]
  }
}

}

creates netgate.unbound.unboundconfig.daemon.ForwardZones

post /data/netgate-unbound:unbound-config/daemon/forward-zones

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/forward-zones

The forward-zone attributes.

Request Body schema: application/yang-data+json

netgate.unbound.unboundconfig.daemon.ForwardZones to be added to list

forward-zones

object (netgate.unbound.unboundconfig.daemon.ForwardZones)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"forward-zones":
{
- "zone":
  [
  - {
    "forward-addresses":
    {
    "address":
    [
    {
    "auth-name": "string",
    "ip-address": "string",
    "port": 0
    }
    ]
    },
    "forward-hosts":
    {
    "host":
    [
    "string"
    ]
    },
    "forward-first": false,
    "forward-tls-upstream": false,
    "zone-name": "string"
    }
  ]
}

}

creates or updates netgate.unbound.unboundconfig.daemon.ForwardZones

put /data/netgate-unbound:unbound-config/daemon/forward-zones

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/forward-zones

The forward-zone attributes.

Request Body schema: application/yang-data+json

netgate.unbound.unboundconfig.daemon.ForwardZones to be added or updated

netgate-unbound:forward-zones-wrapper

object (netgate.unbound.unboundconfig.daemon.ForwardZonesWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-unbound:forward-zones-wrapper":
{
- "forward-zones":
  {
  - "zone":
    [
    {
    "forward-addresses":
    {
    "address":
    [
    {
    "auth-name": "string",
    "ip-address": "string",
    "port": 0
    }
    ]
    },
    "forward-hosts":
    {
    "host":
    [
    "string"
    ]
    },
    "forward-first": false,
    "forward-tls-upstream": false,
    "zone-name": "string"
    }
    ]
  }
}

}

removes netgate.unbound.unboundconfig.daemon.ForwardZones

delete /data/netgate-unbound:unbound-config/daemon/forward-zones

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/forward-zones

The forward-zone attributes.

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-unbound:unbound-config/daemon/forward-zones"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

creates netgate.unbound.unboundconfig.daemon.forwardzones.Zone

post /data/netgate-unbound:unbound-config/daemon/forward-zones/zone

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/forward-zones/zone

Each forward-zone is identified by a domain name. Use '.' as the wildcard domain name. Each zone has a list of nameservers specified as hostnames or host addresses.

Request Body schema: application/yang-data+json

netgate.unbound.unboundconfig.daemon.forwardzones.Zone to be added to list

zone	object (netgate.unbound.unboundconfig.daemon.forwardzones.Zone)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"zone":
{
- "forward-addresses":
  {
  - "address":
    [
    {
    "auth-name": "string",
    "ip-address": "string",
    "port": 0
    }
    ]
  },
- "forward-hosts":
  {
  - "host":
    [
    "string"
    ]
  },
- "forward-first": false,
- "forward-tls-upstream": false,
- "zone-name": "string"
}

}

returns netgate.unbound.unboundconfig.daemon.forwardzones.Zone

get /data/netgate-unbound:unbound-config/daemon/forward-zones/zone={zone-name}

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/forward-zones/zone={zone-name}

Each forward-zone is identified by a domain name. Use '.' as the wildcard domain name. Each zone has a list of nameservers specified as hostnames or host addresses.

path Parameters

zone-name

required

string

Id of zone

Responses

200

netgate.unbound.unboundconfig.daemon.forwardzones.Zone

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-unbound:unbound-config/daemon/forward-zones/zone=%7Bzone-name%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-unbound:zone-wrapper":
{
- "zone":
  {
  - "forward-addresses":
    {
    "address":
    [
    {
    "auth-name": "string",
    "ip-address": "string",
    "port": 0
    }
    ]
    },
  - "forward-hosts":
    {
    "host":
    [
    "string"
    ]
    },
  - "forward-first": false,
  - "forward-tls-upstream": false,
  - "zone-name": "string"
  }
}

}

creates or updates netgate.unbound.unboundconfig.daemon.forwardzones.Zone

put /data/netgate-unbound:unbound-config/daemon/forward-zones/zone={zone-name}

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/forward-zones/zone={zone-name}

Each forward-zone is identified by a domain name. Use '.' as the wildcard domain name. Each zone has a list of nameservers specified as hostnames or host addresses.

path Parameters

zone-name

required

string

Id of zone

Request Body schema: application/yang-data+json

netgate.unbound.unboundconfig.daemon.forwardzones.Zone to be added or updated

netgate-unbound:zone-wrapper

object (netgate.unbound.unboundconfig.daemon.forwardzones.ZoneWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-unbound:zone-wrapper":
{
- "zone":
  {
  - "forward-addresses":
    {
    "address":
    [
    {
    "auth-name": "string",
    "ip-address": "string",
    "port": 0
    }
    ]
    },
  - "forward-hosts":
    {
    "host":
    [
    "string"
    ]
    },
  - "forward-first": false,
  - "forward-tls-upstream": false,
  - "zone-name": "string"
  }
}

}

removes netgate.unbound.unboundconfig.daemon.forwardzones.Zone

delete /data/netgate-unbound:unbound-config/daemon/forward-zones/zone={zone-name}

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/forward-zones/zone={zone-name}

Each forward-zone is identified by a domain name. Use '.' as the wildcard domain name. Each zone has a list of nameservers specified as hostnames or host addresses.

path Parameters

zone-name

required

string

Id of zone

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-unbound:unbound-config/daemon/forward-zones/zone=%7Bzone-name%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns netgate.unbound.unboundconfig.daemon.forwardzones.zone.ForwardAddresses

get /data/netgate-unbound:unbound-config/daemon/forward-zones/zone={zone-name}/forward-addresses

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/forward-zones/zone={zone-name}/forward-addresses

A collection of nameserver IPv4 or IPv6 addresses of nameservers to which queries are forwarded.

path Parameters

zone-name

required

string

Id of zone

Responses

200

netgate.unbound.unboundconfig.daemon.forwardzones.zone.ForwardAddresses

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-unbound:unbound-config/daemon/forward-zones/zone=%7Bzone-name%7D/forward-addresses"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-unbound:forward-addresses-wrapper":
{
- "forward-addresses":
  {
  - "address":
    [
    {
    "auth-name": "string",
    "ip-address": "string",
    "port": 0
    }
    ]
  }
}

}

creates netgate.unbound.unboundconfig.daemon.forwardzones.zone.ForwardAddresses

post /data/netgate-unbound:unbound-config/daemon/forward-zones/zone={zone-name}/forward-addresses

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/forward-zones/zone={zone-name}/forward-addresses

A collection of nameserver IPv4 or IPv6 addresses of nameservers to which queries are forwarded.

path Parameters

zone-name

required

string

Id of zone

Request Body schema: application/yang-data+json

netgate.unbound.unboundconfig.daemon.forwardzones.zone.ForwardAddresses to be added to list

forward-addresses

object (netgate.unbound.unboundconfig.daemon.forwardzones.zone.ForwardAddresses)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"forward-addresses":
{
- "address":
  [
  - {
    "auth-name": "string",
    "ip-address": "string",
    "port": 0
    }
  ]
}

}

creates or updates netgate.unbound.unboundconfig.daemon.forwardzones.zone.ForwardAddresses

put /data/netgate-unbound:unbound-config/daemon/forward-zones/zone={zone-name}/forward-addresses

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/forward-zones/zone={zone-name}/forward-addresses

A collection of nameserver IPv4 or IPv6 addresses of nameservers to which queries are forwarded.

path Parameters

zone-name

required

string

Id of zone

Request Body schema: application/yang-data+json

netgate.unbound.unboundconfig.daemon.forwardzones.zone.ForwardAddresses to be added or updated

netgate-unbound:forward-addresses-wrapper

object (netgate.unbound.unboundconfig.daemon.forwardzones.zone.ForwardAddressesWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-unbound:forward-addresses-wrapper":
{
- "forward-addresses":
  {
  - "address":
    [
    {
    "auth-name": "string",
    "ip-address": "string",
    "port": 0
    }
    ]
  }
}

}

removes netgate.unbound.unboundconfig.daemon.forwardzones.zone.ForwardAddresses

delete /data/netgate-unbound:unbound-config/daemon/forward-zones/zone={zone-name}/forward-addresses

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/forward-zones/zone={zone-name}/forward-addresses

A collection of nameserver IPv4 or IPv6 addresses of nameservers to which queries are forwarded.

path Parameters

zone-name

required

string

Id of zone

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-unbound:unbound-config/daemon/forward-zones/zone=%7Bzone-name%7D/forward-addresses"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

creates netgate.unbound.unboundconfig.daemon.forwardzones.zone.forwardaddresses.Address

post /data/netgate-unbound:unbound-config/daemon/forward-zones/zone={zone-name}/forward-addresses/address

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/forward-zones/zone={zone-name}/forward-addresses/address

creates netgate.unbound.unboundconfig.daemon.forwardzones.zone.forwardaddresses.Address

path Parameters

zone-name

required

string

Id of zone

Request Body schema: application/yang-data+json

netgate.unbound.unboundconfig.daemon.forwardzones.zone.forwardaddresses.Address to be added to list

address

object (netgate.unbound.unboundconfig.daemon.forwardzones.zone.forwardaddresses.Address)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"address":
{
- "auth-name": "string",
- "ip-address": "string",
- "port": 0
}

}

returns netgate.unbound.unboundconfig.daemon.forwardzones.zone.forwardaddresses.Address

get /data/netgate-unbound:unbound-config/daemon/forward-zones/zone={zone-name}/forward-addresses/address={ip-address}

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/forward-zones/zone={zone-name}/forward-addresses/address={ip-address}

returns netgate.unbound.unboundconfig.daemon.forwardzones.zone.forwardaddresses.Address

path Parameters

zone-name required	string Id of zone
ip-address required	string Id of address

Responses

200

netgate.unbound.unboundconfig.daemon.forwardzones.zone.forwardaddresses.Address

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-unbound:unbound-config/daemon/forward-zones/zone=%7Bzone-name%7D/forward-addresses/address=%7Bip-address%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-unbound:address-wrapper":
{
- "address":
  {
  - "auth-name": "string",
  - "ip-address": "string",
  - "port": 0
  }
}

}

creates or updates netgate.unbound.unboundconfig.daemon.forwardzones.zone.forwardaddresses.Address

put /data/netgate-unbound:unbound-config/daemon/forward-zones/zone={zone-name}/forward-addresses/address={ip-address}

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/forward-zones/zone={zone-name}/forward-addresses/address={ip-address}

creates or updates netgate.unbound.unboundconfig.daemon.forwardzones.zone.forwardaddresses.Address

path Parameters

zone-name required	string Id of zone
ip-address required	string Id of address

Request Body schema: application/yang-data+json

netgate.unbound.unboundconfig.daemon.forwardzones.zone.forwardaddresses.Address to be added or updated

netgate-unbound:address-wrapper

object (netgate.unbound.unboundconfig.daemon.forwardzones.zone.forwardaddresses.AddressWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-unbound:address-wrapper":
{
- "address":
  {
  - "auth-name": "string",
  - "ip-address": "string",
  - "port": 0
  }
}

}

removes netgate.unbound.unboundconfig.daemon.forwardzones.zone.forwardaddresses.Address

delete /data/netgate-unbound:unbound-config/daemon/forward-zones/zone={zone-name}/forward-addresses/address={ip-address}

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/forward-zones/zone={zone-name}/forward-addresses/address={ip-address}

removes netgate.unbound.unboundconfig.daemon.forwardzones.zone.forwardaddresses.Address

path Parameters

zone-name required	string Id of zone
ip-address required	string Id of address

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-unbound:unbound-config/daemon/forward-zones/zone=%7Bzone-name%7D/forward-addresses/address=%7Bip-address%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns netgate.unbound.unboundconfig.daemon.forwardzones.zone.ForwardHosts

get /data/netgate-unbound:unbound-config/daemon/forward-zones/zone={zone-name}/forward-hosts

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/forward-zones/zone={zone-name}/forward-hosts

returns netgate.unbound.unboundconfig.daemon.forwardzones.zone.ForwardHosts

path Parameters

zone-name

required

string

Id of zone

Responses

200

netgate.unbound.unboundconfig.daemon.forwardzones.zone.ForwardHosts

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-unbound:unbound-config/daemon/forward-zones/zone=%7Bzone-name%7D/forward-hosts"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-unbound:forward-hosts-wrapper":
{
- "forward-hosts":
  {
  - "host":
    [
    "string"
    ]
  }
}

}

creates netgate.unbound.unboundconfig.daemon.forwardzones.zone.ForwardHosts

post /data/netgate-unbound:unbound-config/daemon/forward-zones/zone={zone-name}/forward-hosts

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/forward-zones/zone={zone-name}/forward-hosts

creates netgate.unbound.unboundconfig.daemon.forwardzones.zone.ForwardHosts

path Parameters

zone-name

required

string

Id of zone

Request Body schema: application/yang-data+json

netgate.unbound.unboundconfig.daemon.forwardzones.zone.ForwardHosts to be added to list

forward-hosts

object (netgate.unbound.unboundconfig.daemon.forwardzones.zone.ForwardHosts)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"forward-hosts":
{
- "host":
  [
  - "string"
  ]
}

}

creates or updates netgate.unbound.unboundconfig.daemon.forwardzones.zone.ForwardHosts

put /data/netgate-unbound:unbound-config/daemon/forward-zones/zone={zone-name}/forward-hosts

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/forward-zones/zone={zone-name}/forward-hosts

creates or updates netgate.unbound.unboundconfig.daemon.forwardzones.zone.ForwardHosts

path Parameters

zone-name

required

string

Id of zone

Request Body schema: application/yang-data+json

netgate.unbound.unboundconfig.daemon.forwardzones.zone.ForwardHosts to be added or updated

netgate-unbound:forward-hosts-wrapper

object (netgate.unbound.unboundconfig.daemon.forwardzones.zone.ForwardHostsWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-unbound:forward-hosts-wrapper":
{
- "forward-hosts":
  {
  - "host":
    [
    "string"
    ]
  }
}

}

removes netgate.unbound.unboundconfig.daemon.forwardzones.zone.ForwardHosts

delete /data/netgate-unbound:unbound-config/daemon/forward-zones/zone={zone-name}/forward-hosts

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/forward-zones/zone={zone-name}/forward-hosts

removes netgate.unbound.unboundconfig.daemon.forwardzones.zone.ForwardHosts

path Parameters

zone-name

required

string

Id of zone

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-unbound:unbound-config/daemon/forward-zones/zone=%7Bzone-name%7D/forward-hosts"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns netgate.unbound.unboundconfig.daemon.Server

get /data/netgate-unbound:unbound-config/daemon/server

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server

The server attributes.

Responses

200

netgate.unbound.unboundconfig.daemon.Server

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-unbound:server-wrapper":
{
- "server":
  {
  - "num-queries-per-thread": 0,
  - "outgoing-range": 4096,
  - "prefetch": false,
  - "serve-expired": false,
  - "do-tcp": true,
  - "harden-dnssec-stripped": false,
  - "cache-min-ttl": 0,
  - "msg-cache-size": 0,
  - "incoming-num-tcp": 0,
  - "use-caps-for-id": false,
  - "unwanted-reply-threshold": 0,
  - "edns-buffer-size": 0,
  - "outgoing-num-tcp": 0,
  - "local-zones":
    {
    "zone":
    [
    {
    "description": "string",
    "type": "deny",
    "hosts":
    {
    "host":
    [
    {
    "description": "string",
    "ip-address":
    [
    "string"
    ],
    "host-name": "string"
    }
    ]
    },
    "zone-name": "string"
    }
    ]
    },
  - "outgoing-interfaces":
    {
    "ip-address":
    [
    "string"
    ]
    },
  - "rrset-cache-size": 0,
  - "access-control":
    {
    "access":
    [
    {
    "action": "allow",
    "ip-prefix": "string"
    }
    ]
    },
  - "jostle-timeout": 0,
  - "interfaces":
    {
    "interface":
    [
    {
    "port": 0,
    "ip-address": "string"
    }
    ]
    },
  - "rrset-cache-slabs": 0,
  - "infra-host-ttl": 0,
  - "do-udp": true,
  - "num-threads": 0,
  - "cache-max-ttl": 0,
  - "harden-glue": true,
  - "infra-cache-numhosts": 0,
  - "so-rcvbuf": 0,
  - "infra-cache-slabs": 0,
  - "port": 0,
  - "key-cache-slabs": 0,
  - "do-ip6": false,
  - "do-ip4": true,
  - "verbosity": 0,
  - "msg-cache-slabs": 0,
  - "prefetch-key": false,
  - "hide-version": false,
  - "hide-identity": true
  }
}

}

creates netgate.unbound.unboundconfig.daemon.Server

post /data/netgate-unbound:unbound-config/daemon/server

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server

The server attributes.

Request Body schema: application/yang-data+json

netgate.unbound.unboundconfig.daemon.Server to be added to list

server

object (netgate.unbound.unboundconfig.daemon.Server)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"server":
{
- "num-queries-per-thread": 0,
- "outgoing-range": 4096,
- "prefetch": false,
- "serve-expired": false,
- "do-tcp": true,
- "harden-dnssec-stripped": false,
- "cache-min-ttl": 0,
- "msg-cache-size": 0,
- "incoming-num-tcp": 0,
- "use-caps-for-id": false,
- "unwanted-reply-threshold": 0,
- "edns-buffer-size": 0,
- "outgoing-num-tcp": 0,
- "local-zones":
  {
  - "zone":
    [
    {
    "description": "string",
    "type": "deny",
    "hosts":
    {
    "host":
    [
    {
    "description": "string",
    "ip-address":
    [
    "string"
    ],
    "host-name": "string"
    }
    ]
    },
    "zone-name": "string"
    }
    ]
  },
- "outgoing-interfaces":
  {
  - "ip-address":
    [
    "string"
    ]
  },
- "rrset-cache-size": 0,
- "access-control":
  {
  - "access":
    [
    {
    "action": "allow",
    "ip-prefix": "string"
    }
    ]
  },
- "jostle-timeout": 0,
- "interfaces":
  {
  - "interface":
    [
    {
    "port": 0,
    "ip-address": "string"
    }
    ]
  },
- "rrset-cache-slabs": 0,
- "infra-host-ttl": 0,
- "do-udp": true,
- "num-threads": 0,
- "cache-max-ttl": 0,
- "harden-glue": true,
- "infra-cache-numhosts": 0,
- "so-rcvbuf": 0,
- "infra-cache-slabs": 0,
- "port": 0,
- "key-cache-slabs": 0,
- "do-ip6": false,
- "do-ip4": true,
- "verbosity": 0,
- "msg-cache-slabs": 0,
- "prefetch-key": false,
- "hide-version": false,
- "hide-identity": true
}

}

creates or updates netgate.unbound.unboundconfig.daemon.Server

put /data/netgate-unbound:unbound-config/daemon/server

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server

The server attributes.

Request Body schema: application/yang-data+json

netgate.unbound.unboundconfig.daemon.Server to be added or updated

netgate-unbound:server-wrapper

object (netgate.unbound.unboundconfig.daemon.ServerWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-unbound:server-wrapper":
{
- "server":
  {
  - "num-queries-per-thread": 0,
  - "outgoing-range": 4096,
  - "prefetch": false,
  - "serve-expired": false,
  - "do-tcp": true,
  - "harden-dnssec-stripped": false,
  - "cache-min-ttl": 0,
  - "msg-cache-size": 0,
  - "incoming-num-tcp": 0,
  - "use-caps-for-id": false,
  - "unwanted-reply-threshold": 0,
  - "edns-buffer-size": 0,
  - "outgoing-num-tcp": 0,
  - "local-zones":
    {
    "zone":
    [
    {
    "description": "string",
    "type": "deny",
    "hosts":
    {
    "host":
    [
    {
    "description": "string",
    "ip-address":
    [
    "string"
    ],
    "host-name": "string"
    }
    ]
    },
    "zone-name": "string"
    }
    ]
    },
  - "outgoing-interfaces":
    {
    "ip-address":
    [
    "string"
    ]
    },
  - "rrset-cache-size": 0,
  - "access-control":
    {
    "access":
    [
    {
    "action": "allow",
    "ip-prefix": "string"
    }
    ]
    },
  - "jostle-timeout": 0,
  - "interfaces":
    {
    "interface":
    [
    {
    "port": 0,
    "ip-address": "string"
    }
    ]
    },
  - "rrset-cache-slabs": 0,
  - "infra-host-ttl": 0,
  - "do-udp": true,
  - "num-threads": 0,
  - "cache-max-ttl": 0,
  - "harden-glue": true,
  - "infra-cache-numhosts": 0,
  - "so-rcvbuf": 0,
  - "infra-cache-slabs": 0,
  - "port": 0,
  - "key-cache-slabs": 0,
  - "do-ip6": false,
  - "do-ip4": true,
  - "verbosity": 0,
  - "msg-cache-slabs": 0,
  - "prefetch-key": false,
  - "hide-version": false,
  - "hide-identity": true
  }
}

}

removes netgate.unbound.unboundconfig.daemon.Server

delete /data/netgate-unbound:unbound-config/daemon/server

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server

The server attributes.

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns netgate.unbound.unboundconfig.daemon.server.AccessControl

get /data/netgate-unbound:unbound-config/daemon/server/access-control

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/access-control

Access control specifications.

Responses

200

netgate.unbound.unboundconfig.daemon.server.AccessControl

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/access-control"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-unbound:access-control-wrapper":
{
- "access-control":
  {
  - "access":
    [
    {
    "action": "allow",
    "ip-prefix": "string"
    }
    ]
  }
}

}

creates netgate.unbound.unboundconfig.daemon.server.AccessControl

post /data/netgate-unbound:unbound-config/daemon/server/access-control

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/access-control

Access control specifications.

Request Body schema: application/yang-data+json

netgate.unbound.unboundconfig.daemon.server.AccessControl to be added to list

access-control

object (netgate.unbound.unboundconfig.daemon.server.AccessControl)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"access-control":
{
- "access":
  [
  - {
    "action": "allow",
    "ip-prefix": "string"
    }
  ]
}

}

creates or updates netgate.unbound.unboundconfig.daemon.server.AccessControl

put /data/netgate-unbound:unbound-config/daemon/server/access-control

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/access-control

Access control specifications.

Request Body schema: application/yang-data+json

netgate.unbound.unboundconfig.daemon.server.AccessControl to be added or updated

netgate-unbound:access-control-wrapper

object (netgate.unbound.unboundconfig.daemon.server.AccessControlWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-unbound:access-control-wrapper":
{
- "access-control":
  {
  - "access":
    [
    {
    "action": "allow",
    "ip-prefix": "string"
    }
    ]
  }
}

}

removes netgate.unbound.unboundconfig.daemon.server.AccessControl

delete /data/netgate-unbound:unbound-config/daemon/server/access-control

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/access-control

Access control specifications.

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/access-control"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

creates netgate.unbound.unboundconfig.daemon.server.accesscontrol.Access

post /data/netgate-unbound:unbound-config/daemon/server/access-control/access

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/access-control/access

creates netgate.unbound.unboundconfig.daemon.server.accesscontrol.Access

Request Body schema: application/yang-data+json

netgate.unbound.unboundconfig.daemon.server.accesscontrol.Access to be added to list

access

object (netgate.unbound.unboundconfig.daemon.server.accesscontrol.Access)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"access":
{
- "action": "allow",
- "ip-prefix": "string"
}

}

returns netgate.unbound.unboundconfig.daemon.server.accesscontrol.Access

get /data/netgate-unbound:unbound-config/daemon/server/access-control/access={ip-prefix}

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/access-control/access={ip-prefix}

returns netgate.unbound.unboundconfig.daemon.server.accesscontrol.Access

path Parameters

ip-prefix

required

string

Id of access

Responses

200

netgate.unbound.unboundconfig.daemon.server.accesscontrol.Access

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/access-control/access=%7Bip-prefix%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-unbound:access-wrapper":
{
- "access":
  {
  - "action": "allow",
  - "ip-prefix": "string"
  }
}

}

creates or updates netgate.unbound.unboundconfig.daemon.server.accesscontrol.Access

put /data/netgate-unbound:unbound-config/daemon/server/access-control/access={ip-prefix}

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/access-control/access={ip-prefix}

creates or updates netgate.unbound.unboundconfig.daemon.server.accesscontrol.Access

path Parameters

ip-prefix

required

string

Id of access

Request Body schema: application/yang-data+json

netgate.unbound.unboundconfig.daemon.server.accesscontrol.Access to be added or updated

netgate-unbound:access-wrapper

object (netgate.unbound.unboundconfig.daemon.server.accesscontrol.AccessWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-unbound:access-wrapper":
{
- "access":
  {
  - "action": "allow",
  - "ip-prefix": "string"
  }
}

}

removes netgate.unbound.unboundconfig.daemon.server.accesscontrol.Access

delete /data/netgate-unbound:unbound-config/daemon/server/access-control/access={ip-prefix}

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/access-control/access={ip-prefix}

removes netgate.unbound.unboundconfig.daemon.server.accesscontrol.Access

path Parameters

ip-prefix

required

string

Id of access

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/access-control/access=%7Bip-prefix%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns netgate.unbound.unboundconfig.daemon.server.Interfaces

get /data/netgate-unbound:unbound-config/daemon/server/interfaces

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/interfaces

Interface binding specifications.

Responses

200

netgate.unbound.unboundconfig.daemon.server.Interfaces

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/interfaces"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-unbound:interfaces-wrapper":
{
- "interfaces":
  {
  - "interface":
    [
    {
    "port": 0,
    "ip-address": "string"
    }
    ]
  }
}

}

creates netgate.unbound.unboundconfig.daemon.server.Interfaces

post /data/netgate-unbound:unbound-config/daemon/server/interfaces

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/interfaces

Interface binding specifications.

Request Body schema: application/yang-data+json

netgate.unbound.unboundconfig.daemon.server.Interfaces to be added to list

interfaces

object (netgate.unbound.unboundconfig.daemon.server.Interfaces)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"interfaces":
{
- "interface":
  [
  - {
    "port": 0,
    "ip-address": "string"
    }
  ]
}

}

creates or updates netgate.unbound.unboundconfig.daemon.server.Interfaces

put /data/netgate-unbound:unbound-config/daemon/server/interfaces

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/interfaces

Interface binding specifications.

Request Body schema: application/yang-data+json

netgate.unbound.unboundconfig.daemon.server.Interfaces to be added or updated

netgate-unbound:interfaces-wrapper

object (netgate.unbound.unboundconfig.daemon.server.InterfacesWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-unbound:interfaces-wrapper":
{
- "interfaces":
  {
  - "interface":
    [
    {
    "port": 0,
    "ip-address": "string"
    }
    ]
  }
}

}

removes netgate.unbound.unboundconfig.daemon.server.Interfaces

delete /data/netgate-unbound:unbound-config/daemon/server/interfaces

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/interfaces

Interface binding specifications.

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/interfaces"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

creates netgate.unbound.unboundconfig.daemon.server.interfaces.Interface

post /data/netgate-unbound:unbound-config/daemon/server/interfaces/interface

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/interfaces/interface

creates netgate.unbound.unboundconfig.daemon.server.interfaces.Interface

Request Body schema: application/yang-data+json

netgate.unbound.unboundconfig.daemon.server.interfaces.Interface to be added to list

interface

object (netgate.unbound.unboundconfig.daemon.server.interfaces.Interface)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"interface":
{
- "port": 0,
- "ip-address": "string"
}

}

returns netgate.unbound.unboundconfig.daemon.server.interfaces.Interface

get /data/netgate-unbound:unbound-config/daemon/server/interfaces/interface={ip-address}

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/interfaces/interface={ip-address}

returns netgate.unbound.unboundconfig.daemon.server.interfaces.Interface

path Parameters

ip-address

required

string

Id of interface

Responses

200

netgate.unbound.unboundconfig.daemon.server.interfaces.Interface

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/interfaces/interface=%7Bip-address%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-unbound:interface-wrapper":
{
- "interface":
  {
  - "port": 0,
  - "ip-address": "string"
  }
}

}

creates or updates netgate.unbound.unboundconfig.daemon.server.interfaces.Interface

put /data/netgate-unbound:unbound-config/daemon/server/interfaces/interface={ip-address}

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/interfaces/interface={ip-address}

creates or updates netgate.unbound.unboundconfig.daemon.server.interfaces.Interface

path Parameters

ip-address

required

string

Id of interface

Request Body schema: application/yang-data+json

netgate.unbound.unboundconfig.daemon.server.interfaces.Interface to be added or updated

netgate-unbound:interface-wrapper

object (netgate.unbound.unboundconfig.daemon.server.interfaces.InterfaceWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-unbound:interface-wrapper":
{
- "interface":
  {
  - "port": 0,
  - "ip-address": "string"
  }
}

}

removes netgate.unbound.unboundconfig.daemon.server.interfaces.Interface

delete /data/netgate-unbound:unbound-config/daemon/server/interfaces/interface={ip-address}

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/interfaces/interface={ip-address}

removes netgate.unbound.unboundconfig.daemon.server.interfaces.Interface

path Parameters

ip-address

required

string

Id of interface

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/interfaces/interface=%7Bip-address%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns netgate.unbound.unboundconfig.daemon.server.LocalZones

get /data/netgate-unbound:unbound-config/daemon/server/local-zones

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/local-zones

The local-zone attributes.

Responses

200

netgate.unbound.unboundconfig.daemon.server.LocalZones

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/local-zones"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-unbound:local-zones-wrapper":
{
- "local-zones":
  {
  - "zone":
    [
    {
    "description": "string",
    "type": "deny",
    "hosts":
    {
    "host":
    [
    {
    "description": "string",
    "ip-address":
    [
    "string"
    ],
    "host-name": "string"
    }
    ]
    },
    "zone-name": "string"
    }
    ]
  }
}

}

creates netgate.unbound.unboundconfig.daemon.server.LocalZones

post /data/netgate-unbound:unbound-config/daemon/server/local-zones

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/local-zones

The local-zone attributes.

Request Body schema: application/yang-data+json

netgate.unbound.unboundconfig.daemon.server.LocalZones to be added to list

local-zones

object (netgate.unbound.unboundconfig.daemon.server.LocalZones)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"local-zones":
{
- "zone":
  [
  - {
    "description": "string",
    "type": "deny",
    "hosts":
    {
    "host":
    [
    {
    "description": "string",
    "ip-address":
    [
    "string"
    ],
    "host-name": "string"
    }
    ]
    },
    "zone-name": "string"
    }
  ]
}

}

creates or updates netgate.unbound.unboundconfig.daemon.server.LocalZones

put /data/netgate-unbound:unbound-config/daemon/server/local-zones

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/local-zones

The local-zone attributes.

Request Body schema: application/yang-data+json

netgate.unbound.unboundconfig.daemon.server.LocalZones to be added or updated

netgate-unbound:local-zones-wrapper

object (netgate.unbound.unboundconfig.daemon.server.LocalZonesWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-unbound:local-zones-wrapper":
{
- "local-zones":
  {
  - "zone":
    [
    {
    "description": "string",
    "type": "deny",
    "hosts":
    {
    "host":
    [
    {
    "description": "string",
    "ip-address":
    [
    "string"
    ],
    "host-name": "string"
    }
    ]
    },
    "zone-name": "string"
    }
    ]
  }
}

}

removes netgate.unbound.unboundconfig.daemon.server.LocalZones

delete /data/netgate-unbound:unbound-config/daemon/server/local-zones

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/local-zones

The local-zone attributes.

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/local-zones"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

creates netgate.unbound.unboundconfig.daemon.server.localzones.Zone

post /data/netgate-unbound:unbound-config/daemon/server/local-zones/zone

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/local-zones/zone

Each local-zone is identified by a domain name.

Request Body schema: application/yang-data+json

netgate.unbound.unboundconfig.daemon.server.localzones.Zone to be added to list

zone	object (netgate.unbound.unboundconfig.daemon.server.localzones.Zone)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"zone":
{
- "description": "string",
- "type": "deny",
- "hosts":
  {
  - "host":
    [
    {
    "description": "string",
    "ip-address":
    [
    "string"
    ],
    "host-name": "string"
    }
    ]
  },
- "zone-name": "string"
}

}

returns netgate.unbound.unboundconfig.daemon.server.localzones.Zone

get /data/netgate-unbound:unbound-config/daemon/server/local-zones/zone={zone-name}

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/local-zones/zone={zone-name}

Each local-zone is identified by a domain name.

path Parameters

zone-name

required

string

Id of zone

Responses

200

netgate.unbound.unboundconfig.daemon.server.localzones.Zone

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/local-zones/zone=%7Bzone-name%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-unbound:zone-wrapper":
{
- "zone":
  {
  - "description": "string",
  - "type": "deny",
  - "hosts":
    {
    "host":
    [
    {
    "description": "string",
    "ip-address":
    [
    "string"
    ],
    "host-name": "string"
    }
    ]
    },
  - "zone-name": "string"
  }
}

}

creates or updates netgate.unbound.unboundconfig.daemon.server.localzones.Zone

put /data/netgate-unbound:unbound-config/daemon/server/local-zones/zone={zone-name}

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/local-zones/zone={zone-name}

Each local-zone is identified by a domain name.

path Parameters

zone-name

required

string

Id of zone

Request Body schema: application/yang-data+json

netgate.unbound.unboundconfig.daemon.server.localzones.Zone to be added or updated

netgate-unbound:zone-wrapper

object (netgate.unbound.unboundconfig.daemon.server.localzones.ZoneWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-unbound:zone-wrapper":
{
- "zone":
  {
  - "description": "string",
  - "type": "deny",
  - "hosts":
    {
    "host":
    [
    {
    "description": "string",
    "ip-address":
    [
    "string"
    ],
    "host-name": "string"
    }
    ]
    },
  - "zone-name": "string"
  }
}

}

removes netgate.unbound.unboundconfig.daemon.server.localzones.Zone

delete /data/netgate-unbound:unbound-config/daemon/server/local-zones/zone={zone-name}

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/local-zones/zone={zone-name}

Each local-zone is identified by a domain name.

path Parameters

zone-name

required

string

Id of zone

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/local-zones/zone=%7Bzone-name%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns netgate.unbound.unboundconfig.daemon.server.localzones.zone.Hosts

get /data/netgate-unbound:unbound-config/daemon/server/local-zones/zone={zone-name}/hosts

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/local-zones/zone={zone-name}/hosts

Local host names within the zone.

path Parameters

zone-name

required

string

Id of zone

Responses

200

netgate.unbound.unboundconfig.daemon.server.localzones.zone.Hosts

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/local-zones/zone=%7Bzone-name%7D/hosts"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-unbound:hosts-wrapper":
{
- "hosts":
  {
  - "host":
    [
    {
    "description": "string",
    "ip-address":
    [
    "string"
    ],
    "host-name": "string"
    }
    ]
  }
}

}

creates netgate.unbound.unboundconfig.daemon.server.localzones.zone.Hosts

post /data/netgate-unbound:unbound-config/daemon/server/local-zones/zone={zone-name}/hosts

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/local-zones/zone={zone-name}/hosts

Local host names within the zone.

path Parameters

zone-name

required

string

Id of zone

Request Body schema: application/yang-data+json

netgate.unbound.unboundconfig.daemon.server.localzones.zone.Hosts to be added to list

hosts

object (netgate.unbound.unboundconfig.daemon.server.localzones.zone.Hosts)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"hosts":
{
- "host":
  [
  - {
    "description": "string",
    "ip-address":
    [
    "string"
    ],
    "host-name": "string"
    }
  ]
}

}

creates or updates netgate.unbound.unboundconfig.daemon.server.localzones.zone.Hosts

put /data/netgate-unbound:unbound-config/daemon/server/local-zones/zone={zone-name}/hosts

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/local-zones/zone={zone-name}/hosts

Local host names within the zone.

path Parameters

zone-name

required

string

Id of zone

Request Body schema: application/yang-data+json

netgate.unbound.unboundconfig.daemon.server.localzones.zone.Hosts to be added or updated

netgate-unbound:hosts-wrapper

object (netgate.unbound.unboundconfig.daemon.server.localzones.zone.HostsWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-unbound:hosts-wrapper":
{
- "hosts":
  {
  - "host":
    [
    {
    "description": "string",
    "ip-address":
    [
    "string"
    ],
    "host-name": "string"
    }
    ]
  }
}

}

removes netgate.unbound.unboundconfig.daemon.server.localzones.zone.Hosts

delete /data/netgate-unbound:unbound-config/daemon/server/local-zones/zone={zone-name}/hosts

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/local-zones/zone={zone-name}/hosts

Local host names within the zone.

path Parameters

zone-name

required

string

Id of zone

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/local-zones/zone=%7Bzone-name%7D/hosts"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

creates netgate.unbound.unboundconfig.daemon.server.localzones.zone.hosts.Host

post /data/netgate-unbound:unbound-config/daemon/server/local-zones/zone={zone-name}/hosts/host

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/local-zones/zone={zone-name}/hosts/host

creates netgate.unbound.unboundconfig.daemon.server.localzones.zone.hosts.Host

path Parameters

zone-name

required

string

Id of zone

Request Body schema: application/yang-data+json

netgate.unbound.unboundconfig.daemon.server.localzones.zone.hosts.Host to be added to list

host	object (netgate.unbound.unboundconfig.daemon.server.localzones.zone.hosts.Host)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"host":
{
- "description": "string",
- "ip-address":
  [
  - "string"
  ],
- "host-name": "string"
}

}

returns netgate.unbound.unboundconfig.daemon.server.localzones.zone.hosts.Host

get /data/netgate-unbound:unbound-config/daemon/server/local-zones/zone={zone-name}/hosts/host={host-name}

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/local-zones/zone={zone-name}/hosts/host={host-name}

returns netgate.unbound.unboundconfig.daemon.server.localzones.zone.hosts.Host

path Parameters

zone-name required	string Id of zone
host-name required	string Id of host

Responses

200

netgate.unbound.unboundconfig.daemon.server.localzones.zone.hosts.Host

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/local-zones/zone=%7Bzone-name%7D/hosts/host=%7Bhost-name%7D"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-unbound:host-wrapper":
{
- "host":
  {
  - "description": "string",
  - "ip-address":
    [
    "string"
    ],
  - "host-name": "string"
  }
}

}

creates or updates netgate.unbound.unboundconfig.daemon.server.localzones.zone.hosts.Host

put /data/netgate-unbound:unbound-config/daemon/server/local-zones/zone={zone-name}/hosts/host={host-name}

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/local-zones/zone={zone-name}/hosts/host={host-name}

creates or updates netgate.unbound.unboundconfig.daemon.server.localzones.zone.hosts.Host

path Parameters

zone-name required	string Id of zone
host-name required	string Id of host

Request Body schema: application/yang-data+json

netgate.unbound.unboundconfig.daemon.server.localzones.zone.hosts.Host to be added or updated

netgate-unbound:host-wrapper

object (netgate.unbound.unboundconfig.daemon.server.localzones.zone.hosts.HostWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-unbound:host-wrapper":
{
- "host":
  {
  - "description": "string",
  - "ip-address":
    [
    "string"
    ],
  - "host-name": "string"
  }
}

}

removes netgate.unbound.unboundconfig.daemon.server.localzones.zone.hosts.Host

delete /data/netgate-unbound:unbound-config/daemon/server/local-zones/zone={zone-name}/hosts/host={host-name}

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/local-zones/zone={zone-name}/hosts/host={host-name}

removes netgate.unbound.unboundconfig.daemon.server.localzones.zone.hosts.Host

path Parameters

zone-name required	string Id of zone
host-name required	string Id of host

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/local-zones/zone=%7Bzone-name%7D/hosts/host=%7Bhost-name%7D"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns netgate.unbound.unboundconfig.daemon.server.OutgoingInterfaces

get /data/netgate-unbound:unbound-config/daemon/server/outgoing-interfaces

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/outgoing-interfaces

The IP addresses of interfaces that should be used for outgoing queries. If more than one IP address is configured, a random interface will be selected from the list.

Responses

200

netgate.unbound.unboundconfig.daemon.server.OutgoingInterfaces

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/outgoing-interfaces"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-unbound:outgoing-interfaces-wrapper":
{
- "outgoing-interfaces":
  {
  - "ip-address":
    [
    "string"
    ]
  }
}

}

creates netgate.unbound.unboundconfig.daemon.server.OutgoingInterfaces

post /data/netgate-unbound:unbound-config/daemon/server/outgoing-interfaces

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/outgoing-interfaces

The IP addresses of interfaces that should be used for outgoing queries. If more than one IP address is configured, a random interface will be selected from the list.

Request Body schema: application/yang-data+json

netgate.unbound.unboundconfig.daemon.server.OutgoingInterfaces to be added to list

outgoing-interfaces

object (netgate.unbound.unboundconfig.daemon.server.OutgoingInterfaces)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"outgoing-interfaces":
{
- "ip-address":
  [
  - "string"
  ]
}

}

creates or updates netgate.unbound.unboundconfig.daemon.server.OutgoingInterfaces

put /data/netgate-unbound:unbound-config/daemon/server/outgoing-interfaces

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/outgoing-interfaces

The IP addresses of interfaces that should be used for outgoing queries. If more than one IP address is configured, a random interface will be selected from the list.

Request Body schema: application/yang-data+json

netgate.unbound.unboundconfig.daemon.server.OutgoingInterfaces to be added or updated

netgate-unbound:outgoing-interfaces-wrapper

object (netgate.unbound.unboundconfig.daemon.server.OutgoingInterfacesWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-unbound:outgoing-interfaces-wrapper":
{
- "outgoing-interfaces":
  {
  - "ip-address":
    [
    "string"
    ]
  }
}

}

removes netgate.unbound.unboundconfig.daemon.server.OutgoingInterfaces

delete /data/netgate-unbound:unbound-config/daemon/server/outgoing-interfaces

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/outgoing-interfaces

The IP addresses of interfaces that should be used for outgoing queries. If more than one IP address is configured, a random interface will be selected from the list.

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-unbound:unbound-config/daemon/server/outgoing-interfaces"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

returns netgate.unbound.unboundconfig.Parameters

get /data/netgate-unbound:unbound-config/parameters

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/parameters

A collection of various Unbound parameters.

Responses

200

netgate.unbound.unboundconfig.Parameters

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-unbound:unbound-config/parameters"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

Response samples

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-unbound:parameters-wrapper":
{
- "parameters":
  {
  - "enable": false
  }
}

}

creates netgate.unbound.unboundconfig.Parameters

post /data/netgate-unbound:unbound-config/parameters

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/parameters

A collection of various Unbound parameters.

Request Body schema: application/yang-data+json

netgate.unbound.unboundconfig.Parameters to be added to list

parameters

object (netgate.unbound.unboundconfig.Parameters)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"parameters":
{
- "enable": false
}

}

creates or updates netgate.unbound.unboundconfig.Parameters

put /data/netgate-unbound:unbound-config/parameters

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/parameters

A collection of various Unbound parameters.

Request Body schema: application/yang-data+json

netgate.unbound.unboundconfig.Parameters to be added or updated

netgate-unbound:parameters-wrapper

object (netgate.unbound.unboundconfig.ParametersWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"netgate-unbound:parameters-wrapper":
{
- "parameters":
  {
  - "enable": false
  }
}

}

removes netgate.unbound.unboundconfig.Parameters

delete /data/netgate-unbound:unbound-config/parameters

Example URL

https://hostname/restconf/data/netgate-unbound:unbound-config/parameters

A collection of various Unbound parameters.

Responses

204

Object deleted

400

Internal error

Request samples

Go
javascript
Python
Shell

Copy

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "http://hostname/restconf/data/netgate-unbound:unbound-config/parameters"

	req, _ := http.NewRequest("DELETE", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := ioutil.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}

unbound-config-operation

operates on netgate.unbound.UnboundConfigOperation

post /operations/netgate-unbound:unbound-config-operation

Example URL

https://hostname/restconf/operations/netgate-unbound:unbound-config-operation

operates on netgate.unbound.UnboundConfigOperation

Request Body schema: application/yang-data+json

input

object (netgate.unbound.unboundconfigoperation.Input)

Responses

200

Correct response

201

No response

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"input":
{
- "request": "string",
- "param": "string"
}

}

Response samples

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"output":
{
- "stdout": "string"
}

}

unbound-control

operates on netgate.unbound.UnboundControl

post /operations/netgate-unbound:unbound-control

Example URL

https://hostname/restconf/operations/netgate-unbound:unbound-control

operates on netgate.unbound.UnboundControl

Request Body schema: application/yang-data+json

input

object (netgate.unbound.unboundcontrol.Input)

Responses

200

Correct response

201

No response

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"input":
{
- "operation": "start"
}

}

Response samples

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"output":
{
- "stdout": "string"
}

}

unbound-coredump

operates on netgate.unbound.UnboundCoredump

post /operations/netgate-unbound:unbound-coredump

Example URL

https://hostname/restconf/operations/netgate-unbound:unbound-coredump

operates on netgate.unbound.UnboundCoredump

Request Body schema: application/yang-data+json

input

object (netgate.unbound.unboundcoredump.Input)

Responses

200

Correct response

201

No response

400

Internal error

Request samples

Payload
Go
javascript
Python
Shell

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"input":
{
- "operation": "enable"
}

}

Response samples

Content type

application/yang-data+json

Copy

Expand all Collapse all

{

"output":
{
- "stdout": "string"
}

}