Update On-ramp
PUT/accounts/{account_id}/magic/cloud/onramps/{onramp_id}
Update an On-ramp (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 WriteBody ParametersJSONExpand 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: object { id, cloud_type, dynamic_routing, 26 more }
result: 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 }
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 }
Update On-ramp
curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/magic/cloud/onramps/$ONRAMP_ID \
-X PUT \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
-d '{}'{
"errors": [
{
"code": 1001,
"message": "message",
"documentation_url": "documentation_url",
"meta": {
"l10n_key": "l10n_key",
"loggable_error": "loggable_error",
"template_data": {},
"trace_id": "trace_id"
},
"source": {
"parameter": "parameter",
"parameter_value_index": 0,
"pointer": "pointer"
}
}
],
"messages": [
{
"code": 1001,
"message": "message",
"documentation_url": "documentation_url",
"meta": {
"l10n_key": "l10n_key",
"loggable_error": "loggable_error",
"template_data": {},
"trace_id": "trace_id"
},
"source": {
"parameter": "parameter",
"parameter_value_index": 0,
"pointer": "pointer"
}
}
],
"result": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"cloud_type": "AWS",
"dynamic_routing": true,
"install_routes_in_cloud": true,
"install_routes_in_magic_wan": true,
"name": "name",
"type": "OnrampTypeSingle",
"updated_at": "updated_at",
"attached_hubs": [
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
],
"attached_vpcs": [
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
],
"cloud_asn": 0,
"description": "description",
"hub": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"last_applied_at": "last_applied_at",
"last_exported_at": "last_exported_at",
"last_planned_at": "last_planned_at",
"manage_hub_to_hub_attachments": true,
"manage_vpc_to_hub_attachments": true,
"planned_monthly_cost_estimate": {
"currency": "currency",
"current_monthly_cost": 0,
"diff": 0,
"proposed_monthly_cost": 0
},
"planned_resources": [
{
"diff": {
"diff": "diff",
"left_description": "left_description",
"left_yaml": "left_yaml",
"right_description": "right_description",
"right_yaml": "right_yaml"
},
"keys_require_replace": [
"string"
],
"monthly_cost_estimate_diff": {
"currency": "currency",
"current_monthly_cost": 0,
"diff": 0,
"proposed_monthly_cost": 0
},
"planned_action": "no_op",
"resource": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"cloud_type": "AWS",
"detail": "detail",
"name": "name",
"resource_type": "aws_customer_gateway",
"title": "title"
}
}
],
"planned_resources_unavailable": true,
"post_apply_monthly_cost_estimate": {
"currency": "currency",
"monthly_cost": 0
},
"post_apply_resources": {
"foo": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"account_id": "account_id",
"cloud_type": "AWS",
"config": {
"foo": "bar"
},
"deployment_provider": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"managed": true,
"monthly_cost_estimate": {
"currency": "currency",
"monthly_cost": 0
},
"name": "name",
"native_id": "native_id",
"observations": {
"foo": {
"first_observed_at": "first_observed_at",
"last_observed_at": "last_observed_at",
"provider_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"resource_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
}
},
"provider_ids": [
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
],
"provider_names_by_id": {
"foo": "string"
},
"region": "region",
"resource_group": "resource_group",
"resource_type": "aws_customer_gateway",