netgate-unbound API (23.06)

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,
    "n