Netgate TNSR Logo
Documentation Powered by ReDoc

netgate-kea API (24.02)

This YANG module provides a data model for the Kea DHCP server.

Copyright 2019-2023 Rubicon Communications, LLC.

kea-config

returns netgate.kea.KeaConfig

get /data/netgate-kea:kea-config

Example URL

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

returns netgate.kea.KeaConfig

Responses

200

netgate.kea.KeaConfig

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-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-kea:kea-config-wrapper":
    {
    }
}

creates netgate.kea.KeaConfig

post /data/netgate-kea:kea-config

Example URL

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

creates netgate.kea.KeaConfig

Request Body schema: application/yang-data+json

netgate.kea.KeaConfig to be added to list

netgate-kea:kea-config
object (netgate.kea.KeaConfig)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-kea:kea-config":
    {
    }
}

creates or updates netgate.kea.KeaConfig

put /data/netgate-kea:kea-config

Example URL

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

creates or updates netgate.kea.KeaConfig

Request Body schema: application/yang-data+json

netgate.kea.KeaConfig to be added or updated

netgate-kea:kea-config-wrapper
object (netgate.kea.KeaConfigWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-kea:kea-config-wrapper":
    {
    }
}

removes netgate.kea.KeaConfig

delete /data/netgate-kea:kea-config

Example URL

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

removes netgate.kea.KeaConfig

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-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.kea.keaconfig.Dhcp4Server

get /data/netgate-kea:kea-config/dhcp4-server

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server

Gather all the parts that contribute to the DHCP4 server.

Responses

200

netgate.kea.keaconfig.Dhcp4Server

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/dhcp4-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-kea:dhcp4-server-wrapper":
    {
    }
}

creates netgate.kea.keaconfig.Dhcp4Server

post /data/netgate-kea:kea-config/dhcp4-server

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server

Gather all the parts that contribute to the DHCP4 server.

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.Dhcp4Server to be added to list

dhcp4-server
object (netgate.kea.keaconfig.Dhcp4Server)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "dhcp4-server":
    {
    }
}

creates or updates netgate.kea.keaconfig.Dhcp4Server

put /data/netgate-kea:kea-config/dhcp4-server

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server

Gather all the parts that contribute to the DHCP4 server.

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.Dhcp4Server to be added or updated

netgate-kea:dhcp4-server-wrapper
object (netgate.kea.keaconfig.Dhcp4ServerWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-kea:dhcp4-server-wrapper":
    {
    }
}

removes netgate.kea.keaconfig.Dhcp4Server

delete /data/netgate-kea:kea-config/dhcp4-server

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server

Gather all the parts that contribute to the DHCP4 server.

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/dhcp4-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.kea.keaconfig.dhcp4server.Dhcp4

get /data/netgate-kea:kea-config/dhcp4-server/Dhcp4

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4

Configuration for the Kea DHCP IPv4 Server

Responses

200

netgate.kea.keaconfig.dhcp4server.Dhcp4

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4"

	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-kea:dhcp4-wrapper":
    {
    }
}

creates netgate.kea.keaconfig.dhcp4server.Dhcp4

post /data/netgate-kea:kea-config/dhcp4-server/Dhcp4

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4

Configuration for the Kea DHCP IPv4 Server

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.dhcp4server.Dhcp4 to be added to list

Dhcp4
object (netgate.kea.keaconfig.dhcp4server.Dhcp4)

Configuration for the Kea DHCP IPv4 Server

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "Dhcp4":
    {
    }
}

creates or updates netgate.kea.keaconfig.dhcp4server.Dhcp4

put /data/netgate-kea:kea-config/dhcp4-server/Dhcp4

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4

Configuration for the Kea DHCP IPv4 Server

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.dhcp4server.Dhcp4 to be added or updated

netgate-kea:dhcp4-wrapper
object (netgate.kea.keaconfig.dhcp4server.Dhcp4Wrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-kea:dhcp4-wrapper":
    {
    }
}

removes netgate.kea.keaconfig.dhcp4server.Dhcp4

delete /data/netgate-kea:kea-config/dhcp4-server/Dhcp4

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4

Configuration for the Kea DHCP IPv4 Server

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4"

	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.kea.keaconfig.dhcp4server.dhcp4.InterfacesConfig

get /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/interfaces-config

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/interfaces-config

The interfaces-config holds configuration information about each interface used by the DHCPv4 server.

Responses

200

netgate.kea.keaconfig.dhcp4server.dhcp4.InterfacesConfig

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/interfaces-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-kea:interfaces-config-wrapper":
    {
    }
}

creates netgate.kea.keaconfig.dhcp4server.dhcp4.InterfacesConfig

post /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/interfaces-config

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/interfaces-config

The interfaces-config holds configuration information about each interface used by the DHCPv4 server.

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.dhcp4server.dhcp4.InterfacesConfig to be added to list

interfaces-config
object (netgate.kea.keaconfig.dhcp4server.dhcp4.InterfacesConfig)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "interfaces-config":
    {
    }
}

creates or updates netgate.kea.keaconfig.dhcp4server.dhcp4.InterfacesConfig

put /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/interfaces-config

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/interfaces-config

The interfaces-config holds configuration information about each interface used by the DHCPv4 server.

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.dhcp4server.dhcp4.InterfacesConfig to be added or updated

netgate-kea:interfaces-config-wrapper
object (netgate.kea.keaconfig.dhcp4server.dhcp4.InterfacesConfigWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-kea:interfaces-config-wrapper":
    {
    }
}

removes netgate.kea.keaconfig.dhcp4server.dhcp4.InterfacesConfig

delete /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/interfaces-config

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/interfaces-config

The interfaces-config holds configuration information about each interface used by the DHCPv4 server.

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/interfaces-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))

}

creates netgate.kea.keaconfig.dhcp4server.dhcp4.interfacesconfig.Interfaces

post /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/interfaces-config/interfaces

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/interfaces-config/interfaces

The interfaces is a list of interface names or interface names with unicast addresses on them on which the server will listen for DHCP requests.

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.dhcp4server.dhcp4.interfacesconfig.Interfaces to be added to list

interfaces
object (netgate.kea.keaconfig.dhcp4server.dhcp4.interfacesconfig.Interfaces)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "interfaces":
    {
    }
}

returns netgate.kea.keaconfig.dhcp4server.dhcp4.interfacesconfig.Interfaces

get /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/interfaces-config/interfaces={interface}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/interfaces-config/interfaces={interface}

The interfaces is a list of interface names or interface names with unicast addresses on them on which the server will listen for DHCP requests.

path Parameters
interface
required
string

Id of interfaces

Responses

200

netgate.kea.keaconfig.dhcp4server.dhcp4.interfacesconfig.Interfaces

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/interfaces-config/interfaces=%7Binterface%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-kea:interfaces-wrapper":
    {
    }
}

creates or updates netgate.kea.keaconfig.dhcp4server.dhcp4.interfacesconfig.Interfaces

put /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/interfaces-config/interfaces={interface}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/interfaces-config/interfaces={interface}

The interfaces is a list of interface names or interface names with unicast addresses on them on which the server will listen for DHCP requests.

path Parameters
interface
required
string

Id of interfaces

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.dhcp4server.dhcp4.interfacesconfig.Interfaces to be added or updated

netgate-kea:interfaces-wrapper
object (netgate.kea.keaconfig.dhcp4server.dhcp4.interfacesconfig.InterfacesWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-kea:interfaces-wrapper":
    {
    }
}

removes netgate.kea.keaconfig.dhcp4server.dhcp4.interfacesconfig.Interfaces

delete /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/interfaces-config/interfaces={interface}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/interfaces-config/interfaces={interface}

The interfaces is a list of interface names or interface names with unicast addresses on them on which the server will listen for DHCP requests.

path Parameters
interface
required
string

Id of interfaces

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/interfaces-config/interfaces=%7Binterface%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.kea.keaconfig.dhcp4server.dhcp4.LeaseDatabase

get /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/lease-database

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/lease-database

returns netgate.kea.keaconfig.dhcp4server.dhcp4.LeaseDatabase

Responses

200

netgate.kea.keaconfig.dhcp4server.dhcp4.LeaseDatabase

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/lease-database"

	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-kea:lease-database-wrapper":
    {
    }
}

creates netgate.kea.keaconfig.dhcp4server.dhcp4.LeaseDatabase

post /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/lease-database

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/lease-database

creates netgate.kea.keaconfig.dhcp4server.dhcp4.LeaseDatabase

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.dhcp4server.dhcp4.LeaseDatabase to be added to list

lease-database
object (netgate.kea.keaconfig.dhcp4server.dhcp4.LeaseDatabase)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "lease-database":
    {
    }
}

creates or updates netgate.kea.keaconfig.dhcp4server.dhcp4.LeaseDatabase

put /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/lease-database

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/lease-database

creates or updates netgate.kea.keaconfig.dhcp4server.dhcp4.LeaseDatabase

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.dhcp4server.dhcp4.LeaseDatabase to be added or updated

netgate-kea:lease-database-wrapper
object (netgate.kea.keaconfig.dhcp4server.dhcp4.LeaseDatabaseWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-kea:lease-database-wrapper":
    {
    }
}

removes netgate.kea.keaconfig.dhcp4server.dhcp4.LeaseDatabase

delete /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/lease-database

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/lease-database

removes netgate.kea.keaconfig.dhcp4server.dhcp4.LeaseDatabase

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/lease-database"

	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.kea.kealogginggroup.Loggers

post /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/loggers

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/loggers

List of logging facilities and parameters.

Request Body schema: application/yang-data+json

netgate.kea.kealogginggroup.Loggers to be added to list

loggers
object (netgate.kea.kealogginggroup.Loggers)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "loggers":
    {
    }
}

returns netgate.kea.kealogginggroup.Loggers

get /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/loggers={name}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/loggers={name}

List of logging facilities and parameters.

path Parameters
name
required
string

Id of loggers

Responses

200

netgate.kea.kealogginggroup.Loggers

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/loggers=%7Bname%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-kea:loggers-wrapper":
    {
    }
}

creates or updates netgate.kea.kealogginggroup.Loggers

put /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/loggers={name}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/loggers={name}

List of logging facilities and parameters.

path Parameters
name
required
string

Id of loggers

Request Body schema: application/yang-data+json

netgate.kea.kealogginggroup.Loggers to be added or updated

netgate-kea:loggers-wrapper
object (netgate.kea.kealogginggroup.LoggersWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-kea:loggers-wrapper":
    {
    }
}

removes netgate.kea.kealogginggroup.Loggers

delete /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/loggers={name}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/loggers={name}

List of logging facilities and parameters.

path Parameters
name
required
string

Id of loggers

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/loggers=%7Bname%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))

}

creates netgate.kea.kealogginggroup.loggers.OutputOptions

post /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/loggers={name}/output_options

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/loggers={name}/output_options

List of output options for a logger.

path Parameters
name
required
string

Id of loggers

Request Body schema: application/yang-data+json

netgate.kea.kealogginggroup.loggers.OutputOptions to be added to list

output_options
object (netgate.kea.kealogginggroup.loggers.OutputOptions)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "output_options":
    {
    }
}

returns netgate.kea.kealogginggroup.loggers.OutputOptions

get /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/loggers={name}/output_options={output}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/loggers={name}/output_options={output}

List of output options for a logger.

path Parameters
name
required
string

Id of loggers

output
required
string

Id of output_options

Responses

200

netgate.kea.kealogginggroup.loggers.OutputOptions

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/loggers=%7Bname%7D/output_options=%7Boutput%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-kea:output-options-wrapper":
    {
    }
}

creates or updates netgate.kea.kealogginggroup.loggers.OutputOptions

put /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/loggers={name}/output_options={output}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/loggers={name}/output_options={output}

List of output options for a logger.

path Parameters
name
required
string

Id of loggers

output
required
string

Id of output_options

Request Body schema: application/yang-data+json

netgate.kea.kealogginggroup.loggers.OutputOptions to be added or updated

netgate-kea:output-options-wrapper
object (netgate.kea.kealogginggroup.loggers.OutputOptionsWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-kea:output-options-wrapper":
    {
    }
}

removes netgate.kea.kealogginggroup.loggers.OutputOptions

delete /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/loggers={name}/output_options={output}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/loggers={name}/output_options={output}

List of output options for a logger.

path Parameters
name
required
string

Id of loggers

output
required
string

Id of output_options

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/loggers=%7Bname%7D/output_options=%7Boutput%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))

}

creates netgate.kea.keadhcp4optiongroup.OptionData

post /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/option-data

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/option-data

List of DHCPv4 options and values.

Request Body schema: application/yang-data+json

netgate.kea.keadhcp4optiongroup.OptionData to be added to list

option-data
object (netgate.kea.keadhcp4optiongroup.OptionData)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "option-data":
    {
    }
}

returns netgate.kea.keadhcp4optiongroup.OptionData

get /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/option-data={name}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/option-data={name}

List of DHCPv4 options and values.

path Parameters
name
required
string

Id of option-data

Responses

200

netgate.kea.keadhcp4optiongroup.OptionData

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/option-data=%7Bname%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-kea:option-data-wrapper":
    {
    }
}

creates or updates netgate.kea.keadhcp4optiongroup.OptionData

put /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/option-data={name}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/option-data={name}

List of DHCPv4 options and values.

path Parameters
name
required
string

Id of option-data

Request Body schema: application/yang-data+json

netgate.kea.keadhcp4optiongroup.OptionData to be added or updated

option-data
object (netgate.kea.keadhcp4optiongroup.OptionData)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "option-data":
    {
    }
}

removes netgate.kea.keadhcp4optiongroup.OptionData

delete /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/option-data={name}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/option-data={name}

List of DHCPv4 options and values.

path Parameters
name
required
string

Id of option-data

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/option-data=%7Bname%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))

}

creates netgate.kea.keadhcp4optiondefgroup.OptionDef

post /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/option-def

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/option-def

List of DHCPv4 custom option definition.

Request Body schema: application/yang-data+json

netgate.kea.keadhcp4optiondefgroup.OptionDef to be added to list

option-def
object (netgate.kea.keadhcp4optiondefgroup.OptionDef)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "option-def":
    {
    }
}

returns netgate.kea.keadhcp4optiondefgroup.OptionDef

get /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/option-def={name}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/option-def={name}

List of DHCPv4 custom option definition.

path Parameters
name
required
string

Id of option-def

Responses

200

netgate.kea.keadhcp4optiondefgroup.OptionDef

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/option-def=%7Bname%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-kea:option-def-wrapper":
    {
    }
}

creates or updates netgate.kea.keadhcp4optiondefgroup.OptionDef

put /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/option-def={name}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/option-def={name}

List of DHCPv4 custom option definition.

path Parameters
name
required
string

Id of option-def

Request Body schema: application/yang-data+json

netgate.kea.keadhcp4optiondefgroup.OptionDef to be added or updated

netgate-kea:option-def-wrapper
object (netgate.kea.keadhcp4optiondefgroup.OptionDefWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-kea:option-def-wrapper":
    {
    }
}

removes netgate.kea.keadhcp4optiondefgroup.OptionDef

delete /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/option-def={name}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/option-def={name}

List of DHCPv4 custom option definition.

path Parameters
name
required
string

Id of option-def

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/option-def=%7Bname%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))

}

creates netgate.kea.keaconfig.dhcp4server.dhcp4.Subnet4

post /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4

An IPv4 subnet configuration within the DHCPv4 server.

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.dhcp4server.dhcp4.Subnet4 to be added to list

subnet4
object (netgate.kea.keaconfig.dhcp4server.dhcp4.Subnet4)

An IPv4 subnet configuration within the DHCPv4 server.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "subnet4":
    {
    }
}

returns netgate.kea.keaconfig.dhcp4server.dhcp4.Subnet4

get /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}

An IPv4 subnet configuration within the DHCPv4 server.

path Parameters
subnet
required
string

Id of subnet4

Responses

200

netgate.kea.keaconfig.dhcp4server.dhcp4.Subnet4

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4=%7Bsubnet%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-kea:subnet4-wrapper":
    {
    }
}

creates or updates netgate.kea.keaconfig.dhcp4server.dhcp4.Subnet4

put /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}

An IPv4 subnet configuration within the DHCPv4 server.

path Parameters
subnet
required
string

Id of subnet4

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.dhcp4server.dhcp4.Subnet4 to be added or updated

netgate-kea:subnet4-wrapper
object (netgate.kea.keaconfig.dhcp4server.dhcp4.Subnet4Wrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-kea:subnet4-wrapper":
    {
    }
}

removes netgate.kea.keaconfig.dhcp4server.dhcp4.Subnet4

delete /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}

An IPv4 subnet configuration within the DHCPv4 server.

path Parameters
subnet
required
string

Id of subnet4

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4=%7Bsubnet%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))

}

creates netgate.kea.keadhcp4optiongroup.OptionData

post /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}/option-data

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}/option-data

List of DHCPv4 options and values.

path Parameters
subnet
required
string

Id of subnet4

Request Body schema: application/yang-data+json

netgate.kea.keadhcp4optiongroup.OptionData to be added to list

option-data
object (netgate.kea.keadhcp4optiongroup.OptionData)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "option-data":
    {
    }
}

returns netgate.kea.keadhcp4optiongroup.OptionData

get /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}/option-data={name}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}/option-data={name}

List of DHCPv4 options and values.

path Parameters
subnet
required
string

Id of subnet4

name
required
string

Id of option-data

Responses

200

netgate.kea.keadhcp4optiongroup.OptionData

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4=%7Bsubnet%7D/option-data=%7Bname%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-kea:option-data-wrapper":
    {
    }
}

creates or updates netgate.kea.keadhcp4optiongroup.OptionData

put /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}/option-data={name}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}/option-data={name}

List of DHCPv4 options and values.

path Parameters
subnet
required
string

Id of subnet4

name
required
string

Id of option-data

Request Body schema: application/yang-data+json

netgate.kea.keadhcp4optiongroup.OptionData to be added or updated

option-data
object (netgate.kea.keadhcp4optiongroup.OptionData)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "option-data":
    {
    }
}

removes netgate.kea.keadhcp4optiongroup.OptionData

delete /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}/option-data={name}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}/option-data={name}

List of DHCPv4 options and values.

path Parameters
subnet
required
string

Id of subnet4

name
required
string

Id of option-data

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4=%7Bsubnet%7D/option-data=%7Bname%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))

}

creates netgate.kea.keaconfig.dhcp4server.dhcp4.subnet4.Pools

post /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}/pools

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}/pools

A list of leased address pools. Each pool is specified as a start and optional end IPv4 addresses, or as an IPv4 address and prefix.

path Parameters
subnet
required
string

Id of subnet4

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.dhcp4server.dhcp4.subnet4.Pools to be added to list

pools
object (netgate.kea.keaconfig.dhcp4server.dhcp4.subnet4.Pools)

A list of leased address pools. Each pool is specified as a start and optional end IPv4 addresses, or as an IPv4 address and prefix.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "pools":
    {
    }
}

returns netgate.kea.keaconfig.dhcp4server.dhcp4.subnet4.Pools

get /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}/pools={pool}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}/pools={pool}

A list of leased address pools. Each pool is specified as a start and optional end IPv4 addresses, or as an IPv4 address and prefix.

path Parameters
subnet
required
string

Id of subnet4

pool
required
string

Id of pools

Responses

200

netgate.kea.keaconfig.dhcp4server.dhcp4.subnet4.Pools

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4=%7Bsubnet%7D/pools=%7Bpool%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-kea:pools-wrapper":
    {
    }
}

creates or updates netgate.kea.keaconfig.dhcp4server.dhcp4.subnet4.Pools

put /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}/pools={pool}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}/pools={pool}

A list of leased address pools. Each pool is specified as a start and optional end IPv4 addresses, or as an IPv4 address and prefix.

path Parameters
subnet
required
string

Id of subnet4

pool
required
string

Id of pools

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.dhcp4server.dhcp4.subnet4.Pools to be added or updated

netgate-kea:pools-wrapper
object (netgate.kea.keaconfig.dhcp4server.dhcp4.subnet4.PoolsWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-kea:pools-wrapper":
    {
    }
}

removes netgate.kea.keaconfig.dhcp4server.dhcp4.subnet4.Pools

delete /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}/pools={pool}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}/pools={pool}

A list of leased address pools. Each pool is specified as a start and optional end IPv4 addresses, or as an IPv4 address and prefix.

path Parameters
subnet
required
string

Id of subnet4

pool
required
string

Id of pools

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4=%7Bsubnet%7D/pools=%7Bpool%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))

}

creates netgate.kea.keadhcp4optiongroup.OptionData

post /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}/pools={pool}/option-data

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}/pools={pool}/option-data

List of DHCPv4 options and values.

path Parameters
subnet
required
string

Id of subnet4

pool
required
string

Id of pools

Request Body schema: application/yang-data+json

netgate.kea.keadhcp4optiongroup.OptionData to be added to list

option-data
object (netgate.kea.keadhcp4optiongroup.OptionData)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "option-data":
    {
    }
}

returns netgate.kea.keadhcp4optiongroup.OptionData

get /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}/pools={pool}/option-data={name}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}/pools={pool}/option-data={name}

List of DHCPv4 options and values.

path Parameters
subnet
required
string

Id of subnet4

pool
required
string

Id of pools

name
required
string

Id of option-data

Responses

200

netgate.kea.keadhcp4optiongroup.OptionData

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4=%7Bsubnet%7D/pools=%7Bpool%7D/option-data=%7Bname%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-kea:option-data-wrapper":
    {
    }
}

creates or updates netgate.kea.keadhcp4optiongroup.OptionData

put /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}/pools={pool}/option-data={name}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}/pools={pool}/option-data={name}

List of DHCPv4 options and values.

path Parameters
subnet
required
string

Id of subnet4

pool
required
string

Id of pools

name
required
string

Id of option-data

Request Body schema: application/yang-data+json

netgate.kea.keadhcp4optiongroup.OptionData to be added or updated

option-data
object (netgate.kea.keadhcp4optiongroup.OptionData)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "option-data":
    {
    }
}

removes netgate.kea.keadhcp4optiongroup.OptionData

delete /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}/pools={pool}/option-data={name}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}/pools={pool}/option-data={name}

List of DHCPv4 options and values.

path Parameters
subnet
required
string

Id of subnet4

pool
required
string

Id of pools

name
required
string

Id of option-data

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4=%7Bsubnet%7D/pools=%7Bpool%7D/option-data=%7Bname%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))

}

creates netgate.kea.keaconfig.dhcp4server.dhcp4.subnet4.Reservations

post /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}/reservations

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}/reservations

List of host reservations.

path Parameters
subnet
required
string

Id of subnet4

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.dhcp4server.dhcp4.subnet4.Reservations to be added to list

reservations
object (netgate.kea.keaconfig.dhcp4server.dhcp4.subnet4.Reservations)

List of host reservations.

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "reservations":
    {
    }
}

returns netgate.kea.keaconfig.dhcp4server.dhcp4.subnet4.Reservations

get /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}/reservations={ip-address}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}/reservations={ip-address}

List of host reservations.

path Parameters
subnet
required
string

Id of subnet4

ip-address
required
string

Id of reservations

Responses

200

netgate.kea.keaconfig.dhcp4server.dhcp4.subnet4.Reservations

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4=%7Bsubnet%7D/reservations=%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-kea:reservations-wrapper":
    {
    }
}

creates or updates netgate.kea.keaconfig.dhcp4server.dhcp4.subnet4.Reservations

put /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}/reservations={ip-address}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}/reservations={ip-address}

List of host reservations.

path Parameters
subnet
required
string

Id of subnet4

ip-address
required
string

Id of reservations

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.dhcp4server.dhcp4.subnet4.Reservations to be added or updated

netgate-kea:reservations-wrapper
object (netgate.kea.keaconfig.dhcp4server.dhcp4.subnet4.ReservationsWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-kea:reservations-wrapper":
    {
    }
}

removes netgate.kea.keaconfig.dhcp4server.dhcp4.subnet4.Reservations

delete /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}/reservations={ip-address}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}/reservations={ip-address}

List of host reservations.

path Parameters
subnet
required
string

Id of subnet4

ip-address
required
string

Id of reservations

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4=%7Bsubnet%7D/reservations=%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))

}

creates netgate.kea.keadhcp4optiongroup.OptionData

post /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}/reservations={ip-address}/option-data

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}/reservations={ip-address}/option-data

List of DHCPv4 options and values.

path Parameters
subnet
required
string

Id of subnet4

ip-address
required
string

Id of reservations

Request Body schema: application/yang-data+json

netgate.kea.keadhcp4optiongroup.OptionData to be added to list

option-data
object (netgate.kea.keadhcp4optiongroup.OptionData)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "option-data":
    {
    }
}

returns netgate.kea.keadhcp4optiongroup.OptionData

get /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}/reservations={ip-address}/option-data={name}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}/reservations={ip-address}/option-data={name}

List of DHCPv4 options and values.

path Parameters
subnet
required
string

Id of subnet4

ip-address
required
string

Id of reservations

name
required
string

Id of option-data

Responses

200

netgate.kea.keadhcp4optiongroup.OptionData

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4=%7Bsubnet%7D/reservations=%7Bip-address%7D/option-data=%7Bname%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-kea:option-data-wrapper":
    {
    }
}

creates or updates netgate.kea.keadhcp4optiongroup.OptionData

put /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}/reservations={ip-address}/option-data={name}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}/reservations={ip-address}/option-data={name}

List of DHCPv4 options and values.

path Parameters
subnet
required
string

Id of subnet4

ip-address
required
string

Id of reservations

name
required
string

Id of option-data

Request Body schema: application/yang-data+json

netgate.kea.keadhcp4optiongroup.OptionData to be added or updated

option-data
object (netgate.kea.keadhcp4optiongroup.OptionData)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "option-data":
    {
    }
}

removes netgate.kea.keadhcp4optiongroup.OptionData

delete /data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}/reservations={ip-address}/option-data={name}

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4={subnet}/reservations={ip-address}/option-data={name}

List of DHCPv4 options and values.

path Parameters
subnet
required
string

Id of subnet4

ip-address
required
string

Id of reservations

name
required
string

Id of option-data

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/dhcp4-server/Dhcp4/subnet4=%7Bsubnet%7D/reservations=%7Bip-address%7D/option-data=%7Bname%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.kea.keaconfig.Keactrl

get /data/netgate-kea:kea-config/keactrl

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/keactrl

This section contains parameters for the keactrl configuration file.

Responses

200

netgate.kea.keaconfig.Keactrl

400

Internal error

Request samples

Copy
package main

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

func main() {

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

	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-kea:keactrl-wrapper":
    {
    }
}

creates netgate.kea.keaconfig.Keactrl

post /data/netgate-kea:kea-config/keactrl

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/keactrl

This section contains parameters for the keactrl configuration file.

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.Keactrl to be added to list

keactrl
object (netgate.kea.keaconfig.Keactrl)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "keactrl":
    {
    }
}

creates or updates netgate.kea.keaconfig.Keactrl

put /data/netgate-kea:kea-config/keactrl

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/keactrl

This section contains parameters for the keactrl configuration file.

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.Keactrl to be added or updated

netgate-kea:keactrl-wrapper
object (netgate.kea.keaconfig.KeactrlWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-kea:keactrl-wrapper":
    {
    }
}

removes netgate.kea.keaconfig.Keactrl

delete /data/netgate-kea:kea-config/keactrl

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/keactrl

This section contains parameters for the keactrl configuration file.

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

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

	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.kea.keaconfig.keactrl.Dhcp4

get /data/netgate-kea:kea-config/keactrl/dhcp4

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/keactrl/dhcp4

Parameters for the DHCP IPv4 server.

Responses

200

netgate.kea.keaconfig.keactrl.Dhcp4

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/keactrl/dhcp4"

	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-kea:dhcp4-wrapper":
    {
    }
}

creates netgate.kea.keaconfig.keactrl.Dhcp4

post /data/netgate-kea:kea-config/keactrl/dhcp4

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/keactrl/dhcp4

Parameters for the DHCP IPv4 server.

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.keactrl.Dhcp4 to be added to list

dhcp4
object (netgate.kea.keaconfig.keactrl.Dhcp4)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "dhcp4":
    {
    }
}

creates or updates netgate.kea.keaconfig.keactrl.Dhcp4

put /data/netgate-kea:kea-config/keactrl/dhcp4

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/keactrl/dhcp4

Parameters for the DHCP IPv4 server.

Request Body schema: application/yang-data+json

netgate.kea.keaconfig.keactrl.Dhcp4 to be added or updated

netgate-kea:dhcp4-wrapper
object (netgate.kea.keaconfig.keactrl.Dhcp4Wrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-kea:dhcp4-wrapper":
    {
    }
}

removes netgate.kea.keaconfig.keactrl.Dhcp4

delete /data/netgate-kea:kea-config/keactrl/dhcp4

Example URL

https://hostname/restconf/data/netgate-kea:kea-config/keactrl/dhcp4

Parameters for the DHCP IPv4 server.

Responses

204

Object deleted

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-config/keactrl/dhcp4"

	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))

}

kea-state

returns netgate.kea.KeaState

get /data/netgate-kea:kea-state

Example URL

https://hostname/restconf/data/netgate-kea:kea-state

Kea state.

Responses

200

netgate.kea.KeaState

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-state"

	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-kea:kea-state-wrapper":
    {
    }
}

returns netgate.kea.keastate.Dhcp4Server

get /data/netgate-kea:kea-state/dhcp4-server

Example URL

https://hostname/restconf/data/netgate-kea:kea-state/dhcp4-server

DHCPv4 state.

Responses

200

netgate.kea.keastate.Dhcp4Server

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-state/dhcp4-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-kea:dhcp4-server-wrapper":
    {
    }
}

returns netgate.kea.keastate.dhcp4server.Leases

get /data/netgate-kea:kea-state/dhcp4-server/leases

Example URL

https://hostname/restconf/data/netgate-kea:kea-state/dhcp4-server/leases

List of Kea DHCPv4 leases.

Responses

200

netgate.kea.keastate.dhcp4server.Leases

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-state/dhcp4-server/leases"

	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-kea:leases-wrapper":
    {
    }
}

returns netgate.kea.keastate.dhcp4server.leases.Lease

get /data/netgate-kea:kea-state/dhcp4-server/leases/lease={ip-address}

Example URL

https://hostname/restconf/data/netgate-kea:kea-state/dhcp4-server/leases/lease={ip-address}

Kea DHCPv4 lease.

path Parameters
ip-address
required
string

Id of lease

Responses

200

netgate.kea.keastate.dhcp4server.leases.Lease

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-kea:kea-state/dhcp4-server/leases/lease=%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-kea:lease-wrapper":
    {
    }
}

kea-control

operates on netgate.kea.KeaControl

post /operations/netgate-kea:kea-control

Example URL

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

operates on netgate.kea.KeaControl

Request Body schema: application/yang-data+json
input
object (netgate.kea.keacontrol.Input)

Responses

200

Correct response

201

No response

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "input":
    {
    }
}

Response samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "output":
    {
    }
}

kea-coredump

operates on netgate.kea.KeaCoredump

post /operations/netgate-kea:kea-coredump

Example URL

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

operates on netgate.kea.KeaCoredump

Request Body schema: application/yang-data+json
input
object (netgate.kea.keacoredump.Input)

Responses

200

Correct response

201

No response

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "input":
    {
    }
}

Response samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "output":
    {
    }
}

kea-show

operates on netgate.kea.KeaShow

post /operations/netgate-kea:kea-show

Example URL

https://hostname/restconf/operations/netgate-kea:kea-show

operates on netgate.kea.KeaShow

Request Body schema: application/yang-data+json
input
object (netgate.kea.keashow.Input)

Responses

200

Correct response

201

No response

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "input":
    {
    }
}

Response samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "output":
    {
    }
}