Create a Cloud Connect attachment via IPSec VPN

Creates a Cloud Connect attachment via a specified VPN server. Currently Static and Dynamic (BGP) VPN attachments are available. The created connection will be available within 3-5 minutes.

Authentication

AuthorizationBearer

An auth_token should be provided to authenticate a session.

To obtain an auth_token, see the /api/v1/authenticate POST request.

Request

This endpoint expects an object.

typeenumRequired

Allowed values:

namestringRequired

public_ipstringRequired

the public ip of the VPN server to attach to

premise_cidrlist of stringsRequired

descriptionstringOptional

regionstringOptional

pskstringOptional

the PSK for the connection, if left empty it is generated by aws

asnintegerOptional

if type = 3 is selected, this parameter must be specified and denotes the autonomous system number

inside_cidrlist of stringsOptional

up to 3 private ip address ranges denoting the BGP routers CIDR. if left empty, these are generated

Response

Response to a POST that results in a creation, usually will return a Location header pointing to the location of the new resource

1	import requests
2
3	url = "https://cdn.emnify.net/api/v1/cnc/breakout/vpn"
4
5	payload = {
6	"type": 2,
7	"name": "Demo Attachment Dynamic VPN",
8	"public_ip": "192.0.2.1",
9	"premise_cidr": ["string"],
10	"region": "eu-west-1",
11	"psk": "secret123",
12	"asn": 65000,
13	"on_prem_cidr": ["10.0.0.0/24"]
14	}
15	headers = {
16	"Authorization": "Bearer <token>",
17	"Content-Type": "application/json"
18	}
19
20	response = requests.post(url, json=payload, headers=headers)
21
22	print(response.json())

Authentication

Request

Response

Errors