Skip to content

Latest commit

 

History

History
252 lines (138 loc) · 9.87 KB

CloudConnectApi.md

File metadata and controls

252 lines (138 loc) · 9.87 KB

\CloudConnectApi

All URIs are relative to https://cdn.emnify.net

Method HTTP request Description
create_cloud_connect_attachment_tgw post /api/v1/cnc/breakout/tgw Create a CloudConnect attachment via Transit Gateway
create_cloud_connect_attachment_vpn post /api/v1/cnc/breakout/vpn Create a CloudConnect attachment via IPSec VPN
delete_cloud_connect_attachment delete /api/v1/cnc/breakout/{cloudconnect_attachment_id} Delete a specific CloudConnect attachment
get_cloud_connect_attachment_by_id get /api/v1/cnc/breakout/{cloudconnect_attachment_id} View details of a CloudConnect attachment
get_cloud_connect_attachments get /api/v1/cnc/breakout List all CloudConnect attachments of an organisation
get_cloud_connect_breakout_types get /api/v1/cnc/breakout_type List CloudConnect breakout types
get_cloud_connect_regions get /api/v1/cnc/region Get list of available CloudConnect regions
list_cloud_connect_custom_prices get /api/v1/cnc/pricing List CloudConnect prices

create_cloud_connect_attachment_tgw

create_cloud_connect_attachment_tgw(create_cloud_connect_tgw_request) Create a CloudConnect attachment via Transit Gateway

Creates a Transit Gateway breakout towards the customer AWS account. After the creation the following steps have to be made from the customer's AWS account: 1. Accept the resource share about the 'CloudConnect' TransitGateway 2. Create a Transit Gateway Attachment to the own VPC with the services to connect to More Information about this can be found on the CloudConnect KnowledgeBase article.

Parameters

Name Type Description Required Notes
create_cloud_connect_tgw_request Option<CreateCloudConnectTgwRequest>

Return type

(empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

create_cloud_connect_attachment_vpn

create_cloud_connect_attachment_vpn(create_cloud_connect_vpn_request1) Create a CloudConnect attachment via IPSec VPN

Creates a CloudConnect attachment via a specified VPN server. Currently Static and Dynamic (BGP) VPN attachments are available. The created connection will be available within 3-5 minutes.

Parameters

Name Type Description Required Notes
create_cloud_connect_vpn_request1 Option<CreateCloudConnectVpnRequest1>

Return type

(empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_cloud_connect_attachment

delete_cloud_connect_attachment(cloudconnect_attachment_id) Delete a specific CloudConnect attachment

Deletes the specified CloudConnect attachment. Only the user that created the attachment can delete it. Attachments cannot be deleted if they are in the state 7 (Deactivated) or 8 (Rolling Back) or if they are Classic attachments.

Parameters

Name Type Description Required Notes
cloudconnect_attachment_id f32 Numerical ID of a CloudConnect attachment [required]

Return type

(empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_cloud_connect_attachment_by_id

Vec<serde_json::Value> get_cloud_connect_attachment_by_id(cloudconnect_attachment_id) View details of a CloudConnect attachment

Displays the details including configured CIDR blocks of a CloudConnect 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.

Parameters

Name Type Description Required Notes
cloudconnect_attachment_id f32 Numerical ID of a CloudConnect attachment [required]

Return type

Vec<serde_json::Value>

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_cloud_connect_attachments

Veccrate::models::InlineResponse2006 get_cloud_connect_attachments(status, _type, organisation) List all CloudConnect attachments of an organisation

Lists all CloudConnect 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.

Parameters

Name Type Description Required Notes
status Option<f32> Numerical ID of the CloudConnect 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 Option<f32> Numerical ID of the CloudConnect 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)
organisation Option<f32> Numerical ID of an Organisation

Return type

Veccrate::models::InlineResponse2006

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_cloud_connect_breakout_types

Veccrate::models::CloudConnectBreakoutType get_cloud_connect_breakout_types() List CloudConnect breakout types

Lists all CloudConnect breakout types.

Parameters

This endpoint does not need any parameter.

Return type

Veccrate::models::CloudConnectBreakoutType

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_cloud_connect_regions

get_cloud_connect_regions(_type) Get list of available CloudConnect regions

Returns a list of regions available for use when creating new CloudConnect breakouts. The result can be filtered by breakout type.

Parameters

Name Type Description Required Notes
_type Option<i32> Breakout type ID to filter the results for. Possible values can be retrieved with GET /api/v1/cnc/breakout_type.

Return type

(empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_cloud_connect_custom_prices

Vec<serde_json::Value> list_cloud_connect_custom_prices() List CloudConnect prices

Returns a list of the configured monthly prices for CloudConnect breakouts. Master organisation, Mobile Network Operators and Resellers will get the list of prices they have configured for their child organisations. Enterprise organisations will get the list of prices that apply for them.

Parameters

This endpoint does not need any parameter.

Return type

Vec<serde_json::Value>

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]