Skip to content
Cloudflare API
Start here
API Reference
Magic Cloud Networking
On Ramps

Read On-ramp

client.magicCloudNetworking.onRamps.get(stringonrampId, OnRampGetParams { account_id, planned_resources, post_apply_resources, 2 more } params, RequestOptionsoptions?): OnRampGetResponse { id, cloud_type, dynamic_routing, 26 more }
GET/accounts/{account_id}/magic/cloud/onramps/{onramp_id}

Read an On-ramp (Closed Beta).

Security
API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
Accepted Permissions (at least one required)
Magic WAN WriteMagic WAN Read
ParametersExpand Collapse
onrampId: string
formatuuid
params: OnRampGetParams { account_id, planned_resources, post_apply_resources, 2 more }
account_id: string

Path param

planned_resources?: boolean

Query param

post_apply_resources?: boolean

Query param

status?: boolean

Query param

vpcs?: boolean

Query param

ReturnsExpand Collapse
OnRampGetResponse { id, cloud_type, dynamic_routing, 26 more }
id: string
formatuuid
cloud_type: "AWS" | "AZURE" | "GOOGLE"
One of the following:
"AWS"
"AZURE"
"GOOGLE"
dynamic_routing: boolean
install_routes_in_cloud: boolean
install_routes_in_magic_wan: boolean
name: string
type: "OnrampTypeSingle" | "OnrampTypeHub"
One of the following:
"OnrampTypeSingle"
"OnrampTypeHub"
updated_at: string
attached_hubs?: Array<string>
attached_vpcs?: Array<string>
cloud_asn?: number
formatuint32
description?: string
hub?: string
formatuuid
last_applied_at?: string
last_exported_at?: string
last_planned_at?: string
manage_hub_to_hub_attachments?: boolean
manage_vpc_to_hub_attachments?: boolean
planned_monthly_cost_estimate?: PlannedMonthlyCostEstimate { currency, current_monthly_cost, diff, proposed_monthly_cost }
currency: string
current_monthly_cost: number
formatdouble
diff: number
formatdouble
proposed_monthly_cost: number
formatdouble
planned_resources?: Array<PlannedResource>
diff: Diff { diff, left_description, left_yaml, 2 more }
diff: string
left_description: string
left_yaml: string
right_description: string
right_yaml: string
keys_require_replace: Array<string>
monthly_cost_estimate_diff: MonthlyCostEstimateDiff { currency, current_monthly_cost, diff, proposed_monthly_cost }
currency: string
current_monthly_cost: number
formatdouble
diff: number
formatdouble
proposed_monthly_cost: number
formatdouble
planned_action: "no_op" | "create" | "update" | 2 more
One of the following:
"no_op"
"create"
"update"
"replace"
"destroy"
resource: Resource { id, cloud_type, detail, 3 more }
id: string
formatuuid
cloud_type: "AWS" | "AZURE" | "GOOGLE" | "CLOUDFLARE"
One of the following:
"AWS"
"AZURE"
"GOOGLE"
"CLOUDFLARE"
detail: string
name: string
resource_type: "aws_customer_gateway" | "aws_egress_only_internet_gateway" | "aws_internet_gateway" | 54 more
One of the following:
"aws_customer_gateway"
"aws_egress_only_internet_gateway"
"aws_internet_gateway"
"aws_instance"
"aws_network_interface"
"aws_route"
"aws_route_table"
"aws_route_table_association"
"aws_subnet"
"aws_vpc"
"aws_vpc_ipv4_cidr_block_association"
"aws_vpn_connection"
"aws_vpn_connection_route"
"aws_vpn_gateway"
"aws_security_group"
"aws_vpc_security_group_ingress_rule"
"aws_vpc_security_group_egress_rule"
"aws_ec2_managed_prefix_list"
"aws_ec2_transit_gateway"
"aws_ec2_transit_gateway_prefix_list_reference"
"aws_ec2_transit_gateway_vpc_attachment"
"azurerm_application_security_group"
"azurerm_lb"
"azurerm_lb_backend_address_pool"
"azurerm_lb_nat_pool"
"azurerm_lb_nat_rule"
"azurerm_lb_rule"
"azurerm_local_network_gateway"
"azurerm_network_interface"
"azurerm_network_interface_application_security_group_association"
"azurerm_network_interface_backend_address_pool_association"
"azurerm_network_interface_security_group_association"
"azurerm_network_security_group"
"azurerm_public_ip"
"azurerm_route"
"azurerm_route_table"
"azurerm_subnet"
"azurerm_subnet_route_table_association"
"azurerm_virtual_machine"
"azurerm_virtual_network_gateway_connection"
"azurerm_virtual_network"
"azurerm_virtual_network_gateway"
"google_compute_network"
"google_compute_subnetwork"
"google_compute_vpn_gateway"
"google_compute_vpn_tunnel"
"google_compute_route"
"google_compute_address"
"google_compute_global_address"
"google_compute_router"
"google_compute_interconnect_attachment"
"google_compute_ha_vpn_gateway"
"google_compute_forwarding_rule"
"google_compute_network_firewall_policy"
"google_compute_network_firewall_policy_rule"
"cloudflare_static_route"
"cloudflare_ipsec_tunnel"
title: string
planned_resources_unavailable?: boolean
post_apply_monthly_cost_estimate?: PostApplyMonthlyCostEstimate { currency, monthly_cost }
currency: string
monthly_cost: number
formatdouble
post_apply_resources?: Record<string, PostApplyResources>
id: string
formatuuid
account_id: string
cloud_type: "AWS" | "AZURE" | "GOOGLE" | "CLOUDFLARE"
One of the following:
"AWS"
"AZURE"
"GOOGLE"
"CLOUDFLARE"
config: Record<string, unknown>
deployment_provider: string
formatuuid
managed: boolean
monthly_cost_estimate: MonthlyCostEstimate { currency, monthly_cost }
currency: string
monthly_cost: number
formatdouble
name: string
native_id: string
observations: Record<string, Observations>
first_observed_at: string
last_observed_at: string
provider_id: string
formatuuid
resource_id: string
formatuuid
provider_ids: Array<string>
provider_names_by_id: Record<string, string>
region: string
resource_group: string
resource_type: "aws_customer_gateway" | "aws_egress_only_internet_gateway" | "aws_internet_gateway" | 54 more
One of the following:
"aws_customer_gateway"
"aws_egress_only_internet_gateway"
"aws_internet_gateway"
"aws_instance"
"aws_network_interface"
"aws_route"
"aws_route_table"
"aws_route_table_association"
"aws_subnet"
"aws_vpc"
"aws_vpc_ipv4_cidr_block_association"
"aws_vpn_connection"
"aws_vpn_connection_route"
"aws_vpn_gateway"
"aws_security_group"
"aws_vpc_security_group_ingress_rule"
"aws_vpc_security_group_egress_rule"
"aws_ec2_managed_prefix_list"
"aws_ec2_transit_gateway"
"aws_ec2_transit_gateway_prefix_list_reference"
"aws_ec2_transit_gateway_vpc_attachment"
"azurerm_application_security_group"
"azurerm_lb"
"azurerm_lb_backend_address_pool"
"azurerm_lb_nat_pool"
"azurerm_lb_nat_rule"
"azurerm_lb_rule"
"azurerm_local_network_gateway"
"azurerm_network_interface"
"azurerm_network_interface_application_security_group_association"
"azurerm_network_interface_backend_address_pool_association"
"azurerm_network_interface_security_group_association"
"azurerm_network_security_group"
"azurerm_public_ip"
"azurerm_route"
"azurerm_route_table"
"azurerm_subnet"
"azurerm_subnet_route_table_association"
"azurerm_virtual_machine"
"azurerm_virtual_network_gateway_connection"
"azurerm_virtual_network"
"azurerm_virtual_network_gateway"
"google_compute_network"
"google_compute_subnetwork"
"google_compute_vpn_gateway"
"google_compute_vpn_tunnel"
"google_compute_route"
"google_compute_address"
"google_compute_global_address"
"google_compute_router"
"google_compute_interconnect_attachment"
"google_compute_ha_vpn_gateway"
"google_compute_forwarding_rule"
"google_compute_network_firewall_policy"
"google_compute_network_firewall_policy_rule"
"cloudflare_static_route"
"cloudflare_ipsec_tunnel"
sections: Array<Section>
hidden_items: Array<HiddenItem>
helpText?: string
name?: string
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
One of the following:
McnStringItem { item_type, string }
item_type: string
string: string
McnYamlItem { item_type, yaml }
item_type: string
yaml: string
McnYamlDiffItem { item_type, yaml_diff }
item_type: string
yaml_diff: YamlDiff { diff, left_description, left_yaml, 2 more }
diff: string
left_description: string
left_yaml: string
right_description: string
right_yaml: string
McnResourcePreviewItem { item_type, resource_preview }
item_type: string
resource_preview: ResourcePreview { id, cloud_type, detail, 3 more }
id: string
formatuuid
cloud_type: "AWS" | "AZURE" | "GOOGLE" | "CLOUDFLARE"
One of the following:
"AWS"
"AZURE"
"GOOGLE"
"CLOUDFLARE"
detail: string
name: string
resource_type: "aws_customer_gateway" | "aws_egress_only_internet_gateway" | "aws_internet_gateway" | 54 more
One of the following:
"aws_customer_gateway"
"aws_egress_only_internet_gateway"
"aws_internet_gateway"
"aws_instance"
"aws_network_interface"
"aws_route"
"aws_route_table"
"aws_route_table_association"
"aws_subnet"
"aws_vpc"
"aws_vpc_ipv4_cidr_block_association"
"aws_vpn_connection"
"aws_vpn_connection_route"
"aws_vpn_gateway"
"aws_security_group"
"aws_vpc_security_group_ingress_rule"
"aws_vpc_security_group_egress_rule"
"aws_ec2_managed_prefix_list"
"aws_ec2_transit_gateway"
"aws_ec2_transit_gateway_prefix_list_reference"
"aws_ec2_transit_gateway_vpc_attachment"
"azurerm_application_security_group"
"azurerm_lb"
"azurerm_lb_backend_address_pool"
"azurerm_lb_nat_pool"
"azurerm_lb_nat_rule"
"azurerm_lb_rule"
"azurerm_local_network_gateway"
"azurerm_network_interface"
"azurerm_network_interface_application_security_group_association"
"azurerm_network_interface_backend_address_pool_association"
"azurerm_network_interface_security_group_association"
"azurerm_network_security_group"
"azurerm_public_ip"
"azurerm_route"
"azurerm_route_table"
"azurerm_subnet"
"azurerm_subnet_route_table_association"
"azurerm_virtual_machine"
"azurerm_virtual_network_gateway_connection"
"azurerm_virtual_network"
"azurerm_virtual_network_gateway"
"google_compute_network"
"google_compute_subnetwork"
"google_compute_vpn_gateway"
"google_compute_vpn_tunnel"
"google_compute_route"
"google_compute_address"
"google_compute_global_address"
"google_compute_router"
"google_compute_interconnect_attachment"
"google_compute_ha_vpn_gateway"
"google_compute_forwarding_rule"
"google_compute_network_firewall_policy"
"google_compute_network_firewall_policy_rule"
"cloudflare_static_route"
"cloudflare_ipsec_tunnel"
title: string
McnListItem { item_type, list }
item_type: string
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
One of the following:
McnStringItem { item_type, string }
item_type: string
string: string
McnResourcePreviewItem { item_type, resource_preview }
item_type: string
resource_preview: ResourcePreview { id, cloud_type, detail, 3 more }
id: string
formatuuid
cloud_type: "AWS" | "AZURE" | "GOOGLE" | "CLOUDFLARE"
One of the following:
"AWS"
"AZURE"
"GOOGLE"
"CLOUDFLARE"
detail: string
name: string
resource_type: "aws_customer_gateway" | "aws_egress_only_internet_gateway" | "aws_internet_gateway" | 54 more
One of the following:
"aws_customer_gateway"
"aws_egress_only_internet_gateway"
"aws_internet_gateway"
"aws_instance"
"aws_network_interface"
"aws_route"
"aws_route_table"
"aws_route_table_association"
"aws_subnet"
"aws_vpc"
"aws_vpc_ipv4_cidr_block_association"
"aws_vpn_connection"
"aws_vpn_connection_route"
"aws_vpn_gateway"
"aws_security_group"
"aws_vpc_security_group_ingress_rule"
"aws_vpc_security_group_egress_rule"
"aws_ec2_managed_prefix_list"
"aws_ec2_transit_gateway"
"aws_ec2_transit_gateway_prefix_list_reference"
"aws_ec2_transit_gateway_vpc_attachment"
"azurerm_application_security_group"
"azurerm_lb"
"azurerm_lb_backend_address_pool"
"azurerm_lb_nat_pool"
"azurerm_lb_nat_rule"
"azurerm_lb_rule"
"azurerm_local_network_gateway"
"azurerm_network_interface"
"azurerm_network_interface_application_security_group_association"
"azurerm_network_interface_backend_address_pool_association"
"azurerm_network_interface_security_group_association"
"azurerm_network_security_group"
"azurerm_public_ip"
"azurerm_route"
"azurerm_route_table"
"azurerm_subnet"
"azurerm_subnet_route_table_association"
"azurerm_virtual_machine"
"azurerm_virtual_network_gateway_connection"
"azurerm_virtual_network"
"azurerm_virtual_network_gateway"
"google_compute_network"
"google_compute_subnetwork"
"google_compute_vpn_gateway"
"google_compute_vpn_tunnel"
"google_compute_route"
"google_compute_address"
"google_compute_global_address"
"google_compute_router"
"google_compute_interconnect_attachment"
"google_compute_ha_vpn_gateway"
"google_compute_forwarding_rule"
"google_compute_network_firewall_policy"
"google_compute_network_firewall_policy_rule"
"cloudflare_static_route"
"cloudflare_ipsec_tunnel"
title: string
name: string
visible_items: Array<VisibleItem>
helpText?: string
name?: string
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
One of the following:
McnStringItem { item_type, string }
item_type: string
string: string
McnYamlItem { item_type, yaml }
item_type: string
yaml: string
McnYamlDiffItem { item_type, yaml_diff }
item_type: string
yaml_diff: YamlDiff { diff, left_description, left_yaml, 2 more }
diff: string
left_description: string
left_yaml: string
right_description: string
right_yaml: string
McnResourcePreviewItem { item_type, resource_preview }
item_type: string
resource_preview: ResourcePreview { id, cloud_type, detail, 3 more }
id: string
formatuuid
cloud_type: "AWS" | "AZURE" | "GOOGLE" | "CLOUDFLARE"
One of the following:
"AWS"
"AZURE"
"GOOGLE"
"CLOUDFLARE"
detail: string
name: string
resource_type: "aws_customer_gateway" | "aws_egress_only_internet_gateway" | "aws_internet_gateway" | 54 more
One of the following:
"aws_customer_gateway"
"aws_egress_only_internet_gateway"
"aws_internet_gateway"
"aws_instance"
"aws_network_interface"
"aws_route"
"aws_route_table"
"aws_route_table_association"
"aws_subnet"
"aws_vpc"
"aws_vpc_ipv4_cidr_block_association"
"aws_vpn_connection"
"aws_vpn_connection_route"
"aws_vpn_gateway"
"aws_security_group"
"aws_vpc_security_group_ingress_rule"
"aws_vpc_security_group_egress_rule"
"aws_ec2_managed_prefix_list"
"aws_ec2_transit_gateway"
"aws_ec2_transit_gateway_prefix_list_reference"
"aws_ec2_transit_gateway_vpc_attachment"
"azurerm_application_security_group"
"azurerm_lb"
"azurerm_lb_backend_address_pool"
"azurerm_lb_nat_pool"
"azurerm_lb_nat_rule"
"azurerm_lb_rule"
"azurerm_local_network_gateway"
"azurerm_network_interface"
"azurerm_network_interface_application_security_group_association"
"azurerm_network_interface_backend_address_pool_association"
"azurerm_network_interface_security_group_association"
"azurerm_network_security_group"
"azurerm_public_ip"
"azurerm_route"
"azurerm_route_table"
"azurerm_subnet"
"azurerm_subnet_route_table_association"
"azurerm_virtual_machine"
"azurerm_virtual_network_gateway_connection"
"azurerm_virtual_network"
"azurerm_virtual_network_gateway"
"google_compute_network"
"google_compute_subnetwork"
"google_compute_vpn_gateway"
"google_compute_vpn_tunnel"
"google_compute_route"
"google_compute_address"
"google_compute_global_address"
"google_compute_router"
"google_compute_interconnect_attachment"
"google_compute_ha_vpn_gateway"
"google_compute_forwarding_rule"
"google_compute_network_firewall_policy"
"google_compute_network_firewall_policy_rule"
"cloudflare_static_route"
"cloudflare_ipsec_tunnel"
title: string
McnListItem { item_type, list }
item_type: string
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
One of the following:
McnStringItem { item_type, string }
item_type: string
string: string
McnResourcePreviewItem { item_type, resource_preview }
item_type: string
resource_preview: ResourcePreview { id, cloud_type, detail, 3 more }
id: string
formatuuid
cloud_type: "AWS" | "AZURE" | "GOOGLE" | "CLOUDFLARE"
One of the following:
"AWS"
"AZURE"
"GOOGLE"
"CLOUDFLARE"
detail: string
name: string
resource_type: "aws_customer_gateway" | "aws_egress_only_internet_gateway" | "aws_internet_gateway" | 54 more
One of the following:
"aws_customer_gateway"
"aws_egress_only_internet_gateway"
"aws_internet_gateway"
"aws_instance"
"aws_network_interface"
"aws_route"
"aws_route_table"
"aws_route_table_association"
"aws_subnet"
"aws_vpc"
"aws_vpc_ipv4_cidr_block_association"
"aws_vpn_connection"
"aws_vpn_connection_route"
"aws_vpn_gateway"
"aws_security_group"
"aws_vpc_security_group_ingress_rule"
"aws_vpc_security_group_egress_rule"
"aws_ec2_managed_prefix_list"
"aws_ec2_transit_gateway"
"aws_ec2_transit_gateway_prefix_list_reference"
"aws_ec2_transit_gateway_vpc_attachment"
"azurerm_application_security_group"
"azurerm_lb"
"azurerm_lb_backend_address_pool"
"azurerm_lb_nat_pool"
"azurerm_lb_nat_rule"
"azurerm_lb_rule"
"azurerm_local_network_gateway"
"azurerm_network_interface"
"azurerm_network_interface_application_security_group_association"
"azurerm_network_interface_backend_address_pool_association"
"azurerm_network_interface_security_group_association"
"azurerm_network_security_group"
"azurerm_public_ip"
"azurerm_route"
"azurerm_route_table"
"azurerm_subnet"
"azurerm_subnet_route_table_association"
"azurerm_virtual_machine"
"azurerm_virtual_network_gateway_connection"
"azurerm_virtual_network"
"azurerm_virtual_network_gateway"
"google_compute_network"
"google_compute_subnetwork"
"google_compute_vpn_gateway"
"google_compute_vpn_tunnel"
"google_compute_route"
"google_compute_address"
"google_compute_global_address"
"google_compute_router"
"google_compute_interconnect_attachment"
"google_compute_ha_vpn_gateway"
"google_compute_forwarding_rule"
"google_compute_network_firewall_policy"
"google_compute_network_firewall_policy_rule"
"cloudflare_static_route"
"cloudflare_ipsec_tunnel"
title: string
help_text?: string
state: Record<string, unknown>
tags: Record<string, string>
updated_at: string
url: string
managed_by?: Array<ManagedBy>
id: string
formatuuid
client_type: "MAGIC_WAN_CLOUD_ONRAMP"
name: string
post_apply_resources_unavailable?: boolean
region?: string
status?: Status { apply_progress, lifecycle_state, plan_progress, 3 more }
apply_progress: ApplyProgress { done, total }
done: number
total: number
lifecycle_state: "OnrampNeedsApply" | "OnrampPendingPlan" | "OnrampPlanning" | 9 more
One of the following:
"OnrampNeedsApply"
"OnrampPendingPlan"
"OnrampPlanning"
"OnrampPlanFailed"
"OnrampPendingApproval"
"OnrampPendingApply"
"OnrampApplying"
"OnrampApplyFailed"
"OnrampActive"
"OnrampPendingDestroy"
"OnrampDestroying"
"OnrampDestroyFailed"
plan_progress: PlanProgress { done, total }
done: number
total: number
routes: Array<string>
tunnels: Array<string>
lifecycle_errors?: Record<string, LifecycleErrors>
code: 1001 | 1002 | 1003 | 152 more
One of the following:
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
3001
3002
3003
3004
3005
3006
3007
4001
4002
4003
4004