View details of a Cloud Connect attachment

GET

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

GET

/api/v1/cnc/breakout/:cloudconnect_attachment_id

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

200Retrieved Cloud Connect Attachment

1 [
2   {
3     "id": 123,
4     "name": "Attachment to dynamic VPN",
5     "description": "Description for Attachment to dynamic VPN",
6     "user_id": 123,
7     "creation_date": "2019-10-22T10:07:45.000Z",
8     "termination_date": null,
9     "aws_transit_gateway_attachment_id": "tgw-attach-00efd80dc6288e61a",
10     "aws_vpn_connection_id": "vpn-06aa01dfec8d0060f",
11     "status": {
12       "id": 5,
13       "description": "Active"
14     },
15     "type": {
16       "id": 3,
17       "description": "IPSec VPN BGP"
18     },
19     "region": "eu-west-1",
20     "tunnel_information": {
21       "0": {
22         "asn": 65000,
23         "inside_cidr": "169.254.59.80/30",
24         "metrics": {
25           "bytes_in": {
26             "Tue Oct 22 2019 10:24:00 GMT+0000 (Coordinated Universal Time)": 210,
27             "Tue Oct 22 2019 10:29:00 GMT+0000 (Coordinated Universal Time)": 336,
28             "Tue Oct 22 2019 10:34:00 GMT+0000 (Coordinated Universal Time)": 294,
29             "Tue Oct 22 2019 10:39:00 GMT+0000 (Coordinated Universal Time)": 210,
30             "Tue Oct 22 2019 10:44:00 GMT+0000 (Coordinated Universal Time)": 294,
31             "Tue Oct 22 2019 10:49:00 GMT+0000 (Coordinated Universal Time)": 210,
32             "Tue Oct 22 2019 10:54:00 GMT+0000 (Coordinated Universal Time)": 210,
33             "Tue Oct 22 2019 10:59:00 GMT+0000 (Coordinated Universal Time)": 294,
34             "Tue Oct 22 2019 11:04:00 GMT+0000 (Coordinated Universal Time)": 210,
35             "Tue Oct 22 2019 11:09:00 GMT+0000 (Coordinated Universal Time)": 210,
36             "Tue Oct 22 2019 11:14:00 GMT+0000 (Coordinated Universal Time)": 210,
37             "Tue Oct 22 2019 11:19:00 GMT+0000 (Coordinated Universal Time)": 210
38           },
39           "bytes_out": {
40             "Tue Oct 22 2019 10:24:00 GMT+0000 (Coordinated Universal Time)": 1616,
41             "Tue Oct 22 2019 10:29:00 GMT+0000 (Coordinated Universal Time)": 1520,
42             "Tue Oct 22 2019 10:34:00 GMT+0000 (Coordinated Universal Time)": 1700,
43             "Tue Oct 22 2019 10:39:00 GMT+0000 (Coordinated Universal Time)": 1394,
44             "Tue Oct 22 2019 10:44:00 GMT+0000 (Coordinated Universal Time)": 1700,
45             "Tue Oct 22 2019 10:49:00 GMT+0000 (Coordinated Universal Time)": 1394,
46             "Tue Oct 22 2019 10:54:00 GMT+0000 (Coordinated Universal Time)": 1616,
47             "Tue Oct 22 2019 10:59:00 GMT+0000 (Coordinated Universal Time)": 1478,
48             "Tue Oct 22 2019 11:04:00 GMT+0000 (Coordinated Universal Time)": 1616,
49             "Tue Oct 22 2019 11:09:00 GMT+0000 (Coordinated Universal Time)": 1394,
50             "Tue Oct 22 2019 11:14:00 GMT+0000 (Coordinated Universal Time)": 1616,
51             "Tue Oct 22 2019 11:19:00 GMT+0000 (Coordinated Universal Time)": 1394
52           },
53           "tunnel_state": "down"
54         },
55         "outside_address": "198.51.100.1",
56         "psk": "my-preshared-key",
57         "public_ip": "192.0.2.1"
58       },
59       "1": {
60         "asn": 65000,
61         "inside_cidr": "169.254.53.156/30",
62         "metrics": {
63           "bytes_in": {
64             "Tue Oct 22 2019 10:24:00 GMT+0000 (Coordinated Universal Time)": 210,
65             "Tue Oct 22 2019 10:29:00 GMT+0000 (Coordinated Universal Time)": 336,
66             "Tue Oct 22 2019 10:34:00 GMT+0000 (Coordinated Universal Time)": 294,
67             "Tue Oct 22 2019 10:39:00 GMT+0000 (Coordinated Universal Time)": 210,
68             "Tue Oct 22 2019 10:44:00 GMT+0000 (Coordinated Universal Time)": 210,
69             "Tue Oct 22 2019 10:49:00 GMT+0000 (Coordinated Universal Time)": 294,
70             "Tue Oct 22 2019 10:54:00 GMT+0000 (Coordinated Universal Time)": 210,
71             "Tue Oct 22 2019 10:59:00 GMT+0000 (Coordinated Universal Time)": 210,
72             "Tue Oct 22 2019 11:04:00 GMT+0000 (Coordinated Universal Time)": 210,
73             "Tue Oct 22 2019 11:09:00 GMT+0000 (Coordinated Universal Time)": 210,
74             "Tue Oct 22 2019 11:14:00 GMT+0000 (Coordinated Universal Time)": 294,
75             "Tue Oct 22 2019 11:19:00 GMT+0000 (Coordinated Universal Time)": 210
76           },
77           "bytes_out": {
78             "Tue Oct 22 2019 10:24:00 GMT+0000 (Coordinated Universal Time)": 1616,
79             "Tue Oct 22 2019 10:29:00 GMT+0000 (Coordinated Universal Time)": 1520,
80             "Tue Oct 22 2019 10:34:00 GMT+0000 (Coordinated Universal Time)": 1700,
81             "Tue Oct 22 2019 10:39:00 GMT+0000 (Coordinated Universal Time)": 1394,
82             "Tue Oct 22 2019 10:44:00 GMT+0000 (Coordinated Universal Time)": 1616,
83             "Tue Oct 22 2019 10:49:00 GMT+0000 (Coordinated Universal Time)": 1478,
84             "Tue Oct 22 2019 10:54:00 GMT+0000 (Coordinated Universal Time)": 1616,
85             "Tue Oct 22 2019 10:59:00 GMT+0000 (Coordinated Universal Time)": 1394,
86             "Tue Oct 22 2019 11:04:00 GMT+0000 (Coordinated Universal Time)": 1616,
87             "Tue Oct 22 2019 11:09:00 GMT+0000 (Coordinated Universal Time)": 1394,
88             "Tue Oct 22 2019 11:14:00 GMT+0000 (Coordinated Universal Time)": 1700,
89             "Tue Oct 22 2019 11:19:00 GMT+0000 (Coordinated Universal Time)": 1394
90           },
91           "tunnel_state": "up"
92         },
93         "outside_address": "198.51.100.2",
94         "psk": "my-preshared-key",
95         "public_ip": "192.0.2.2"
96       }
97     },
98     "customer_cidr": [
99       "10.0.0.0/24"
100     ],
101     "organisation_id": 123
102   }
103 ]

Displays the details including configured CIDR blocks of a Cloud Connect Attachment.

For active IPSec VPN attachments, the tunnel information (public IP, outisde address, inside CIDR, PSK, ASN) including metrics over the last hour (tunnel state, bytes in/out) will be displayed as well.

Authentication

AuthorizationBearer

An auth_token should be provided to authenticate a session.

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

Path parameters

cloudconnect_attachment_iddoubleRequired

Numerical ID of a Cloud Connect attachment

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

tunnel_informationobjectOptional