Netgate TNSR Logo
Documentation Powered by ReDoc

netgate-ipsec API (24.02)

This YANG module provides mappings of the CLI command structure to the underlying data-model elements for the Netgate router.

Copyright 2016-2023 Rubicon Communications, LLC.

ipsec-config

returns netgate.ipsec.IpsecConfig

get /data/netgate-ipsec:ipsec-config

Example URL

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

returns netgate.ipsec.IpsecConfig

Responses

200

netgate.ipsec.IpsecConfig

400

Internal error

Request samples

Copy
package main

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

func main() {

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

creates netgate.ipsec.IpsecConfig

post /data/netgate-ipsec:ipsec-config

Example URL

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

creates netgate.ipsec.IpsecConfig

Request Body schema: application/yang-data+json

netgate.ipsec.IpsecConfig to be added to list

netgate-ipsec:ipsec-config
object (netgate.ipsec.IpsecConfig)

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

creates or updates netgate.ipsec.IpsecConfig

put /data/netgate-ipsec:ipsec-config

Example URL

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

creates or updates netgate.ipsec.IpsecConfig

Request Body schema: application/yang-data+json

netgate.ipsec.IpsecConfig to be added or updated

netgate-ipsec:ipsec-config-wrapper
object (netgate.ipsec.IpsecConfigWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.ipsec.IpsecConfig

delete /data/netgate-ipsec:ipsec-config

Example URL

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

removes netgate.ipsec.IpsecConfig

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-ipsec:ipsec-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.ipsec.ipsecconfig.GlobalOptions

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

Example URL

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

Global IPsec options.

Responses

200

netgate.ipsec.ipsecconfig.GlobalOptions

400

Internal error

Request samples

Copy
package main

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

func main() {

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

creates netgate.ipsec.ipsecconfig.GlobalOptions

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

Example URL

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

Global IPsec options.

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.GlobalOptions to be added to list

global-options
object (netgate.ipsec.ipsecconfig.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.ipsec.ipsecconfig.GlobalOptions

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

Example URL

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

Global IPsec options.

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.GlobalOptions to be added or updated

netgate-ipsec:global-options-wrapper
object (netgate.ipsec.ipsecconfig.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-ipsec:global-options-wrapper":
    {
    }
}

removes netgate.ipsec.ipsecconfig.GlobalOptions

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

Example URL

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

Global IPsec 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-ipsec:ipsec-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.ipsec.ipsecconfig.globaloptions.EapRadius

get /data/netgate-ipsec:ipsec-config/global-options/eap-radius

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/global-options/eap-radius

EAP-RADIUS plugin settings.

Responses

200

netgate.ipsec.ipsecconfig.globaloptions.EapRadius

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/global-options/eap-radius"

	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-ipsec:eap-radius-wrapper":
    {
    }
}

creates netgate.ipsec.ipsecconfig.globaloptions.EapRadius

post /data/netgate-ipsec:ipsec-config/global-options/eap-radius

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/global-options/eap-radius

EAP-RADIUS plugin settings.

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.globaloptions.EapRadius to be added to list

eap-radius
object (netgate.ipsec.ipsecconfig.globaloptions.EapRadius)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.ipsec.ipsecconfig.globaloptions.EapRadius

put /data/netgate-ipsec:ipsec-config/global-options/eap-radius

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/global-options/eap-radius

EAP-RADIUS plugin settings.

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.globaloptions.EapRadius to be added or updated

netgate-ipsec:eap-radius-wrapper
object (netgate.ipsec.ipsecconfig.globaloptions.EapRadiusWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.ipsec.ipsecconfig.globaloptions.EapRadius

delete /data/netgate-ipsec:ipsec-config/global-options/eap-radius

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/global-options/eap-radius

EAP-RADIUS plugin settings.

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-ipsec:ipsec-config/global-options/eap-radius"

	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.ipsec.ipsecconfig.globaloptions.eapradius.Accounting

get /data/netgate-ipsec:ipsec-config/global-options/eap-radius/accounting

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/global-options/eap-radius/accounting

RADIUS accounting settings.

Responses

200

netgate.ipsec.ipsecconfig.globaloptions.eapradius.Accounting

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/global-options/eap-radius/accounting"

	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-ipsec:accounting-wrapper":
    {
    }
}

creates netgate.ipsec.ipsecconfig.globaloptions.eapradius.Accounting

post /data/netgate-ipsec:ipsec-config/global-options/eap-radius/accounting

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/global-options/eap-radius/accounting

RADIUS accounting settings.

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.globaloptions.eapradius.Accounting to be added to list

accounting
object (netgate.ipsec.ipsecconfig.globaloptions.eapradius.Accounting)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.ipsec.ipsecconfig.globaloptions.eapradius.Accounting

put /data/netgate-ipsec:ipsec-config/global-options/eap-radius/accounting

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/global-options/eap-radius/accounting

RADIUS accounting settings.

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.globaloptions.eapradius.Accounting to be added or updated

netgate-ipsec:accounting-wrapper
object (netgate.ipsec.ipsecconfig.globaloptions.eapradius.AccountingWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.ipsec.ipsecconfig.globaloptions.eapradius.Accounting

delete /data/netgate-ipsec:ipsec-config/global-options/eap-radius/accounting

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/global-options/eap-radius/accounting

RADIUS accounting settings.

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-ipsec:ipsec-config/global-options/eap-radius/accounting"

	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.ipsec.ipsecconfig.Tunnel

post /data/netgate-ipsec:ipsec-config/tunnel

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel

IPsec tunnel configurations

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.Tunnel to be added to list

tunnel
object (netgate.ipsec.ipsecconfig.Tunnel)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

returns netgate.ipsec.ipsecconfig.Tunnel

get /data/netgate-ipsec:ipsec-config/tunnel={instance}

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}

IPsec tunnel configurations

path Parameters
instance
required
integer <int64>

Id of tunnel

Responses

200

netgate.ipsec.ipsecconfig.Tunnel

400

Internal error

Request samples

Copy
package main

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

func main() {

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

creates or updates netgate.ipsec.ipsecconfig.Tunnel

put /data/netgate-ipsec:ipsec-config/tunnel={instance}

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}

IPsec tunnel configurations

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.Tunnel to be added or updated

netgate-ipsec:tunnel-wrapper
object (netgate.ipsec.ipsecconfig.TunnelWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.ipsec.ipsecconfig.Tunnel

delete /data/netgate-ipsec:ipsec-config/tunnel={instance}

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}

IPsec tunnel configurations

path Parameters
instance
required
integer <int64>

Id of tunnel

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-ipsec:ipsec-config/tunnel=%7Binstance%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.ipsec.ipsecconfig.tunnel.Crypto

get /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto

Tunnel cryptographic settings

path Parameters
instance
required
integer <int64>

Id of tunnel

Responses

200

netgate.ipsec.ipsecconfig.tunnel.Crypto

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto"

	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-ipsec:crypto-wrapper":
    {
    }
}

creates netgate.ipsec.ipsecconfig.tunnel.Crypto

post /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto

Tunnel cryptographic settings

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.Crypto to be added to list

crypto
object (netgate.ipsec.ipsecconfig.tunnel.Crypto)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.ipsec.ipsecconfig.tunnel.Crypto

put /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto

Tunnel cryptographic settings

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.Crypto to be added or updated

netgate-ipsec:crypto-wrapper
object (netgate.ipsec.ipsecconfig.tunnel.CryptoWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.ipsec.ipsecconfig.tunnel.Crypto

delete /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto

Tunnel cryptographic settings

path Parameters
instance
required
integer <int64>

Id of tunnel

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-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto"

	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.ipsec.ipsecconfig.tunnel.crypto.Ike

get /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike

returns netgate.ipsec.ipsecconfig.tunnel.crypto.Ike

path Parameters
instance
required
integer <int64>

Id of tunnel

Responses

200

netgate.ipsec.ipsecconfig.tunnel.crypto.Ike

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike"

	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-ipsec:ike-wrapper":
    {
    }
}

creates netgate.ipsec.ipsecconfig.tunnel.crypto.Ike

post /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike

creates netgate.ipsec.ipsecconfig.tunnel.crypto.Ike

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.Ike to be added to list

ike
object (netgate.ipsec.ipsecconfig.tunnel.crypto.Ike)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.Ike

put /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.Ike

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.Ike to be added or updated

netgate-ipsec:ike-wrapper
object (netgate.ipsec.ipsecconfig.tunnel.crypto.IkeWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.ipsec.ipsecconfig.tunnel.crypto.Ike

delete /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike

removes netgate.ipsec.ipsecconfig.tunnel.crypto.Ike

path Parameters
instance
required
integer <int64>

Id of tunnel

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-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike"

	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.ipsec.ipsecconfig.tunnel.crypto.ike.Authentication

post /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/authentication

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/authentication

The auth data for an IKE peer

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Authentication to be added to list

authentication
object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Authentication)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

returns netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Authentication

get /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/authentication={peer}

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/authentication={peer}

The auth data for an IKE peer

path Parameters
instance
required
integer <int64>

Id of tunnel

peer
required
string

Id of authentication

Responses

200

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Authentication

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/authentication=%7Bpeer%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-ipsec:authentication-wrapper":
    {
    }
}

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Authentication

put /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/authentication={peer}

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/authentication={peer}

The auth data for an IKE peer

path Parameters
instance
required
integer <int64>

Id of tunnel

peer
required
string

Id of authentication

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Authentication to be added or updated

netgate-ipsec:authentication-wrapper
object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.AuthenticationWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Authentication

delete /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/authentication={peer}

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/authentication={peer}

The auth data for an IKE peer

path Parameters
instance
required
integer <int64>

Id of tunnel

peer
required
string

Id of authentication

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-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/authentication=%7Bpeer%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.ipsec.ipsecconfig.tunnel.crypto.ike.authentication.Round

post /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/authentication={peer}/round

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/authentication={peer}/round

An authentication round for one peer.

path Parameters
instance
required
integer <int64>

Id of tunnel

peer
required
string

Id of authentication

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.authentication.Round to be added to list

round
object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.authentication.Round)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

returns netgate.ipsec.ipsecconfig.tunnel.crypto.ike.authentication.Round

get /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/authentication={peer}/round={number}

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/authentication={peer}/round={number}

An authentication round for one peer.

path Parameters
instance
required
integer <int64>

Id of tunnel

peer
required
string

Id of authentication

number
required
integer <int32>

Id of round

Responses

200

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.authentication.Round

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/authentication=%7Bpeer%7D/round=%7Bnumber%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-ipsec:round-wrapper":
    {
    }
}

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.authentication.Round

put /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/authentication={peer}/round={number}

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/authentication={peer}/round={number}

An authentication round for one peer.

path Parameters
instance
required
integer <int64>

Id of tunnel

peer
required
string

Id of authentication

number
required
integer <int32>

Id of round

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.authentication.Round to be added or updated

netgate-ipsec:round-wrapper
object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.authentication.RoundWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.ipsec.ipsecconfig.tunnel.crypto.ike.authentication.Round

delete /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/authentication={peer}/round={number}

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/authentication={peer}/round={number}

An authentication round for one peer.

path Parameters
instance
required
integer <int64>

Id of tunnel

peer
required
string

Id of authentication

number
required
integer <int32>

Id of round

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-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/authentication=%7Bpeer%7D/round=%7Bnumber%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.ipsec.ipsecconfig.tunnel.crypto.ike.ChildSa

post /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/child-sa

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/child-sa

Child (phase 2) SA.

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.ChildSa to be added to list

child-sa
object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.ChildSa)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

returns netgate.ipsec.ipsecconfig.tunnel.crypto.ike.ChildSa

get /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/child-sa={name}

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/child-sa={name}

Child (phase 2) SA.

path Parameters
instance
required
integer <int64>

Id of tunnel

name
required
string

Id of child-sa

Responses

200

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.ChildSa

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/child-sa=%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-ipsec:child-sa-wrapper":
    {
    }
}

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.ChildSa

put /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/child-sa={name}

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/child-sa={name}

Child (phase 2) SA.

path Parameters
instance
required
integer <int64>

Id of tunnel

name
required
string

Id of child-sa

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.ChildSa to be added or updated

netgate-ipsec:child-sa-wrapper
object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.ChildSaWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.ipsec.ipsecconfig.tunnel.crypto.ike.ChildSa

delete /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/child-sa={name}

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/child-sa={name}

Child (phase 2) SA.

path Parameters
instance
required
integer <int64>

Id of tunnel

name
required
string

Id of child-sa

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-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/child-sa=%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.ipsec.ipsecconfig.tunnel.crypto.ike.childsa.Proposal

post /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/child-sa={name}/proposal

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/child-sa={name}/proposal

creates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.childsa.Proposal

path Parameters
instance
required
integer <int64>

Id of tunnel

name
required
string

Id of child-sa

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.childsa.Proposal to be added to list

proposal
object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.childsa.Proposal)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

returns netgate.ipsec.ipsecconfig.tunnel.crypto.ike.childsa.Proposal

get /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/child-sa={name}/proposal={proposal-name}

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/child-sa={name}/proposal={proposal-name}

returns netgate.ipsec.ipsecconfig.tunnel.crypto.ike.childsa.Proposal

path Parameters
instance
required
integer <int64>

Id of tunnel

name
required
string

Id of child-sa

proposal-name
required
string

Id of proposal

Responses

200

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.childsa.Proposal

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/child-sa=%7Bname%7D/proposal=%7Bproposal-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-ipsec:proposal-wrapper":
    {
    }
}

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.childsa.Proposal

put /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/child-sa={name}/proposal={proposal-name}

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/child-sa={name}/proposal={proposal-name}

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.childsa.Proposal

path Parameters
instance
required
integer <int64>

Id of tunnel

name
required
string

Id of child-sa

proposal-name
required
string

Id of proposal

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.childsa.Proposal to be added or updated

netgate-ipsec:proposal-wrapper
object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.childsa.ProposalWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.ipsec.ipsecconfig.tunnel.crypto.ike.childsa.Proposal

delete /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/child-sa={name}/proposal={proposal-name}

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/child-sa={name}/proposal={proposal-name}

removes netgate.ipsec.ipsecconfig.tunnel.crypto.ike.childsa.Proposal

path Parameters
instance
required
integer <int64>

Id of tunnel

name
required
string

Id of child-sa

proposal-name
required
string

Id of proposal

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-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/child-sa=%7Bname%7D/proposal=%7Bproposal-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))

}

creates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.childsa.TrafficSelector

post /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/child-sa={name}/traffic-selector

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/child-sa={name}/traffic-selector

Specification of traffic which should be routed through an IPsec tunnel.

path Parameters
instance
required
integer <int64>

Id of tunnel

name
required
string

Id of child-sa

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.childsa.TrafficSelector to be added to list

traffic-selector
object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.childsa.TrafficSelector)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

returns netgate.ipsec.ipsecconfig.tunnel.crypto.ike.childsa.TrafficSelector

get /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/child-sa={name}/traffic-selector={ts-number}

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/child-sa={name}/traffic-selector={ts-number}

Specification of traffic which should be routed through an IPsec tunnel.

path Parameters
instance
required
integer <int64>

Id of tunnel

name
required
string

Id of child-sa

ts-number
required
integer <int32>

Id of traffic-selector

Responses

200

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.childsa.TrafficSelector

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/child-sa=%7Bname%7D/traffic-selector=%7Bts-number%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-ipsec:traffic-selector-wrapper":
    {
    }
}

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.childsa.TrafficSelector

put /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/child-sa={name}/traffic-selector={ts-number}

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/child-sa={name}/traffic-selector={ts-number}

Specification of traffic which should be routed through an IPsec tunnel.

path Parameters
instance
required
integer <int64>

Id of tunnel

name
required
string

Id of child-sa

ts-number
required
integer <int32>

Id of traffic-selector

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.childsa.TrafficSelector to be added or updated

netgate-ipsec:traffic-selector-wrapper
object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.childsa.TrafficSelectorWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.ipsec.ipsecconfig.tunnel.crypto.ike.childsa.TrafficSelector

delete /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/child-sa={name}/traffic-selector={ts-number}

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/child-sa={name}/traffic-selector={ts-number}

Specification of traffic which should be routed through an IPsec tunnel.

path Parameters
instance
required
integer <int64>

Id of tunnel

name
required
string

Id of child-sa

ts-number
required
integer <int32>

Id of traffic-selector

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-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/child-sa=%7Bname%7D/traffic-selector=%7Bts-number%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.ipsec.ipsecconfig.tunnel.crypto.ike.Identity

post /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/identity

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/identity

The ID data for one peer in the SA

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Identity to be added to list

identity
object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Identity)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

returns netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Identity

get /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/identity={peer}

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/identity={peer}

The ID data for one peer in the SA

path Parameters
instance
required
integer <int64>

Id of tunnel

peer
required
string

Id of identity

Responses

200

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Identity

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/identity=%7Bpeer%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-ipsec:identity-wrapper":
    {
    }
}

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Identity

put /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/identity={peer}

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/identity={peer}

The ID data for one peer in the SA

path Parameters
instance
required
integer <int64>

Id of tunnel

peer
required
string

Id of identity

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Identity to be added or updated

netgate-ipsec:identity-wrapper
object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.IdentityWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Identity

delete /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/identity={peer}

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/identity={peer}

The ID data for one peer in the SA

path Parameters
instance
required
integer <int64>

Id of tunnel

peer
required
string

Id of identity

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-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/identity=%7Bpeer%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.ipsec.ipsecconfig.tunnel.crypto.ike.Proposals

post /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/proposals

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/proposals

Proposed parameters for IKE SA

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Proposals to be added to list

proposals
object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Proposals)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

returns netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Proposals

get /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/proposals={name}

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/proposals={name}

Proposed parameters for IKE SA

path Parameters
instance
required
integer <int64>

Id of tunnel

name
required
string

Id of proposals

Responses

200

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Proposals

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/proposals=%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-ipsec:proposals-wrapper":
    {
    }
}

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Proposals

put /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/proposals={name}

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/proposals={name}

Proposed parameters for IKE SA

path Parameters
instance
required
integer <int64>

Id of tunnel

name
required
string

Id of proposals

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Proposals to be added or updated

netgate-ipsec:proposals-wrapper
object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.ProposalsWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.ipsec.ipsecconfig.tunnel.crypto.ike.Proposals

delete /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/proposals={name}

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/proposals={name}

Proposed parameters for IKE SA

path Parameters
instance
required
integer <int64>

Id of tunnel

name
required
string

Id of proposals

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-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/proposals=%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.ipsec.ipsecconfig.tunnel.crypto.ike.RemoteAccess

get /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access

Configurations for remote access VPN

path Parameters
instance
required
integer <int64>

Id of tunnel

Responses

200

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.RemoteAccess

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/remote-access"

	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-ipsec:remote-access-wrapper":
    {
    }
}

creates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.RemoteAccess

post /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access

Configurations for remote access VPN

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.RemoteAccess to be added to list

remote-access
object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.RemoteAccess)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.RemoteAccess

put /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access

Configurations for remote access VPN

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.RemoteAccess to be added or updated

netgate-ipsec:remote-access-wrapper
object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.RemoteAccessWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.ipsec.ipsecconfig.tunnel.crypto.ike.RemoteAccess

delete /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access

Configurations for remote access VPN

path Parameters
instance
required
integer <int64>

Id of tunnel

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-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/remote-access"

	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.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.AddressPools

get /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access/address-pools

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access/address-pools

Pools for assigning remote client addresses.

path Parameters
instance
required
integer <int64>

Id of tunnel

Responses

200

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.AddressPools

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/remote-access/address-pools"

	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-ipsec:address-pools-wrapper":
    {
    }
}

creates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.AddressPools

post /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access/address-pools

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access/address-pools

Pools for assigning remote client addresses.

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.AddressPools to be added to list

address-pools
object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.AddressPools)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.AddressPools

put /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access/address-pools

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access/address-pools

Pools for assigning remote client addresses.

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.AddressPools to be added or updated

netgate-ipsec:address-pools-wrapper
object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.AddressPoolsWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.AddressPools

delete /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access/address-pools

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access/address-pools

Pools for assigning remote client addresses.

path Parameters
instance
required
integer <int64>

Id of tunnel

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-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/remote-access/address-pools"

	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.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.addresspools.Ipv4Range

get /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access/address-pools/ipv4-range

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access/address-pools/ipv4-range

Range of client virtual IPv4 addresses.

path Parameters
instance
required
integer <int64>

Id of tunnel

Responses

200

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.addresspools.Ipv4Range

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/remote-access/address-pools/ipv4-range"

	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-ipsec:ipv4-range-wrapper":
    {
    }
}

creates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.addresspools.Ipv4Range

post /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access/address-pools/ipv4-range

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access/address-pools/ipv4-range

Range of client virtual IPv4 addresses.

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.addresspools.Ipv4Range to be added to list

ipv4-range
object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.addresspools.Ipv4Range)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.addresspools.Ipv4Range

put /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access/address-pools/ipv4-range

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access/address-pools/ipv4-range

Range of client virtual IPv4 addresses.

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.addresspools.Ipv4Range to be added or updated

netgate-ipsec:ipv4-range-wrapper
object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.addresspools.Ipv4RangeWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.addresspools.Ipv4Range

delete /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access/address-pools/ipv4-range

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access/address-pools/ipv4-range

Range of client virtual IPv4 addresses.

path Parameters
instance
required
integer <int64>

Id of tunnel

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-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/remote-access/address-pools/ipv4-range"

	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.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.addresspools.Ipv6Range

get /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access/address-pools/ipv6-range

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access/address-pools/ipv6-range

Range of client virtual IPv6 addresses.

path Parameters
instance
required
integer <int64>

Id of tunnel

Responses

200

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.addresspools.Ipv6Range

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/remote-access/address-pools/ipv6-range"

	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-ipsec:ipv6-range-wrapper":
    {
    }
}

creates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.addresspools.Ipv6Range

post /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access/address-pools/ipv6-range

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access/address-pools/ipv6-range

Range of client virtual IPv6 addresses.

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.addresspools.Ipv6Range to be added to list

ipv6-range
object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.addresspools.Ipv6Range)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.addresspools.Ipv6Range

put /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access/address-pools/ipv6-range

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access/address-pools/ipv6-range

Range of client virtual IPv6 addresses.

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.addresspools.Ipv6Range to be added or updated

netgate-ipsec:ipv6-range-wrapper
object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.addresspools.Ipv6RangeWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.addresspools.Ipv6Range

delete /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access/address-pools/ipv6-range

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access/address-pools/ipv6-range

Range of client virtual IPv6 addresses.

path Parameters
instance
required
integer <int64>

Id of tunnel

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-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/remote-access/address-pools/ipv6-range"

	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.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.Dns

get /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access/dns

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access/dns

DNS configurations.

path Parameters
instance
required
integer <int64>

Id of tunnel

Responses

200

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.Dns

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/remote-access/dns"

	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-ipsec:dns-wrapper":
    {
    }
}

creates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.Dns

post /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access/dns

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access/dns

DNS configurations.

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.Dns to be added to list

dns
object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.Dns)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.Dns

put /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access/dns

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access/dns

DNS configurations.

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.Dns to be added or updated

netgate-ipsec:dns-wrapper
object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.DnsWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.Dns

delete /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access/dns

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access/dns

DNS configurations.

path Parameters
instance
required
integer <int64>

Id of tunnel

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-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/remote-access/dns"

	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.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.dns.Resolver

post /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access/dns/resolver

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access/dns/resolver

Address of DNS resolvers to be used by clients.

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.dns.Resolver to be added to list

resolver
object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.dns.Resolver)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

returns netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.dns.Resolver

get /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access/dns/resolver={res-number}

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access/dns/resolver={res-number}

Address of DNS resolvers to be used by clients.

path Parameters
instance
required
integer <int64>

Id of tunnel

res-number
required
integer <int32>

Id of resolver

Responses

200

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.dns.Resolver

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/remote-access/dns/resolver=%7Bres-number%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-ipsec:resolver-wrapper":
    {
    }
}

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.dns.Resolver

put /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access/dns/resolver={res-number}

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access/dns/resolver={res-number}

Address of DNS resolvers to be used by clients.

path Parameters
instance
required
integer <int64>

Id of tunnel

res-number
required
integer <int32>

Id of resolver

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.dns.Resolver to be added or updated

netgate-ipsec:resolver-wrapper
object (netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.dns.ResolverWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.ipsec.ipsecconfig.tunnel.crypto.ike.remoteaccess.dns.Resolver

delete /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access/dns/resolver={res-number}

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/ike/remote-access/dns/resolver={res-number}

Address of DNS resolvers to be used by clients.

path Parameters
instance
required
integer <int64>

Id of tunnel

res-number
required
integer <int32>

Id of resolver

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-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/ike/remote-access/dns/resolver=%7Bres-number%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.ipsec.ipsecconfig.tunnel.crypto.Manual

get /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/manual

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/manual

returns netgate.ipsec.ipsecconfig.tunnel.crypto.Manual

path Parameters
instance
required
integer <int64>

Id of tunnel

Responses

200

netgate.ipsec.ipsecconfig.tunnel.crypto.Manual

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/manual"

	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-ipsec:manual-wrapper":
    {
    }
}

creates netgate.ipsec.ipsecconfig.tunnel.crypto.Manual

post /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/manual

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/manual

creates netgate.ipsec.ipsecconfig.tunnel.crypto.Manual

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.Manual to be added to list

manual
object (netgate.ipsec.ipsecconfig.tunnel.crypto.Manual)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.Manual

put /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/manual

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/manual

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.Manual

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.Manual to be added or updated

netgate-ipsec:manual-wrapper
object (netgate.ipsec.ipsecconfig.tunnel.crypto.ManualWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.ipsec.ipsecconfig.tunnel.crypto.Manual

delete /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/manual

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/manual

removes netgate.ipsec.ipsecconfig.tunnel.crypto.Manual

path Parameters
instance
required
integer <int64>

Id of tunnel

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-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/manual"

	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.ipsec.ipsecconfig.tunnel.crypto.manual.Encryption

get /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/manual/encryption

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/manual/encryption

returns netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Encryption

path Parameters
instance
required
integer <int64>

Id of tunnel

Responses

200

netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Encryption

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/manual/encryption"

	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-ipsec:encryption-wrapper":
    {
    }
}

creates netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Encryption

post /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/manual/encryption

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/manual/encryption

creates netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Encryption

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Encryption to be added to list

encryption
object (netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Encryption)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Encryption

put /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/manual/encryption

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/manual/encryption

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Encryption

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Encryption to be added or updated

netgate-ipsec:encryption-wrapper
object (netgate.ipsec.ipsecconfig.tunnel.crypto.manual.EncryptionWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Encryption

delete /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/manual/encryption

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/manual/encryption

removes netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Encryption

path Parameters
instance
required
integer <int64>

Id of tunnel

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-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/manual/encryption"

	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.ipsec.ipsecconfig.tunnel.crypto.manual.Integrity

get /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/manual/integrity

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/manual/integrity

returns netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Integrity

path Parameters
instance
required
integer <int64>

Id of tunnel

Responses

200

netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Integrity

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/manual/integrity"

	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-ipsec:integrity-wrapper":
    {
    }
}

creates netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Integrity

post /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/manual/integrity

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/manual/integrity

creates netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Integrity

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Integrity to be added to list

integrity
object (netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Integrity)

Responses

201

Object created

400

Internal error

409

Object already exists

Request samples

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

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Integrity

put /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/manual/integrity

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/manual/integrity

creates or updates netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Integrity

path Parameters
instance
required
integer <int64>

Id of tunnel

Request Body schema: application/yang-data+json

netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Integrity to be added or updated

netgate-ipsec:integrity-wrapper
object (netgate.ipsec.ipsecconfig.tunnel.crypto.manual.IntegrityWrapper)

Responses

201

Object created

204

Object modified

400

Internal error

Request samples

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

removes netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Integrity

delete /data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/manual/integrity

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-config/tunnel={instance}/crypto/manual/integrity

removes netgate.ipsec.ipsecconfig.tunnel.crypto.manual.Integrity

path Parameters
instance
required
integer <int64>

Id of tunnel

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-ipsec:ipsec-config/tunnel=%7Binstance%7D/crypto/manual/integrity"

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

}

ipsec-state

returns netgate.ipsec.IpsecState

get /data/netgate-ipsec:ipsec-state

Example URL

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

Operational state data for IPsec.

Responses

200

netgate.ipsec.IpsecState

400

Internal error

Request samples

Copy
package main

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

func main() {

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

returns netgate.ipsec.ipsecstate.Tunnel

get /data/netgate-ipsec:ipsec-state/tunnel={instance}

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-state/tunnel={instance}

IPsec tunnel

path Parameters
instance
required
integer <int64>

Id of tunnel

Responses

200

netgate.ipsec.ipsecstate.Tunnel

400

Internal error

Request samples

Copy
package main

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

func main() {

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

returns netgate.ipsec.ipsecstate.tunnel.IkeSa

get /data/netgate-ipsec:ipsec-state/tunnel={instance}/ike-sa={ike-unique-id}

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-state/tunnel={instance}/ike-sa={ike-unique-id}

IKE SA

path Parameters
instance
required
integer <int64>

Id of tunnel

ike-unique-id
required
integer <int64>

Id of ike-sa

Responses

200

netgate.ipsec.ipsecstate.tunnel.IkeSa

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-state/tunnel=%7Binstance%7D/ike-sa=%7Bike-unique-id%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-ipsec:ike-sa-wrapper":
    {
    }
}

returns netgate.ipsec.ipsecstate.tunnel.ikesa.ChildSa

get /data/netgate-ipsec:ipsec-state/tunnel={instance}/ike-sa={ike-unique-id}/child-sa={name}

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-state/tunnel={instance}/ike-sa={ike-unique-id}/child-sa={name}

Child SA

path Parameters
instance
required
integer <int64>

Id of tunnel

ike-unique-id
required
integer <int64>

Id of ike-sa

name
required
string

Id of child-sa

Responses

200

netgate.ipsec.ipsecstate.tunnel.ikesa.ChildSa

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-state/tunnel=%7Binstance%7D/ike-sa=%7Bike-unique-id%7D/child-sa=%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-ipsec:child-sa-wrapper":
    {
    }
}

returns netgate.ipsec.ipsecstate.tunnel.ikesa.childsa.Sa

get /data/netgate-ipsec:ipsec-state/tunnel={instance}/ike-sa={ike-unique-id}/child-sa={name}/sa={unique-id}

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-state/tunnel={instance}/ike-sa={ike-unique-id}/child-sa={name}/sa={unique-id}

Child SA instance

path Parameters
instance
required
integer <int64>

Id of tunnel

ike-unique-id
required
integer <int64>

Id of ike-sa

name
required
string

Id of child-sa

unique-id
required
integer <int64>

Id of sa

Responses

200

netgate.ipsec.ipsecstate.tunnel.ikesa.childsa.Sa

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-state/tunnel=%7Binstance%7D/ike-sa=%7Bike-unique-id%7D/child-sa=%7Bname%7D/sa=%7Bunique-id%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-ipsec:sa-wrapper":
    {
    }
}

returns netgate.ipsec.ipsecstate.tunnel.ikesa.childsa.sa.Crypto

get /data/netgate-ipsec:ipsec-state/tunnel={instance}/ike-sa={ike-unique-id}/child-sa={name}/sa={unique-id}/crypto

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-state/tunnel={instance}/ike-sa={ike-unique-id}/child-sa={name}/sa={unique-id}/crypto

Cryptographic Parameters

path Parameters
instance
required
integer <int64>

Id of tunnel

ike-unique-id
required
integer <int64>

Id of ike-sa

name
required
string

Id of child-sa

unique-id
required
integer <int64>

Id of sa

Responses

200

netgate.ipsec.ipsecstate.tunnel.ikesa.childsa.sa.Crypto

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-state/tunnel=%7Binstance%7D/ike-sa=%7Bike-unique-id%7D/child-sa=%7Bname%7D/sa=%7Bunique-id%7D/crypto"

	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-ipsec:crypto-wrapper":
    {
    }
}

returns netgate.ipsec.ipsecstate.tunnel.ikesa.childsa.sa.Status

get /data/netgate-ipsec:ipsec-state/tunnel={instance}/ike-sa={ike-unique-id}/child-sa={name}/sa={unique-id}/status

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-state/tunnel={instance}/ike-sa={ike-unique-id}/child-sa={name}/sa={unique-id}/status

SA status

path Parameters
instance
required
integer <int64>

Id of tunnel

ike-unique-id
required
integer <int64>

Id of ike-sa

name
required
string

Id of child-sa

unique-id
required
integer <int64>

Id of sa

Responses

200

netgate.ipsec.ipsecstate.tunnel.ikesa.childsa.sa.Status

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-state/tunnel=%7Binstance%7D/ike-sa=%7Bike-unique-id%7D/child-sa=%7Bname%7D/sa=%7Bunique-id%7D/status"

	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-ipsec:status-wrapper":
    {
    }
}

returns netgate.ipsec.ipsecstate.tunnel.ikesa.Crypto

get /data/netgate-ipsec:ipsec-state/tunnel={instance}/ike-sa={ike-unique-id}/crypto

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-state/tunnel={instance}/ike-sa={ike-unique-id}/crypto

Cryptographic Parameters

path Parameters
instance
required
integer <int64>

Id of tunnel

ike-unique-id
required
integer <int64>

Id of ike-sa

Responses

200

netgate.ipsec.ipsecstate.tunnel.ikesa.Crypto

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-state/tunnel=%7Binstance%7D/ike-sa=%7Bike-unique-id%7D/crypto"

	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-ipsec:crypto-wrapper":
    {
    }
}

returns netgate.ipsec.ipsecstate.tunnel.ikesa.Status

get /data/netgate-ipsec:ipsec-state/tunnel={instance}/ike-sa={ike-unique-id}/status

Example URL

https://hostname/restconf/data/netgate-ipsec:ipsec-state/tunnel={instance}/ike-sa={ike-unique-id}/status

SA status

path Parameters
instance
required
integer <int64>

Id of tunnel

ike-unique-id
required
integer <int64>

Id of ike-sa

Responses

200

netgate.ipsec.ipsecstate.tunnel.ikesa.Status

400

Internal error

Request samples

Copy
package main

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

func main() {

	url := "http://hostname/restconf/data/netgate-ipsec:ipsec-state/tunnel=%7Binstance%7D/ike-sa=%7Bike-unique-id%7D/status"

	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-ipsec:status-wrapper":
    {
    }
}

ike-control

operates on netgate.ipsec.IkeControl

post /operations/netgate-ipsec:ike-control

Example URL

https://hostname/restconf/operations/netgate-ipsec:ike-control

operates on netgate.ipsec.IkeControl

Request Body schema: application/yang-data+json
input
object (netgate.ipsec.ikecontrol.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":
    {
    }
}

ike-coredump

operates on netgate.ipsec.IkeCoredump

post /operations/netgate-ipsec:ike-coredump

Example URL

https://hostname/restconf/operations/netgate-ipsec:ike-coredump

operates on netgate.ipsec.IkeCoredump

Request Body schema: application/yang-data+json
input
object (netgate.ipsec.ikecoredump.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":
    {
    }
}