cloudConnect

Create a Cloud Connect attachment via IPSec VPN

<Info icon="fa-light fa-lock" className="permission-callout"> <div className="permission-callout__header"><span className="permission-callout__title"><span className="permission-callout__label">Required permissions</span> <span className="fern-docs-badge small blue subtle rounded-full permission-callout__beta">Beta</span></span> <span className="permission-callout__learn-more">[Learn more](/developers/api-guidelines/permissions#how-permissions-work)</span></div>

CloudConnect.Breakout.Vpn + Create

<div className="permission-callout__roles"><span className="permission-callout__roles-label">Roles:</span> <Badge intent="info">Administrator</Badge> <Badge intent="info">User</Badge></div> </Info>

Creates a Cloud Connect attachment via a specified VPN server. Currently two attachment types are available:

  • Static VPN (type 2): Basic IPSec VPN connection
  • Dynamic VPN with BGP (type 3): IPSec VPN with BGP routing. Requires asn (Autonomous System Number), otherwise dynamic routing is disabled. Optionally accepts inside_cidr for BGP tunnel interfaces.

The on_prem_cidr parameter specifies the CIDR ranges of your backend network (up to 3). The public_ip is the public IP address of your VPN server.

A psk (Pre-Shared Key) can be configured with 8-64 alphanumeric characters, periods (.), and underscores (_). It must not begin with 0. If left empty, it generates automatically and can be retrieved via GET /api/v1/cnc/breakout/{cloudconnect_attachment_id}.

<Success> The created connection is available within 3-5 minutes. </Success>
post/api/v1/cnc/breakout/vpn

Request

  • Base URL: https://cdn.emnify.net
  • URL: https://cdn.emnify.net/api/v1/cnc/breakout/vpn
  • Auth: HTTP bearer

Request body

namestring required

Display name for the Cloud Connect attachment.

descriptionstring

Optional description for the attachment.

regionstring

AWS region for the attachment (for example, eu-west-1).

public_ipstring required

Public IP address of your VPN server.

pskstring

Pre-shared key (PSK) for the VPN connection. If empty, AWS generates one automatically.

asninteger

Autonomous System Number (ASN) for BGP routing.

<Info> Required for Dynamic VPN (type `3`)." </Info>
on_prem_cidrstring[] required

CIDR ranges of your backend network. You can configure up to 3 ranges.

inside_cidrstring[]

For Dynamic VPN only: /30 CIDR ranges for BGP tunnel interfaces (up to 3). If empty, AWS generates them automatically.

Response

Attachment created successfully. The Location header contains the URL of the new resource.

CloudConnectCreateCloudConnectAttachmentVPNResponse201 required

Empty response body

Changes

No recorded changes to this operation across all 1 revision of this API.