List On-ramps
GET/accounts/{account_id}/magic/cloud/onramps
List On-ramps (Closed Beta).
Security
API Token
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
Example:
Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYYAPI 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.comThe previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
Example:
X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194Accepted Permissions (at least one required)
Magic WAN WriteMagic WAN ReadQuery ParametersExpand Collapse
ReturnsExpand Collapse
errors: array of object { code, message, documentation_url, 2 more } maxLength0
errors: array of object { code, message, documentation_url, 2 more }
maxLength0
messages: array of object { code, message, documentation_url, 2 more }
messages: array of object { code, message, documentation_url, 2 more }
result: array of object { id, cloud_type, dynamic_routing, 26 more }
result: array of object { id, cloud_type, dynamic_routing, 26 more }
planned_monthly_cost_estimate: optional object { currency, current_monthly_cost, diff, proposed_monthly_cost }
planned_monthly_cost_estimate: optional object { currency, current_monthly_cost, diff, proposed_monthly_cost }
planned_resources: optional array of object { diff, keys_require_replace, monthly_cost_estimate_diff, 2 more }
planned_resources: optional array of object { diff, keys_require_replace, monthly_cost_estimate_diff, 2 more }
post_apply_resources: optional map[object { id, account_id, cloud_type, 18 more } ]
post_apply_resources: optional map[object { id, account_id, cloud_type, 18 more } ]
resource_type: "aws_customer_gateway" or "aws_egress_only_internet_gateway" or "aws_internet_gateway" or 54 more
resource_type: "aws_customer_gateway" or "aws_egress_only_internet_gateway" or "aws_internet_gateway" or 54 more
One of the following:
sections: array of object { hidden_items, name, visible_items, help_text }
sections: array of object { hidden_items, name, visible_items, help_text }
hidden_items: array of object { helpText, name, value }
hidden_items: array of object { helpText, name, value }
value: optional object { item_type, string } or object { item_type, yaml } or object { item_type, yaml_diff } or 2 more
value: optional object { item_type, string } or object { item_type, yaml } or object { item_type, yaml_diff } or 2 more
One of the following:
McnResourcePreviewItem object { item_type, resource_preview }
McnResourcePreviewItem object { item_type, resource_preview }
McnListItem object { item_type, list }
McnListItem object { item_type, list }
list: array of object { item_type, string } or object { item_type, resource_preview }
list: array of object { item_type, string } or object { item_type, resource_preview }
One of the following:
McnResourcePreviewItem object { item_type, resource_preview }
McnResourcePreviewItem object { item_type, resource_preview }
visible_items: array of object { helpText, name, value }
visible_items: array of object { helpText, name, value }
value: optional object { item_type, string } or object { item_type, yaml } or object { item_type, yaml_diff } or 2 more
value: optional object { item_type, string } or object { item_type, yaml } or object { item_type, yaml_diff } or 2 more
One of the following:
McnResourcePreviewItem object { item_type, resource_preview }
McnResourcePreviewItem object { item_type, resource_preview }
McnListItem object { item_type, list }
McnListItem object { item_type, list }
list: array of object { item_type, string } or object { item_type, resource_preview }
list: array of object { item_type, string } or object { item_type, resource_preview }
One of the following:
McnResourcePreviewItem object { item_type, resource_preview }
McnResourcePreviewItem object { item_type, resource_preview }
status: optional object { apply_progress, lifecycle_state, plan_progress, 3 more }
status: optional object { apply_progress, lifecycle_state, plan_progress, 3 more }
vpcs_by_id: optional map[object { id, account_id, cloud_type, 18 more } ]
vpcs_by_id: optional map[object { id, account_id, cloud_type, 18 more } ]
resource_type: "aws_customer_gateway" or "aws_egress_only_internet_gateway" or "aws_internet_gateway" or 54 more
resource_type: "aws_customer_gateway" or "aws_egress_only_internet_gateway" or "aws_internet_gateway" or 54 more
One of the following:
sections: array of object { hidden_items, name, visible_items, help_text }
sections: array of object { hidden_items, name, visible_items, help_text }
hidden_items: array of object { helpText, name, value }
hidden_items: array of object { helpText, name, value }
value: optional object { item_type, string } or object { item_type, yaml } or object { item_type, yaml_diff } or 2 more
value: optional object { item_type, string } or object { item_type, yaml } or object { item_type, yaml_diff } or 2 more
One of the following:
McnResourcePreviewItem object { item_type, resource_preview }
McnResourcePreviewItem object { item_type, resource_preview }
McnListItem object { item_type, list }
McnListItem object { item_type, list }
list: array of object { item_type, string } or object { item_type, resource_preview }
list: array of object { item_type, string } or object { item_type, resource_preview }
One of the following:
McnResourcePreviewItem object { item_type, resource_preview }
McnResourcePreviewItem object { item_type, resource_preview }
visible_items: array of object { helpText, name, value }
visible_items: array of object { helpText, name, value }
value: optional object { item_type, string } or object { item_type, yaml } or object { item_type, yaml_diff } or 2 more
value: optional object { item_type, string } or object { item_type, yaml } or object { item_type, yaml_diff } or 2 more
One of the following:
McnResourcePreviewItem object { item_type, resource_preview }
McnResourcePreviewItem object { item_type, resource_preview }