Skip to main content

Create a new network

Body parameter

{
  "name": "string",
  "description": "string",
  "internetAccess": "SPLIT_TUNNEL_ON",
  "egress": true,
  "routes": [
    {
      "value": "string",
      "description": "string"
    }
  ],
  "connectors": [
    {
      "name": "string",
      "description": "string",
      "vpnRegionId": "string",
      "ipSecConfig": {
        "platform": "AWS",
        "authenticationType": "SHARED_SECRET",
        "remoteSitePublicIp": "string",
        "preSharedKey": "string",
        "caCertificate": "string",
        "peerCertificate": "string",
        "remoteGatewayCertificate": "string",
        "peerCertificatePrivateKey": "string",
        "peerCertificateKeyPassphrase": "string",
        "ikeProtocol": {
          "protocolVersion": "IKE_V1",
          "phase1": {
            "encryptionAlgorithms": [],
            "integrityAlgorithms": [],
            "diffieHellmanGroups": [],
            "lifetimeSec": 3600
          },
          "phase2": {
            "encryptionAlgorithms": [],
            "integrityAlgorithms": [],
            "diffieHellmanGroups": [],
            "lifetimeSec": 3600
          },
          "rekey": {
            "marginTimeSec": 270,
            "fuzzPercent": 100,
            "replayWindowSize": 1024
          },
          "deadPeerDetection": {
            "timeoutSec": 30,
            "deadPeerHandling": "RESTART"
          },
          "startupAction": "START"
        },
        "hostname": "string",
        "domain": "string"
      }
    }
  ],
  "tunnelingProtocol": "OPENVPN",
  "gatewaysIds": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	NetworkCreateRequest	true	none
» name	body	string	false	none
» description	body	string	false	none
» internetAccess	body	string	false	none
» egress	body	boolean	false	none
» routes	body	[NetworkRouteRequest]	false	none
»» value	body	string	false	none
»» description	body	string	false	none
» connectors	body	[NetworkConnectorRequest]	false	none
»» name	body	string	false	none
»» description	body	string	false	none
»» vpnRegionId	body	string	false	none
»» ipSecConfig	body	IpSecConfigRequest	false	none
»»» platform	body	string	false	none
»»» authenticationType	body	string	false	none
»»» remoteSitePublicIp	body	string	false	none
»»» preSharedKey	body	string	false	none
»»» caCertificate	body	string	false	none
»»» peerCertificate	body	string	false	none
»»» remoteGatewayCertificate	body	string	false	none
»»» peerCertificatePrivateKey	body	string	false	none
»»» peerCertificateKeyPassphrase	body	string	false	none
»»» ikeProtocol	body	IkeProtocol	false	none
»»»» protocolVersion	body	string	false	none
»»»» phase1	body	IkePhase	false	none
»»»»» encryptionAlgorithms	body	[string]	false	none
»»»»» integrityAlgorithms	body	[string]	false	none
»»»»» diffieHellmanGroups	body	[string]	false	none
»»»»» lifetimeSec	body	integer(int32)	false	none
»»»» phase2	body	IkePhase	false	none
»»»» rekey	body	IkeRekey	false	none
»»»»» marginTimeSec	body	integer(int32)	false	none
»»»»» fuzzPercent	body	integer(int32)	false	none
»»»»» replayWindowSize	body	integer(int32)	false	none
»»»» deadPeerDetection	body	IkeDeadPeerDetection	false	none
»»»»» timeoutSec	body	integer(int32)	false	none
»»»»» deadPeerHandling	body	string	false	none
»»»» startupAction	body	string	false	none
»»» hostname	body	string	false	none
»»» domain	body	string	false	none
» tunnelingProtocol	body	string	false	none
» gatewaysIds	body	[string]	false	none

Enumerated Values

Parameter	Value
» internetAccess	SPLIT_TUNNEL_ON
» internetAccess	SPLIT_TUNNEL_OFF
» internetAccess	RESTRICTED_INTERNET
»»» platform	AWS
»»» platform	CISCO
»»» platform	AZURE
»»» platform	GCP
»»» platform	OTHER
»»» authenticationType	SHARED_SECRET
»»» authenticationType	CERTIFICATE
»»»» protocolVersion	IKE_V1
»»»» protocolVersion	IKE_V2
»»»»» encryptionAlgorithms	AES128
»»»»» encryptionAlgorithms	AES256
»»»»» encryptionAlgorithms	AES128_GCM_16
»»»»» encryptionAlgorithms	AES256_GCM_16
»»»»» integrityAlgorithms	SHA1
»»»»» integrityAlgorithms	SHA2_256
»»»»» integrityAlgorithms	SHA2_384
»»»»» integrityAlgorithms	SHA2_512
»»»»» diffieHellmanGroups	G_1
»»»»» diffieHellmanGroups	G_2
»»»»» diffieHellmanGroups	G_5
»»»»» diffieHellmanGroups	G_14
»»»»» diffieHellmanGroups	G_15
»»»»» diffieHellmanGroups	G_16
»»»»» diffieHellmanGroups	G_19
»»»»» diffieHellmanGroups	G_20
»»»»» diffieHellmanGroups	G_24
»»»»» deadPeerHandling	RESTART
»»»»» deadPeerHandling	NONE
»»»» startupAction	START
»»»» startupAction	ATTACH
» tunnelingProtocol	OPENVPN
» tunnelingProtocol	IPSEC

Responses

Status	Meaning	Description	Schema
201	Created	Created	NetworkResponse

To perform this operation, you must be authenticated by means of one of the following methods: oauth

In this section:

Was this helpful?