For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Request featuresContact support
DocsAPI ReferenceGraphQLIntegrationsDeveloper Tools
DocsAPI ReferenceGraphQLIntegrationsDeveloper Tools
  • Authentication
    • POSTRetrieve authentication token
    • POSTCreate an MFA key
    • PATCHActivate MFA key
    • DELDelete an MFA key
    • GETList MFA key statuses
    • GETList MFA key types
    • GETList trusted devices
    • DELDelete a trusted device
  • Password Management and Activation
    • POSTInvite a user
    • POSTActivate user
    • POSTResend user activation email
    • PATCHChange password
  • Endpoint
    • GETList endpoints
    • POSTCreate an endpoint
    • POSTBulk create endpoints
    • DELBulk delete endpoints
    • PATCHBulk update endpoints
    • GETList endpoint statuses
    • GETEndpoint details
    • DELDelete an endpoint
    • PATCHUpdate an endpoint
    • GETEndpoint connectivity status
    • PATCHReset endpoint connectivity
    • GETList endpoint events
    • GETEndpoint usage and cost statistics
    • GETRetrieve daily usage statistics for an endpoint
    • GETList sent and received SMS
    • POSTSend SMS to an endpoint
    • GETSMS details
    • DELCancel SMS
    • GETRetrieve connectivity information for an endpoint
    • GETList active traffic limit extensions
    • POSTCreate traffic limit extension
    • DELDelete all traffic limit extensions for an endpoint
    • GETList operator blacklist for endpoint
    • PUTAdd an operator to the blacklist
    • DELRemove an operator from the blacklist
    • GETRetrieve data quota details
    • POSTSet data quota
    • DELRemove data quota
    • GETShow SMS quota details
    • POSTSet SMS quota
    • DELRemove SMS quota
  • Organization
    • GETOrganization usage and costs statistics per day for the current month
    • GETMy organization details
    • GETList organization statuses
    • GETMonthly organization traffic and cost statistics
    • GETDaily organization traffic and cost statistics
    • GETHourly organization traffic statistics
    • PATCHUpdate assigned tariff
    • PUTAssign a ratezone inclusive volume to an organization
    • GETGet list of active organization inclusive volumes
  • Sim
    • GETList SIMs
    • GETList SIM statuses
    • GETSIM details
    • DELDelete a SIM
    • PATCHUpdate a SIM
    • GETSIM usage and cost statistics
    • GETDaily SIM usage statistics
    • GETList SIM events
    • GETValidate SIM batch by BIC
    • PATCHRegister a given batch by BIC
    • DELBulk delete SIMs
    • POSTMigrate SIMs between Workspaces
  • Events
    • GETList events
    • GETList event types
  • Lookups
    • GETList country codes
    • GETList currencies
    • GETList data blocksizes
    • GETList data throttles
    • GETList breakout regions
    • GETList ESME interface types
    • GETList RAT types
    • GETGet list of service levels
  • Operator
    • GETList operators
  • Application Tokens
    • GETList application tokens
    • POSTCreate application token
    • PATCHUpdate application token
  • Tariff Profiles
    • GETList tariff profiles
    • POSTCreate tariff profile
    • GETTariff profile details
    • DELDelete tariff profile
    • PATCHUpdate tariff profile
    • PUTAssign ratezone to tarriff profile
    • DELDelete ratezone from tariff profile
    • GETGet the operator blocklist for a specific tariff profile
    • GETGet operator blocklist for a specific tariff profile
    • PUTBlock the operator completely for a given tariff profile
    • DELRemove an operator from the blocklist
    • POSTBlock specific RAT types
    • DELUnblock a specific RAT type
    • GETList tariff profile coverage
    • PUTAssign inclusive volume to tarriff profile
    • DELUnassign inclusive volume from tariff profile
  • Service Profiles
    • GETList service profiles
    • POSTCreate service profile
    • GETRetrieve a service profile
    • DELDelete a service profile
    • PATCHUpdate service profile
    • DELRemove all quotas of assigned endpoints
    • PUTAdd a service to a service profile
    • DELRemove a service from a service profile
    • PUTAdd SMS limit to service profile
    • DELRemove SMS limit from a service profile
    • GETList data limits of service profile
    • POSTAdd data limit to service profile
    • DELDelete all data limits of a service profile
    • DELRemove data limit from a service profile
  • Service Lookups and Configuration
    • GETList services
    • GETGet service SMS limit
    • GETList traffic limits
    • GETList DNS configs
    • POSTCreate DNS config
    • DELDelete DNS config
  • User Management
    • GETList user accounts
    • POSTCreate user
    • GETList user statuses
    • GETList user roles
    • GETGet user by ID or username
    • DELDelete user by ID
    • PATCHUpdate user by ID
    • GETList user events
    • GETList user role permissions
    • PUTAssign role to user
    • DELDelete user role
    • DELDelete user by ID
    • POSTCreate support access token for given user
  • IP Address Spaces
    • GETList IP address spaces
    • POSTCreate an IP address space
    • GETGet random address spaces
    • PUTAssign an IP address space to an organization
    • DELRelease an IP address space from an organization
  • Integrations
    • GETList data stream configurations of your organization
    • POSTCreate data stream
    • GETGet data stream statuses
    • GETGet data stream types
    • GETGet data stream filter fields
    • GETGet details on existing data stream
    • DELDelete existing data stream
    • PATCHModify existing data stream
    • POSTRestart existing data stream
    • GETRetrieve list of API callback URLs
    • POSTCreate a callback URL
    • GETGet a callback URL by ID
    • DELDelete a callback URL
    • GETList API callback secrets
    • POSTCreate a callback secret
    • GETGet a callback secret by ID
    • DELDelete a callback secret
  • Cloud Connect
    • GETList all Cloud Connect attachments of an organization
    • GETList Cloud Connect breakout types
    • GETView details of a Cloud Connect attachment
    • DELDelete a specific Cloud Connect attachment
    • PATCHRetry creation of an expired TGW breakout
    • POSTCreate a Cloud Connect attachment via Transit Gateway
    • POSTCreate a Cloud Connect attachment via IPSec VPN
    • GETList Cloud Connect prices
    • GETGet list of available Cloud Connect regions by breakout type
  • Tariff Plans
    • GETList organization tariff plans
    • GETRetrieve your organization's active tariff plan
    • GETGet the active tariff plan for the given organization
  • Workspaces
    • POSTSwitch to an assigned Workspace
    • POSTAccept user invitation
    • PUTAssign a role to a Workspace user
    • DELRemove a role from a Workspace user
    • PUTUpdate a user's default Workspace
    • GETList assigned Workspaces
    • DELUnassign a Workspace
    • PATCHUpdate user status in a Workspace
    • GETRetrieve Workspace daily stats
  • Tag Management
    • GETReturns the list of available tag colors
    • GETList tags
    • POSTCreate a tag
    • DELDelete a tag
    • PATCHUpdate a tag
    • GETList endpoint tags
    • POSTAssign a tag to an endpoint
    • DELUnassign a tag from an endpoint
    • POSTBulk assign tags
    • POSTBulk unassign tags
    • POSTBulk delete tags
  • Automations
    • GETList action logs
    • GETList available actions
    • GETGet an action by ID
    • GETList configured automations
    • POSTCreate an automation
    • GETGet configured automation by ID
    • DELDelete a configured automation
    • PATCHUpdate an automation
    • POSTVerify an automation recipient's email address
  • System Events
    • GETList system events
    • GETGet a system event by ID
  • Custom Events
    • GETList custom event templates
    • GETGet a custom event template by ID
    • GETList custom events
    • POSTDeploy custom event
    • GETGet a custom event by ID
    • DELDelete custom event
  • euicc
    • GETList eUICCs
    • GETList eUICC status
    • GETList eUICC Profile status
    • GETGet eUICC
    • POSTUnlinked eUICC validation
  • Euicc Operation
    • GETList operation action for eUICC
    • GETList operation status for eUICC
    • GETList operation for eUICC
    • POSTSchedule eUICC operations
    • GETGet operation details
    • DELCancel operation
  • Sim Unlinked Product Statistics
    • GETGet product statistics on unlinked eSIMs
  • Sim Operation
    • GETList SIM operation actions
    • GETList SIM operation status
    • GETList SIM operations for organization
    • POSTTrigger SIM operation
    • GETGet SIM operation details
LogoLogo
Request featuresContact support
Cloud Connect

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/cloudconnect_attachment_id \
>     -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        "outside_address": "198.51.100.1",
23        "inside_cidr": "169.254.59.80/30",
24        "psk": "my-preshared-key",
25        "metrics": {
26          "tunnel_state": "down",
27          "bytes_in": {
28            "Tue Oct 22 2019 10:24:00 GMT+0000 (Coordinated Universal Time)": 210,
29            "Tue Oct 22 2019 10:29:00 GMT+0000 (Coordinated Universal Time)": 336,
30            "Tue Oct 22 2019 10:34:00 GMT+0000 (Coordinated Universal Time)": 294,
31            "Tue Oct 22 2019 10:39:00 GMT+0000 (Coordinated Universal Time)": 210,
32            "Tue Oct 22 2019 10:44:00 GMT+0000 (Coordinated Universal Time)": 294,
33            "Tue Oct 22 2019 10:49:00 GMT+0000 (Coordinated Universal Time)": 210,
34            "Tue Oct 22 2019 10:54:00 GMT+0000 (Coordinated Universal Time)": 210,
35            "Tue Oct 22 2019 10:59:00 GMT+0000 (Coordinated Universal Time)": 294,
36            "Tue Oct 22 2019 11:04:00 GMT+0000 (Coordinated Universal Time)": 210,
37            "Tue Oct 22 2019 11:09:00 GMT+0000 (Coordinated Universal Time)": 210,
38            "Tue Oct 22 2019 11:14:00 GMT+0000 (Coordinated Universal Time)": 210,
39            "Tue Oct 22 2019 11:19:00 GMT+0000 (Coordinated Universal Time)": 210
40          },
41          "bytes_out": {
42            "Tue Oct 22 2019 10:24:00 GMT+0000 (Coordinated Universal Time)": 1616,
43            "Tue Oct 22 2019 10:29:00 GMT+0000 (Coordinated Universal Time)": 1520,
44            "Tue Oct 22 2019 10:34:00 GMT+0000 (Coordinated Universal Time)": 1700,
45            "Tue Oct 22 2019 10:39:00 GMT+0000 (Coordinated Universal Time)": 1394,
46            "Tue Oct 22 2019 10:44:00 GMT+0000 (Coordinated Universal Time)": 1700,
47            "Tue Oct 22 2019 10:49:00 GMT+0000 (Coordinated Universal Time)": 1394,
48            "Tue Oct 22 2019 10:54:00 GMT+0000 (Coordinated Universal Time)": 1616,
49            "Tue Oct 22 2019 10:59:00 GMT+0000 (Coordinated Universal Time)": 1478,
50            "Tue Oct 22 2019 11:04:00 GMT+0000 (Coordinated Universal Time)": 1616,
51            "Tue Oct 22 2019 11:09:00 GMT+0000 (Coordinated Universal Time)": 1394,
52            "Tue Oct 22 2019 11:14:00 GMT+0000 (Coordinated Universal Time)": 1616,
53            "Tue Oct 22 2019 11:19:00 GMT+0000 (Coordinated Universal Time)": 1394
54          }
55        },
56        "asn": 65000,
57        "public_ip": "192.0.2.1"
58      },
59      "1": {
60        "outside_address": "198.51.100.2",
61        "inside_cidr": "169.254.53.156/30",
62        "psk": "my-preshared-key",
63        "metrics": {
64          "tunnel_state": "up",
65          "bytes_in": {
66            "Tue Oct 22 2019 10:24:00 GMT+0000 (Coordinated Universal Time)": 210,
67            "Tue Oct 22 2019 10:29:00 GMT+0000 (Coordinated Universal Time)": 336,
68            "Tue Oct 22 2019 10:34:00 GMT+0000 (Coordinated Universal Time)": 294,
69            "Tue Oct 22 2019 10:39:00 GMT+0000 (Coordinated Universal Time)": 210,
70            "Tue Oct 22 2019 10:44:00 GMT+0000 (Coordinated Universal Time)": 210,
71            "Tue Oct 22 2019 10:49:00 GMT+0000 (Coordinated Universal Time)": 294,
72            "Tue Oct 22 2019 10:54:00 GMT+0000 (Coordinated Universal Time)": 210,
73            "Tue Oct 22 2019 10:59:00 GMT+0000 (Coordinated Universal Time)": 210,
74            "Tue Oct 22 2019 11:04:00 GMT+0000 (Coordinated Universal Time)": 210,
75            "Tue Oct 22 2019 11:09:00 GMT+0000 (Coordinated Universal Time)": 210,
76            "Tue Oct 22 2019 11:14:00 GMT+0000 (Coordinated Universal Time)": 294,
77            "Tue Oct 22 2019 11:19:00 GMT+0000 (Coordinated Universal Time)": 210
78          },
79          "bytes_out": {
80            "Tue Oct 22 2019 10:24:00 GMT+0000 (Coordinated Universal Time)": 1616,
81            "Tue Oct 22 2019 10:29:00 GMT+0000 (Coordinated Universal Time)": 1520,
82            "Tue Oct 22 2019 10:34:00 GMT+0000 (Coordinated Universal Time)": 1700,
83            "Tue Oct 22 2019 10:39:00 GMT+0000 (Coordinated Universal Time)": 1394,
84            "Tue Oct 22 2019 10:44:00 GMT+0000 (Coordinated Universal Time)": 1616,
85            "Tue Oct 22 2019 10:49:00 GMT+0000 (Coordinated Universal Time)": 1478,
86            "Tue Oct 22 2019 10:54:00 GMT+0000 (Coordinated Universal Time)": 1616,
87            "Tue Oct 22 2019 10:59:00 GMT+0000 (Coordinated Universal Time)": 1394,
88            "Tue Oct 22 2019 11:04:00 GMT+0000 (Coordinated Universal Time)": 1616,
89            "Tue Oct 22 2019 11:09:00 GMT+0000 (Coordinated Universal Time)": 1394,
90            "Tue Oct 22 2019 11:14:00 GMT+0000 (Coordinated Universal Time)": 1700,
91            "Tue Oct 22 2019 11:19:00 GMT+0000 (Coordinated Universal Time)": 1394
92          }
93        },
94        "asn": 65000,
95        "public_ip": "192.0.2.2"
96      }
97    },
98    "organisation_id": 123,
99    "customer_cidr": [
100      "10.0.0.0/24"
101    ]
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.

Was this page helpful?
Previous

List Cloud Connect breakout types

Next

Delete a specific Cloud Connect attachment

Built with

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_idstringRequired

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
statusobject
typeobject
regionstring
The customer region that this attachment belongs to
tunnel_informationobject