Update On-ramp
client.magicCloudNetworking.onRamps.update(stringonrampId, OnRampUpdateParams { account_id, attached_hubs, attached_vpcs, 7 more } params, RequestOptionsoptions?): OnRampUpdateResponse { id, cloud_type, dynamic_routing, 26 more }
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:
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
Example:
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
Example:
Accepted Permissions (at least one required)
Update On-ramp
import Cloudflare from 'cloudflare';
const client = new Cloudflare({
apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});
const onRamp = await client.magicCloudNetworking.onRamps.update(
'182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
{ account_id: 'account_id' },
);
console.log(onRamp.id);{
"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",
"sections": [
{
"hidden_items": [
{
"helpText": "helpText",
"name": "name",
"value": {
"item_type": "item_type",
"string": "string"
}
}
],
"name": "name",
"visible_items": [
{
"helpText": "helpText",
"name": "name",
"value": {
"item_type": "item_type",
"string": "string"
}
}
],
"help_text": "help_text"
}
],
"state": {
"foo": "bar"
},
"tags": {
"foo": "string"
},
"updated_at": "updated_at",
"url": "url",
"managed_by": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"client_type": "MAGIC_WAN_CLOUD_ONRAMP",
"name": "name"
}
]
}
},
"post_apply_resources_unavailable": true,
"region": "region",
"status": {
"apply_progress": {
"done": 0,
"total": 0
},
"lifecycle_state": "OnrampNeedsApply",
"plan_progress": {
"done": 0,
"total": 0
},
"routes": [
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
],
"tunnels": [
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
],
"lifecycle_errors": {
"foo": {
"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"
}
}
}
},
"vpc": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"vpcs_by_id": {
"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",
"sections": [
{
"hidden_items": [
{
"helpText": "helpText",
"name": "name",
"value": {
"item_type": "item_type",
"string": "string"
}
}
],
"name": "name",
"visible_items": [
{
"helpText": "helpText",
"name": "name",
"value": {
"item_type": "item_type",
"string": "string"
}
}
],
"help_text": "help_text"
}
],
"state": {
"foo": "bar"
},
"tags": {
"foo": "string"
},
"updated_at": "updated_at",
"url": "url",
"managed_by": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"client_type": "MAGIC_WAN_CLOUD_ONRAMP",
"name": "name"
}
]
}
},
"vpcs_by_id_unavailable": [
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
]
},
"success": true
}Returns Examples
{
"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",
"sections": [
{
"hidden_items": [
{
"helpText": "helpText",
"name": "name",
"value": {
"item_type": "item_type",
"string": "string"
}
}
],
"name": "name",
"visible_items": [
{
"helpText": "helpText",
"name": "name",
"value": {
"item_type": "item_type",
"string": "string"
}
}
],
"help_text": "help_text"
}
],
"state": {
"foo": "bar"
},
"tags": {
"foo": "string"
},
"updated_at": "updated_at",
"url": "url",
"managed_by": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"client_type": "MAGIC_WAN_CLOUD_ONRAMP",
"name": "name"
}
]
}
},
"post_apply_resources_unavailable": true,
"region": "region",
"status": {
"apply_progress": {
"done": 0,
"total": 0
},
"lifecycle_state": "OnrampNeedsApply",
"plan_progress": {
"done": 0,
"total": 0
},
"routes": [
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
],
"tunnels": [
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
],
"lifecycle_errors": {
"foo": {
"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"
}
}
}
},
"vpc": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"vpcs_by_id": {
"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",
"sections": [
{
"hidden_items": [
{
"helpText": "helpText",
"name": "name",
"value": {
"item_type": "item_type",
"string": "string"
}
}
],
"name": "name",
"visible_items": [
{
"helpText": "helpText",
"name": "name",
"value": {
"item_type": "item_type",
"string": "string"
}
}
],
"help_text": "help_text"
}
],
"state": {
"foo": "bar"
},
"tags": {
"foo": "string"
},
"updated_at": "updated_at",
"url": "url",
"managed_by": [
{
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"client_type": "MAGIC_WAN_CLOUD_ONRAMP",
"name": "name"
}
]
}
},
"vpcs_by_id_unavailable": [
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
]
},
"success": true
}