cloudConnect

List all Cloud Connect attachments of an organization

<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 + List

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

Lists all Cloud Connect attachments of the logged in organisation if it is an Enterprise. For Master organisations it lists all attachments of the direct child organisations. Deleted attachments are left out by default.

Additionally the attachments can be filtered by status and type. Master organisations can also filter by organisation ID of their direct child organisations.

get/api/v1/cnc/breakout

Request

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

Query parameters

status'1' | '2' | '3' | '4' | '5' | '6' | '7' | '8'

Numerical ID of the Cloud Connect attachment status

  • 1 - Pending Customer Action
  • 2 - Pending AWS Activation
  • 3 - Pending EGN Activation
  • 4 - Pending CRG Activation
  • 5 - Active
  • 6 - Deactivation Pending
  • 7 - Deactivated
  • 8 - Rolling Back
type'1' | '2' | '3' | '4' | '5' | '6' | '7' | '8'

Numerical ID of the Cloud Connect attachment type

  • 1 - Transit Gateway
  • 2 - IPSec VPN
  • 3 - IPSec VPN BGP
  • 4 - IPSec VPN BGP High Availability
  • 5 - Direct Connect
  • 6 - Shared
  • 7 - Transit Gateway (Classic)
  • 8 - IPSec VPN (Classic)
organisationnumber double

Numerical ID of an Organization

Response

OK

idinteger
namestring
descriptionstring
user_idinteger
creation_datestring

The date this attachment was created in UTC

accept_attachment_expiry_datestring

The expiry date of the accept attachment state in UTC. This will only be returned if the breakout is of type Transit Gateway (type_id: 1) and in Status Pending AWS Actvation (status_id: 2)

termination_datestring
aws_transit_gateway_attachment_idstring
aws_vpn_connection_idstring

This is only set when the breakout is a VPN attachment

regionstring

The customer region that this attachment belongs to

Changes

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