Page Comparison

...

• Request Parameters: same with PUT's response request

• Request Example: same with PUT's response example

Response

• Normal response codes: 201
• Error response codes: 400, 401

...

• Request Parameters: same with PUT's response request

• Request Example: same with PUT's example

Response

• Normal response codes: 201
• Error response codes: 400, 401

...

Request:

• Request Parameters:

  Name	In	Type	Required	Description
  site-name	path	string	Y

  remote site nameother paramsbodySame with Get's response

  Site name
  gateway	body	string	Y	The corresponding responder
  pre_shared_key	body	string	N	Optional, only if using the PSK authentication mode
  local_public_cert	body	string	N	Optional, only if using the public key authentication mode. Public key used for auth.
  local_private_cert	body	string	N	Optional, only if using the public key authentication mode. Private key used for auth.
  shared_ca	body	string	N	Optional, only if using the public key authentication mode. CA information
  authentication_method	body	string	Y	Either 'psk' or 'pubkey' as the authentication method.
  local_identifier	body	string	N	The identifier for localhost
  remote_identifier	body	string	N	The identifier for remote counter party
  crypto_proposal	body	list	Y	Proposal names used for ike process
  force_crypto_proposal	body	boolean	N	The flag on forcing the proposal or not
  connections	body	list	Y	List of connectionArray

  connectionArray:

  Name	In	Type	Required	Description
  name	body	string	Y	Connection name
  type	body	string	Y	Type of connection. Either "tunnel" or "transport"
  mode	body	string	Y	Mode used for connection. Either 'add', 'route' or 'start'
  local_subnet	body	string	N	Defines the local subnet.
  local_nat	body	string	N	Defines the local nat, if exists, replace the local_subnet
  local_sourceip	body	string	N	Defines the local source ip
  local_updown	body	string	N	Defines the local iptable rules.
  local_firewall	body	string	N	Flag used to determine whether to enable the local firewall rules or not
  remote_subnet	body	string	N	Defines the subnet of the counter party
  remote_sourceip	body	string	N	Defines the source ip of the counter party
  remote_updown	body	string	N	Defines the iptable rules applied for the counter party
  remote_firewall	body	string	N	Flag used to determine whether to enable the remote firewall rules or not
  crypto_proposal	body	string	N	Crypto proposal used for ESP

  
  

• Request Example

  PUT /cgi-bin/luci/sdewan/ipsec/v1/sites/sites

  {      "gateway": "10.1.0.2",      "name": "site1",      "crypto_proposal": "proposal1"      "connections": [       {          "name": "site_to_site",          "type": "tunnel"          "local_subnet":          "remote_subnet":           "crypto_proposal": "proposal1"       } }

  
  

...

• Normal response codes: 200
• Error response code: 404

• Response Parameters

  Name	In	Type	Required	Description
  name	body	string	Y	Site name
  gateway	body	string	Y	The corresponding responder
  pre_shared_key	body	string	N	Optional, only if using the PSK authentication mode
  local_public_cert	body	string	N	Optional, only if using the public key authentication mode. Public key used for auth.
  local_private_cert	body	string	N	Optional, only if using the public key authentication mode. Private key used for auth.
  shared_ca	body	string	N	Optional, only if using the public key authentication mode. CA information
  authentication_method	body	string	Y	Either 'psk' or 'pubkey' as the authentication method.
  local_identifier	body	string	N	The identifier for localhost
  remote_identifier	body	string	N	The identifier for remote counter party
  crypto_proposal	body	list	Y	Proposal names used for ike process
  force_crypto_proposal	body	boolean	N	The flag on forcing the proposal or not
  connections	body	list	Y	List of connectionArray

  connectionArray:

  Name	In	Type	Required	Description
  name	body	string	Y	Connection name
  type	body	string	Y	Type of connection. Either "tunnel" or "transport"
  mode	body	string	Y	Mode used for connection. Either 'add', 'route' or 'start'
  local_subnet	body	string	N	Defines the local subnet.
  local_nat	body	string	N	Defines the local nat, if exists, replace the local_subnet
  local_sourceip	body	string	N	Defines the local source ip
  local_updown	body	string	N	Defines the local iptable rules.
  local_firewall	body	string	N	Flag used to determine whether to enable the local firewall rules or not
  remote_subnet	body	string	N	Defines the subnet of the counter party
  remote_sourceip	body	string	N	Defines the source ip of the counter party
  remote_updown	body	string	N	Defines the iptable rules applied for the counter party
  remote_firewall	body	string	N	Flag used to determine whether to enable the remote firewall rules or not
  crypto_proposal	body	string	N	Crypto proposal used for ESP

  
  

• Response Example

  {      "name": "site1",      "gateway":"10.1.0.2",      "crypto_proposal": "proposal1"      "connections": [       {          "name": "site_to_site",          "type": "tunnel",          "local_subnet":          "remote_subnet":           "crypto_proposal": "proposal2"       }     ] }

  
  

...