Netgate TNSR Logo
Documentation Powered by ReDoc

netgate-nat API (24.02)

This YANG module provides a Netgate-defined data-model for Network Address Translation data.

Copyright 2017-2020 Rubicon Communications, LLC.

nat-config

returns netgate.nat.NatConfig

get /data/netgate-nat:nat-config

Example URL

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

Network Address Translation (NAT) data needed to support VPP.

Responses

200

netgate.nat.NatConfig

400

Internal error

Request samples

Copy
package main

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

func main() {

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

creates netgate.nat.NatConfig

post /data/netgate-nat:nat-config

Example URL

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

Network Address Translation (NAT) data needed to support VPP.

Request Body schema: application/yang-data+json

netgate.nat.NatConfig to be added to list

netgate-nat:nat-config
object (netgate.nat.NatConfig)

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-nat:nat-config":
    {
    }
}

creates or updates netgate.nat.NatConfig

put /data/netgate-nat:nat-config

Example URL

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

Network Address Translation (NAT) data needed to support VPP.

Request Body schema: application/yang-data+json

netgate.nat.NatConfig to be added or updated

netgate-nat:nat-config-wrapper
object (netgate.nat.NatConfigWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.nat.NatConfig

delete /data/netgate-nat:nat-config

Example URL

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

Network Address Translation (NAT) data needed to support VPP.

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-nat:nat-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.nat.natconfig.Dynamic

get /data/netgate-nat:nat-config/dynamic

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/dynamic

Dynamic mapping information.

Responses

200

netgate.nat.natconfig.Dynamic

400

Internal error

Request samples

Copy
package main

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

func main() {

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

	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-nat:dynamic-wrapper":
    {
    }
}

creates netgate.nat.natconfig.Dynamic

post /data/netgate-nat:nat-config/dynamic

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/dynamic

Dynamic mapping information.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.Dynamic to be added to list

dynamic
object (netgate.nat.natconfig.Dynamic)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.nat.natconfig.Dynamic

put /data/netgate-nat:nat-config/dynamic

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/dynamic

Dynamic mapping information.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.Dynamic to be added or updated

netgate-nat:dynamic-wrapper
object (netgate.nat.natconfig.DynamicWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.nat.natconfig.Dynamic

delete /data/netgate-nat:nat-config/dynamic

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/dynamic

Dynamic mapping information.

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-nat:nat-config/dynamic"

	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.nat.natconfig.dynamic.PoolIfTable

get /data/netgate-nat:nat-config/dynamic/pool-if-table

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/dynamic/pool-if-table

NAT interface pool table.

Responses

200

netgate.nat.natconfig.dynamic.PoolIfTable

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-nat:nat-config/dynamic/pool-if-table"

	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-nat:pool-if-table-wrapper":
    {
    }
}

creates netgate.nat.natconfig.dynamic.PoolIfTable

post /data/netgate-nat:nat-config/dynamic/pool-if-table

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/dynamic/pool-if-table

NAT interface pool table.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.dynamic.PoolIfTable to be added to list

pool-if-table
object (netgate.nat.natconfig.dynamic.PoolIfTable)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.nat.natconfig.dynamic.PoolIfTable

put /data/netgate-nat:nat-config/dynamic/pool-if-table

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/dynamic/pool-if-table

NAT interface pool table.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.dynamic.PoolIfTable to be added or updated

netgate-nat:pool-if-table-wrapper
object (netgate.nat.natconfig.dynamic.PoolIfTableWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

Content type
application/yang-data+json
Copy
 Expand all Collapse all
{
  • "netgate-nat:pool-if-table-wrapper":
    {
    }
}

removes netgate.nat.natconfig.dynamic.PoolIfTable

delete /data/netgate-nat:nat-config/dynamic/pool-if-table

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/dynamic/pool-if-table

NAT interface pool table.

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-nat:nat-config/dynamic/pool-if-table"

	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.nat.natconfig.dynamic.pooliftable.IfEntry

post /data/netgate-nat:nat-config/dynamic/pool-if-table/if-entry

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/dynamic/pool-if-table/if-entry

Dynamic pool interface entries.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.dynamic.pooliftable.IfEntry to be added to list

if-entry
object (netgate.nat.natconfig.dynamic.pooliftable.IfEntry)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

returns netgate.nat.natconfig.dynamic.pooliftable.IfEntry

get /data/netgate-nat:nat-config/dynamic/pool-if-table/if-entry={if-name}

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/dynamic/pool-if-table/if-entry={if-name}

Dynamic pool interface entries.

path Parameters
if-name
required
string

Id of if-entry

Responses

200

netgate.nat.natconfig.dynamic.pooliftable.IfEntry

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-nat:nat-config/dynamic/pool-if-table/if-entry=%7Bif-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-nat:if-entry-wrapper":
    {
    }
}

creates or updates netgate.nat.natconfig.dynamic.pooliftable.IfEntry

put /data/netgate-nat:nat-config/dynamic/pool-if-table/if-entry={if-name}

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/dynamic/pool-if-table/if-entry={if-name}

Dynamic pool interface entries.

path Parameters
if-name
required
string

Id of if-entry

Request Body schema: application/yang-data+json

netgate.nat.natconfig.dynamic.pooliftable.IfEntry to be added or updated

netgate-nat:if-entry-wrapper
object (netgate.nat.natconfig.dynamic.pooliftable.IfEntryWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.nat.natconfig.dynamic.pooliftable.IfEntry

delete /data/netgate-nat:nat-config/dynamic/pool-if-table/if-entry={if-name}

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/dynamic/pool-if-table/if-entry={if-name}

Dynamic pool interface entries.

path Parameters
if-name
required
string

Id of if-entry

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-nat:nat-config/dynamic/pool-if-table/if-entry=%7Bif-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.nat.natconfig.dynamic.PoolTable

get /data/netgate-nat:nat-config/dynamic/pool-table

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/dynamic/pool-table

NAT address pool table.

Responses

200

netgate.nat.natconfig.dynamic.PoolTable

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-nat:nat-config/dynamic/pool-table"

	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-nat:pool-table-wrapper":
    {
    }
}

creates netgate.nat.natconfig.dynamic.PoolTable

post /data/netgate-nat:nat-config/dynamic/pool-table

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/dynamic/pool-table

NAT address pool table.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.dynamic.PoolTable to be added to list

pool-table
object (netgate.nat.natconfig.dynamic.PoolTable)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.nat.natconfig.dynamic.PoolTable

put /data/netgate-nat:nat-config/dynamic/pool-table

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/dynamic/pool-table

NAT address pool table.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.dynamic.PoolTable to be added or updated

netgate-nat:pool-table-wrapper
object (netgate.nat.natconfig.dynamic.PoolTableWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.nat.natconfig.dynamic.PoolTable

delete /data/netgate-nat:nat-config/dynamic/pool-table

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/dynamic/pool-table

NAT address pool table.

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-nat:nat-config/dynamic/pool-table"

	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.nat.natconfig.dynamic.pooltable.PoolEntry

post /data/netgate-nat:nat-config/dynamic/pool-table/pool-entry

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/dynamic/pool-table/pool-entry

NAT address range entry.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.dynamic.pooltable.PoolEntry to be added to list

pool-entry
object (netgate.nat.natconfig.dynamic.pooltable.PoolEntry)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

returns netgate.nat.natconfig.dynamic.pooltable.PoolEntry

get /data/netgate-nat:nat-config/dynamic/pool-table/pool-entry={first-address}

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/dynamic/pool-table/pool-entry={first-address}

NAT address range entry.

path Parameters
first-address
required
string

Id of pool-entry

Responses

200

netgate.nat.natconfig.dynamic.pooltable.PoolEntry

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-nat:nat-config/dynamic/pool-table/pool-entry=%7Bfirst-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-nat:pool-entry-wrapper":
    {
    }
}

creates or updates netgate.nat.natconfig.dynamic.pooltable.PoolEntry

put /data/netgate-nat:nat-config/dynamic/pool-table/pool-entry={first-address}

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/dynamic/pool-table/pool-entry={first-address}

NAT address range entry.

path Parameters
first-address
required
string

Id of pool-entry

Request Body schema: application/yang-data+json

netgate.nat.natconfig.dynamic.pooltable.PoolEntry to be added or updated

netgate-nat:pool-entry-wrapper
object (netgate.nat.natconfig.dynamic.pooltable.PoolEntryWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.nat.natconfig.dynamic.pooltable.PoolEntry

delete /data/netgate-nat:nat-config/dynamic/pool-table/pool-entry={first-address}

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/dynamic/pool-table/pool-entry={first-address}

NAT address range entry.

path Parameters
first-address
required
string

Id of pool-entry

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-nat:nat-config/dynamic/pool-table/pool-entry=%7Bfirst-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.nat.natconfig.GlobalOptions

get /data/netgate-nat:nat-config/global-options

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/global-options

NAT global options

Responses

200

netgate.nat.natconfig.GlobalOptions

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-nat:nat-config/global-options"

	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-nat:global-options-wrapper":
    {
    }
}

creates netgate.nat.natconfig.GlobalOptions

post /data/netgate-nat:nat-config/global-options

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/global-options

NAT global options

Request Body schema: application/yang-data+json

netgate.nat.natconfig.GlobalOptions to be added to list

global-options
object (netgate.nat.natconfig.GlobalOptions)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.nat.natconfig.GlobalOptions

put /data/netgate-nat:nat-config/global-options

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/global-options

NAT global options

Request Body schema: application/yang-data+json

netgate.nat.natconfig.GlobalOptions to be added or updated

netgate-nat:global-options-wrapper
object (netgate.nat.natconfig.GlobalOptionsWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.nat.natconfig.GlobalOptions

delete /data/netgate-nat:nat-config/global-options

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/global-options

NAT global 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-nat:nat-config/global-options"

	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.nat.natconfig.globaloptions.Nat44

get /data/netgate-nat:nat-config/global-options/nat44

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/global-options/nat44

NAT44 options

Responses

200

netgate.nat.natconfig.globaloptions.Nat44

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-nat:nat-config/global-options/nat44"

	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-nat:nat44-wrapper":
    {
    }
}

creates netgate.nat.natconfig.globaloptions.Nat44

post /data/netgate-nat:nat-config/global-options/nat44

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/global-options/nat44

NAT44 options

Request Body schema: application/yang-data+json

netgate.nat.natconfig.globaloptions.Nat44 to be added to list

nat44
object (netgate.nat.natconfig.globaloptions.Nat44)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.nat.natconfig.globaloptions.Nat44

put /data/netgate-nat:nat-config/global-options/nat44

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/global-options/nat44

NAT44 options

Request Body schema: application/yang-data+json

netgate.nat.natconfig.globaloptions.Nat44 to be added or updated

netgate-nat:nat44-wrapper
object (netgate.nat.natconfig.globaloptions.Nat44Wrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.nat.natconfig.globaloptions.Nat44

delete /data/netgate-nat:nat-config/global-options/nat44

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/global-options/nat44

NAT44 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-nat:nat-config/global-options/nat44"

	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.nat.natconfig.globaloptions.Timeouts

get /data/netgate-nat:nat-config/global-options/timeouts

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/global-options/timeouts

NAT global timeouts

Responses

200

netgate.nat.natconfig.globaloptions.Timeouts

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-nat:nat-config/global-options/timeouts"

	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-nat:timeouts-wrapper":
    {
    }
}

creates netgate.nat.natconfig.globaloptions.Timeouts

post /data/netgate-nat:nat-config/global-options/timeouts

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/global-options/timeouts

NAT global timeouts

Request Body schema: application/yang-data+json

netgate.nat.natconfig.globaloptions.Timeouts to be added to list

timeouts
object (netgate.nat.natconfig.globaloptions.Timeouts)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.nat.natconfig.globaloptions.Timeouts

put /data/netgate-nat:nat-config/global-options/timeouts

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/global-options/timeouts

NAT global timeouts

Request Body schema: application/yang-data+json

netgate.nat.natconfig.globaloptions.Timeouts to be added or updated

netgate-nat:timeouts-wrapper
object (netgate.nat.natconfig.globaloptions.TimeoutsWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.nat.natconfig.globaloptions.Timeouts

delete /data/netgate-nat:nat-config/global-options/timeouts

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/global-options/timeouts

NAT global timeouts

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-nat:nat-config/global-options/timeouts"

	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.nat.natconfig.Ipfix

get /data/netgate-nat:nat-config/ipfix

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/ipfix

IPFIX information.

Responses

200

netgate.nat.natconfig.Ipfix

400

Internal error

Request samples

Copy
package main

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

func main() {

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

	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-nat:ipfix-wrapper":
    {
    }
}

creates netgate.nat.natconfig.Ipfix

post /data/netgate-nat:nat-config/ipfix

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/ipfix

IPFIX information.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.Ipfix to be added to list

ipfix
object (netgate.nat.natconfig.Ipfix)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.nat.natconfig.Ipfix

put /data/netgate-nat:nat-config/ipfix

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/ipfix

IPFIX information.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.Ipfix to be added or updated

netgate-nat:ipfix-wrapper
object (netgate.nat.natconfig.IpfixWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.nat.natconfig.Ipfix

delete /data/netgate-nat:nat-config/ipfix

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/ipfix

IPFIX information.

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-nat:nat-config/ipfix"

	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.nat.natconfig.ipfix.Logging

get /data/netgate-nat:nat-config/ipfix/logging

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/ipfix/logging

IPFIX logging information.

Responses

200

netgate.nat.natconfig.ipfix.Logging

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-nat:nat-config/ipfix/logging"

	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-nat:logging-wrapper":
    {
    }
}

creates netgate.nat.natconfig.ipfix.Logging

post /data/netgate-nat:nat-config/ipfix/logging

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/ipfix/logging

IPFIX logging information.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.ipfix.Logging to be added to list

logging
object (netgate.nat.natconfig.ipfix.Logging)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.nat.natconfig.ipfix.Logging

put /data/netgate-nat:nat-config/ipfix/logging

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/ipfix/logging

IPFIX logging information.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.ipfix.Logging to be added or updated

netgate-nat:logging-wrapper
object (netgate.nat.natconfig.ipfix.LoggingWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.nat.natconfig.ipfix.Logging

delete /data/netgate-nat:nat-config/ipfix/logging

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/ipfix/logging

IPFIX logging information.

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-nat:nat-config/ipfix/logging"

	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.nat.natconfig.Nat64

get /data/netgate-nat:nat-config/nat64

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/nat64

NAT for IPv6/IPv4.

Responses

200

netgate.nat.natconfig.Nat64

400

Internal error

Request samples

Copy
package main

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

func main() {

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

	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-nat:nat64-wrapper":
    {
    }
}

creates netgate.nat.natconfig.Nat64

post /data/netgate-nat:nat-config/nat64

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/nat64

NAT for IPv6/IPv4.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.Nat64 to be added to list

nat64
object (netgate.nat.natconfig.Nat64)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.nat.natconfig.Nat64

put /data/netgate-nat:nat-config/nat64

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/nat64

NAT for IPv6/IPv4.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.Nat64 to be added or updated

netgate-nat:nat64-wrapper
object (netgate.nat.natconfig.Nat64Wrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.nat.natconfig.Nat64

delete /data/netgate-nat:nat-config/nat64

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/nat64

NAT for IPv6/IPv4.

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-nat:nat-config/nat64"

	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.nat.natconfig.Static

get /data/netgate-nat:nat-config/static

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/static

Static mapping information.

Responses

200

netgate.nat.natconfig.Static

400

Internal error

Request samples

Copy
package main

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

func main() {

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

	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-nat:static-wrapper":
    {
    }
}

creates netgate.nat.natconfig.Static

post /data/netgate-nat:nat-config/static

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/static

Static mapping information.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.Static to be added to list

static
object (netgate.nat.natconfig.Static)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.nat.natconfig.Static

put /data/netgate-nat:nat-config/static

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/static

Static mapping information.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.Static to be added or updated

netgate-nat:static-wrapper
object (netgate.nat.natconfig.StaticWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.nat.natconfig.Static

delete /data/netgate-nat:nat-config/static

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/static

Static mapping information.

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-nat:nat-config/static"

	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.nat.natconfig.static.MappingTable

get /data/netgate-nat:nat-config/static/mapping-table

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/static/mapping-table

NAT mapping table.

Responses

200

netgate.nat.natconfig.static.MappingTable

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-nat:nat-config/static/mapping-table"

	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-nat:mapping-table-wrapper":
    {
    }
}

creates netgate.nat.natconfig.static.MappingTable

post /data/netgate-nat:nat-config/static/mapping-table

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/static/mapping-table

NAT mapping table.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.static.MappingTable to be added to list

mapping-table
object (netgate.nat.natconfig.static.MappingTable)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.nat.natconfig.static.MappingTable

put /data/netgate-nat:nat-config/static/mapping-table

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/static/mapping-table

NAT mapping table.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.static.MappingTable to be added or updated

netgate-nat:mapping-table-wrapper
object (netgate.nat.natconfig.static.MappingTableWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.nat.natconfig.static.MappingTable

delete /data/netgate-nat:nat-config/static/mapping-table

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/static/mapping-table

NAT mapping table.

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-nat:nat-config/static/mapping-table"

	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.nat.natconfig.static.mappingtable.MappingEntry

post /data/netgate-nat:nat-config/static/mapping-table/mapping-entry

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/static/mapping-table/mapping-entry

NAT Mapping Entry.

Request Body schema: application/yang-data+json

netgate.nat.natconfig.static.mappingtable.MappingEntry to be added to list

mapping-entry
object (netgate.nat.natconfig.static.mappingtable.MappingEntry)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

returns netgate.nat.natconfig.static.mappingtable.MappingEntry

get /data/netgate-nat:nat-config/static/mapping-table/mapping-entry={transport-protocol},{local-address},{local-port},{external-address},{external-port},{route-table-name}

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/static/mapping-table/mapping-entry={transport-protocol},{local-address},{local-port},{external-address},{external-port},{route-table-name}

NAT Mapping Entry.

path Parameters
transport-protocol
required
string

Id of mapping-entry

local-address
required
string

Id of mapping-entry

local-port
required
string

Id of mapping-entry

external-address
required
string

Id of mapping-entry

external-port
required
string

Id of mapping-entry

route-table-name
required
string

Id of mapping-entry

Responses

200

netgate.nat.natconfig.static.mappingtable.MappingEntry

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-nat:nat-config/static/mapping-table/mapping-entry=%7Btransport-protocol%7D,%7Blocal-address%7D,%7Blocal-port%7D,%7Bexternal-address%7D,%7Bexternal-port%7D,%7Broute-table-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-nat:mapping-entry-wrapper":
    {
    }
}

creates or updates netgate.nat.natconfig.static.mappingtable.MappingEntry

put /data/netgate-nat:nat-config/static/mapping-table/mapping-entry={transport-protocol},{local-address},{local-port},{external-address},{external-port},{route-table-name}

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/static/mapping-table/mapping-entry={transport-protocol},{local-address},{local-port},{external-address},{external-port},{route-table-name}

NAT Mapping Entry.

path Parameters
transport-protocol
required
string

Id of mapping-entry

local-address
required
string

Id of mapping-entry

local-port
required
string

Id of mapping-entry

external-address
required
string

Id of mapping-entry

external-port
required
string

Id of mapping-entry

route-table-name
required
string

Id of mapping-entry

Request Body schema: application/yang-data+json

netgate.nat.natconfig.static.mappingtable.MappingEntry to be added or updated

netgate-nat:mapping-entry-wrapper
object (netgate.nat.natconfig.static.mappingtable.MappingEntryWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.nat.natconfig.static.mappingtable.MappingEntry

delete /data/netgate-nat:nat-config/static/mapping-table/mapping-entry={transport-protocol},{local-address},{local-port},{external-address},{external-port},{route-table-name}

Example URL

https://hostname/restconf/data/netgate-nat:nat-config/static/mapping-table/mapping-entry={transport-protocol},{local-address},{local-port},{external-address},{external-port},{route-table-name}

NAT Mapping Entry.

path Parameters
transport-protocol
required
string

Id of mapping-entry

local-address
required
string

Id of mapping-entry

local-port
required
string

Id of mapping-entry

external-address
required
string

Id of mapping-entry

external-port
required
string

Id of mapping-entry

route-table-name
required
string

Id of mapping-entry

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-nat:nat-config/static/mapping-table/mapping-entry=%7Btransport-protocol%7D,%7Blocal-address%7D,%7Blocal-port%7D,%7Bexternal-address%7D,%7Bexternal-port%7D,%7Broute-table-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))

}

nat-state

returns netgate.nat.NatState

get /data/netgate-nat:nat-state

Example URL

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

Network Address Translation (NAT) state data.

Responses

200

netgate.nat.NatState

400

Internal error

Request samples

Copy
package main

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

func main() {

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

returns netgate.nat.natstate.Dynamic

get /data/netgate-nat:nat-state/dynamic

Example URL

https://hostname/restconf/data/netgate-nat:nat-state/dynamic

Dynamic mapping information.

Responses

200

netgate.nat.natstate.Dynamic

400

Internal error

Request samples

Copy
package main

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

func main() {

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

	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-nat:dynamic-wrapper":
    {
    }
}

returns netgate.nat.natstate.dynamic.PoolIfTable

get /data/netgate-nat:nat-state/dynamic/pool-if-table

Example URL

https://hostname/restconf/data/netgate-nat:nat-state/dynamic/pool-if-table

NAT interface pool table.

Responses

200

netgate.nat.natstate.dynamic.PoolIfTable

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-nat:nat-state/dynamic/pool-if-table"

	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-nat:pool-if-table-wrapper":
    {
    }
}

returns netgate.nat.natstate.dynamic.pooliftable.IfEntry

get /data/netgate-nat:nat-state/dynamic/pool-if-table/if-entry={if-name}

Example URL

https://hostname/restconf/data/netgate-nat:nat-state/dynamic/pool-if-table/if-entry={if-name}

Dynamic pool interface entries.

path Parameters
if-name
required
string

Id of if-entry

Responses

200

netgate.nat.natstate.dynamic.pooliftable.IfEntry

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-nat:nat-state/dynamic/pool-if-table/if-entry=%7Bif-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-nat:if-entry-wrapper":
    {
    }
}

returns netgate.nat.natstate.dynamic.PoolTable

get /data/netgate-nat:nat-state/dynamic/pool-table

Example URL

https://hostname/restconf/data/netgate-nat:nat-state/dynamic/pool-table

NAT address pool table.

Responses

200

netgate.nat.natstate.dynamic.PoolTable

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-nat:nat-state/dynamic/pool-table"

	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-nat:pool-table-wrapper":
    {
    }
}

returns netgate.nat.natstate.dynamic.pooltable.PoolEntry

get /data/netgate-nat:nat-state/dynamic/pool-table/pool-entry={address}

Example URL

https://hostname/restconf/data/netgate-nat:nat-state/dynamic/pool-table/pool-entry={address}

NAT pool address.

path Parameters
address
required
string

Id of pool-entry

Responses

200

netgate.nat.natstate.dynamic.pooltable.PoolEntry

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-nat:nat-state/dynamic/pool-table/pool-entry=%7Baddress%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-nat:pool-entry-wrapper":
    {
    }
}

returns netgate.nat.natstate.InterfaceSides

get /data/netgate-nat:nat-state/interface-sides

Example URL

https://hostname/restconf/data/netgate-nat:nat-state/interface-sides

Side information for each interface.

Responses

200

netgate.nat.natstate.InterfaceSides

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-nat:nat-state/interface-sides"

	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-nat:interface-sides-wrapper":
    {
    }
}

returns netgate.nat.natstate.interfacesides.InterfaceSide

get /data/netgate-nat:nat-state/interface-sides/interface-side={if-name}

Example URL

https://hostname/restconf/data/netgate-nat:nat-state/interface-sides/interface-side={if-name}

Side information about interfaces.

path Parameters
if-name
required
string

Id of interface-side

Responses

200

netgate.nat.natstate.interfacesides.InterfaceSide

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-nat:nat-state/interface-sides/interface-side=%7Bif-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-nat:interface-side-wrapper":
    {
    }
}

returns netgate.nat.natstate.Nat64

get /data/netgate-nat:nat-state/nat64

Example URL

https://hostname/restconf/data/netgate-nat:nat-state/nat64

NAT for IPv6/IPv4.

Responses

200

netgate.nat.natstate.Nat64

400

Internal error

Request samples

Copy
package main

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

func main() {

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

	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-nat:nat64-wrapper":
    {
    }
}

returns netgate.nat.natstate.Parameters

get /data/netgate-nat:nat-state/parameters

Example URL

https://hostname/restconf/data/netgate-nat:nat-state/parameters

NAT configuration parameters.

Responses

200

netgate.nat.natstate.Parameters

400

Internal error

Request samples

Copy
package main

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

func main() {

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

returns netgate.nat.natstate.Static

get /data/netgate-nat:nat-state/static

Example URL

https://hostname/restconf/data/netgate-nat:nat-state/static

Static mapping information.

Responses

200

netgate.nat.natstate.Static

400

Internal error

Request samples

Copy
package main

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

func main() {

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

	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-nat:static-wrapper":
    {
    }
}

returns netgate.nat.natstate.static.MappingTable

get /data/netgate-nat:nat-state/static/mapping-table

Example URL

https://hostname/restconf/data/netgate-nat:nat-state/static/mapping-table

NAT mapping table.

Responses

200

netgate.nat.natstate.static.MappingTable

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-nat:nat-state/static/mapping-table"

	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-nat:mapping-table-wrapper":
    {
    }
}

returns netgate.nat.natstate.static.mappingtable.MappingEntry

get /data/netgate-nat:nat-state/static/mapping-table/mapping-entry={transport-protocol},{local-address},{local-port},{external-address},{external-port},{route-table-name}

Example URL

https://hostname/restconf/data/netgate-nat:nat-state/static/mapping-table/mapping-entry={transport-protocol},{local-address},{local-port},{external-address},{external-port},{route-table-name}

NAT Mapping Entry.

path Parameters
transport-protocol
required
string

Id of mapping-entry

local-address
required
string

Id of mapping-entry

local-port
required
string

Id of mapping-entry

external-address
required
string

Id of mapping-entry

external-port
required
string

Id of mapping-entry

route-table-name
required
string

Id of mapping-entry

Responses

200

netgate.nat.natstate.static.mappingtable.MappingEntry

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-nat:nat-state/static/mapping-table/mapping-entry=%7Btransport-protocol%7D,%7Blocal-address%7D,%7Blocal-port%7D,%7Bexternal-address%7D,%7Bexternal-port%7D,%7Broute-table-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-nat:mapping-entry-wrapper":
    {
    }
}

returns netgate.nat.natstate.Users

get /data/netgate-nat:nat-state/users

Example URL

https://hostname/restconf/data/netgate-nat:nat-state/users

NAT users.

Responses

200

netgate.nat.natstate.Users

400

Internal error

Request samples

Copy
package main

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

func main() {

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

	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-nat:users-wrapper":
    {
    }
}

returns netgate.nat.natstate.users.User

get /data/netgate-nat:nat-state/users/user={route-table},{ip-address}

Example URL

https://hostname/restconf/data/netgate-nat:nat-state/users/user={route-table},{ip-address}

NAT user.

path Parameters
route-table
required
string

Id of user

ip-address
required
string

Id of user

Responses

200

netgate.nat.natstate.users.User

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-nat:nat-state/users/user=%7Broute-table%7D,%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-nat:user-wrapper":
    {
    }
}

returns netgate.nat.natstate.users.user.Session

get /data/netgate-nat:nat-state/users/user={route-table},{ip-address}/session={index}

Example URL

https://hostname/restconf/data/netgate-nat:nat-state/users/user={route-table},{ip-address}/session={index}

NAT user session.

path Parameters
route-table
required
string

Id of user

ip-address
required
string

Id of user

index
required
integer <int64>

Id of session

Responses

200

netgate.nat.natstate.users.user.Session

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-nat:nat-state/users/user=%7Broute-table%7D,%7Bip-address%7D/session=%7Bindex%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-nat:session-wrapper":
    {
    }
}