List all Cloud Connect attachments of an organization

GET

https://cdn.emnify.net/api/v1/cnc/breakout

GET

/api/v1/cnc/breakout

curl https://cdn.emnify.net/api/v1/cnc/breakout \
     -H "Authorization: Bearer <token>"

[
  {
    "id": 75,
    "name": "Attachment to StrongSwan",
    "user_id": 123,
    "creation_date": "2019-10-21T10:19:02.000Z",
    "aws_transit_gateway_attachment_id": "tgw-attach-0abce8655d0bafb83",
    "aws_vpn_connection_id": "vpn-0085c553b38c5deeb",
    "status": {
      "id": 5,
      "description": "Active"
    },
    "type": {
      "id": 3,
      "description": "IPSec VPN BGP"
    },
    "region": "eu-west-2",
    "organisation_id": 123
  },
  {
    "id": 104,
    "name": "Attachment to VPC",
    "user_id": 123,
    "creation_date": "2019-10-22T07:59:26.000Z",
    "aws_transit_gateway_attachment_id": "tgw-attach-0f84169771fa2f4a3",
    "status": {
      "id": 5,
      "description": "Active"
    },
    "type": {
      "id": 1,
      "description": "Transit Gateway"
    },
    "region": "eu-west-1",
    "organisation_id": 123
  }
]

CloudConnect.Breakout + List

Roles: Administrator User Observer

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.

<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.

Authentication

AuthorizationBearer

An auth_token should be provided to authenticate a session.

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

Query parameters

statusenumOptional

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

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

typeenumOptional

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)

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)

organisationdoubleOptional

Numerical ID of an Organization

Response

idintegerOptional

namestringOptional

descriptionstringOptional

user_idintegerOptional

creation_datestringOptional

The date this attachment was created in UTC

accept_attachment_expiry_datestringOptional

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_datestringOptional

aws_transit_gateway_attachment_idstringOptional

aws_vpn_connection_idstringOptional

This is only set when the breakout is a VPN attachment

statusobjectOptional

typeobjectOptional

regionstringOptional

The customer region that this attachment belongs to

Errors

403

Forbidden Error