Magic Cloud Networking
Magic Cloud NetworkingCatalog Syncs
List Catalog Syncs
client.magicCloudNetworking.catalogSyncs.list(CatalogSyncListParams { account_id } params, RequestOptionsoptions?): SinglePage<CatalogSyncListResponse { id, description, destination_id, 9 more } >
GET/accounts/{account_id}/magic/cloud/catalog-syncs
Read Catalog Sync
client.magicCloudNetworking.catalogSyncs.get(stringsyncId, CatalogSyncGetParams { account_id } params, RequestOptionsoptions?): CatalogSyncGetResponse { id, description, destination_id, 9 more }
GET/accounts/{account_id}/magic/cloud/catalog-syncs/{sync_id}
Create Catalog Sync
client.magicCloudNetworking.catalogSyncs.create(CatalogSyncCreateParams { account_id, destination_type, name, 4 more } params, RequestOptionsoptions?): CatalogSyncCreateResponse { id, description, destination_id, 9 more }
POST/accounts/{account_id}/magic/cloud/catalog-syncs
Update Catalog Sync
client.magicCloudNetworking.catalogSyncs.update(stringsyncId, CatalogSyncUpdateParams { account_id, description, name, 2 more } params, RequestOptionsoptions?): CatalogSyncUpdateResponse { id, description, destination_id, 9 more }
PUT/accounts/{account_id}/magic/cloud/catalog-syncs/{sync_id}
Patch Catalog Sync
client.magicCloudNetworking.catalogSyncs.edit(stringsyncId, CatalogSyncEditParams { account_id, description, name, 2 more } params, RequestOptionsoptions?): CatalogSyncEditResponse { id, description, destination_id, 9 more }
PATCH/accounts/{account_id}/magic/cloud/catalog-syncs/{sync_id}
Delete Catalog Sync
client.magicCloudNetworking.catalogSyncs.delete(stringsyncId, CatalogSyncDeleteParams { account_id, delete_destination } params, RequestOptionsoptions?): CatalogSyncDeleteResponse { id }
DELETE/accounts/{account_id}/magic/cloud/catalog-syncs/{sync_id}
Run Catalog Sync
client.magicCloudNetworking.catalogSyncs.refresh(stringsyncId, CatalogSyncRefreshParams { account_id } params, RequestOptionsoptions?): CatalogSyncRefreshResponse
POST/accounts/{account_id}/magic/cloud/catalog-syncs/{sync_id}/refresh
ModelsExpand Collapse
Magic Cloud NetworkingCatalog SyncsPrebuilt Policies
List Prebuilt Policies
client.magicCloudNetworking.catalogSyncs.prebuiltPolicies.list(PrebuiltPolicyListParams { account_id, destination_type } params, RequestOptionsoptions?): SinglePage<PrebuiltPolicyListResponse { applicable_destinations, policy_description, policy_name, policy_string } >
GET/accounts/{account_id}/magic/cloud/catalog-syncs/prebuilt-policies
Magic Cloud NetworkingOn Ramps
List On-ramps
client.magicCloudNetworking.onRamps.list(OnRampListParams { account_id, desc, order_by, 2 more } params, RequestOptionsoptions?): SinglePage<OnRampListResponse { id, cloud_type, dynamic_routing, 26 more } >
GET/accounts/{account_id}/magic/cloud/onramps
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}
Create On-ramp
client.magicCloudNetworking.onRamps.create(OnRampCreateParams { account_id, cloud_type, dynamic_routing, 15 more } params, RequestOptionsoptions?): OnRampCreateResponse { id, cloud_type, dynamic_routing, 26 more }
POST/accounts/{account_id}/magic/cloud/onramps
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}
Patch On-ramp
client.magicCloudNetworking.onRamps.edit(stringonrampId, OnRampEditParams { account_id, attached_hubs, attached_vpcs, 7 more } params, RequestOptionsoptions?): OnRampEditResponse { id, cloud_type, dynamic_routing, 26 more }
PATCH/accounts/{account_id}/magic/cloud/onramps/{onramp_id}
Delete On-ramp
client.magicCloudNetworking.onRamps.delete(stringonrampId, OnRampDeleteParams { account_id, destroy, force } params, RequestOptionsoptions?): OnRampDeleteResponse { id }
DELETE/accounts/{account_id}/magic/cloud/onramps/{onramp_id}
Apply On-ramp
client.magicCloudNetworking.onRamps.apply(stringonrampId, OnRampApplyParams { account_id } params, RequestOptionsoptions?): OnRampApplyResponse { errors, messages, success }
POST/accounts/{account_id}/magic/cloud/onramps/{onramp_id}/apply
Export as Terraform
client.magicCloudNetworking.onRamps.export(stringonrampId, OnRampExportParams { account_id } params, RequestOptionsoptions?): Response
POST/accounts/{account_id}/magic/cloud/onramps/{onramp_id}/export
Plan On-ramp
client.magicCloudNetworking.onRamps.plan(stringonrampId, OnRampPlanParams { account_id } params, RequestOptionsoptions?): OnRampPlanResponse { errors, messages, success }
POST/accounts/{account_id}/magic/cloud/onramps/{onramp_id}/plan
ModelsExpand Collapse
OnRampListResponse { id, cloud_type, dynamic_routing, 26 more }
OnRampListResponse { id, cloud_type, dynamic_routing, 26 more }
planned_monthly_cost_estimate?: PlannedMonthlyCostEstimate { currency, current_monthly_cost, diff, proposed_monthly_cost }
planned_monthly_cost_estimate?: PlannedMonthlyCostEstimate { currency, current_monthly_cost, diff, proposed_monthly_cost }
planned_resources?: Array<PlannedResource>
planned_resources?: Array<PlannedResource>
monthly_cost_estimate_diff: MonthlyCostEstimateDiff { currency, current_monthly_cost, diff, proposed_monthly_cost }
monthly_cost_estimate_diff: MonthlyCostEstimateDiff { currency, current_monthly_cost, diff, proposed_monthly_cost }
post_apply_resources?: Record<string, PostApplyResources>
post_apply_resources?: Record<string, PostApplyResources>
resource_type: "aws_customer_gateway" | "aws_egress_only_internet_gateway" | "aws_internet_gateway" | 54 more
resource_type: "aws_customer_gateway" | "aws_egress_only_internet_gateway" | "aws_internet_gateway" | 54 more
One of the following:
sections: Array<Section>
sections: Array<Section>
hidden_items: Array<HiddenItem>
hidden_items: Array<HiddenItem>
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
McnListItem { item_type, list }
McnListItem { item_type, list }
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
visible_items: Array<VisibleItem>
visible_items: Array<VisibleItem>
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
McnListItem { item_type, list }
McnListItem { item_type, list }
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
status?: Status { apply_progress, lifecycle_state, plan_progress, 3 more }
status?: Status { apply_progress, lifecycle_state, plan_progress, 3 more }
vpcs_by_id?: Record<string, VPCsByID>
vpcs_by_id?: Record<string, VPCsByID>
resource_type: "aws_customer_gateway" | "aws_egress_only_internet_gateway" | "aws_internet_gateway" | 54 more
resource_type: "aws_customer_gateway" | "aws_egress_only_internet_gateway" | "aws_internet_gateway" | 54 more
One of the following:
sections: Array<Section>
sections: Array<Section>
hidden_items: Array<HiddenItem>
hidden_items: Array<HiddenItem>
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
McnListItem { item_type, list }
McnListItem { item_type, list }
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
visible_items: Array<VisibleItem>
visible_items: Array<VisibleItem>
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
McnListItem { item_type, list }
McnListItem { item_type, list }
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
OnRampGetResponse { id, cloud_type, dynamic_routing, 26 more }
OnRampGetResponse { id, cloud_type, dynamic_routing, 26 more }
planned_monthly_cost_estimate?: PlannedMonthlyCostEstimate { currency, current_monthly_cost, diff, proposed_monthly_cost }
planned_monthly_cost_estimate?: PlannedMonthlyCostEstimate { currency, current_monthly_cost, diff, proposed_monthly_cost }
planned_resources?: Array<PlannedResource>
planned_resources?: Array<PlannedResource>
monthly_cost_estimate_diff: MonthlyCostEstimateDiff { currency, current_monthly_cost, diff, proposed_monthly_cost }
monthly_cost_estimate_diff: MonthlyCostEstimateDiff { currency, current_monthly_cost, diff, proposed_monthly_cost }
post_apply_resources?: Record<string, PostApplyResources>
post_apply_resources?: Record<string, PostApplyResources>
resource_type: "aws_customer_gateway" | "aws_egress_only_internet_gateway" | "aws_internet_gateway" | 54 more
resource_type: "aws_customer_gateway" | "aws_egress_only_internet_gateway" | "aws_internet_gateway" | 54 more
One of the following:
sections: Array<Section>
sections: Array<Section>
hidden_items: Array<HiddenItem>
hidden_items: Array<HiddenItem>
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
McnListItem { item_type, list }
McnListItem { item_type, list }
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
visible_items: Array<VisibleItem>
visible_items: Array<VisibleItem>
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
McnListItem { item_type, list }
McnListItem { item_type, list }
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
status?: Status { apply_progress, lifecycle_state, plan_progress, 3 more }
status?: Status { apply_progress, lifecycle_state, plan_progress, 3 more }
vpcs_by_id?: Record<string, VPCsByID>
vpcs_by_id?: Record<string, VPCsByID>
resource_type: "aws_customer_gateway" | "aws_egress_only_internet_gateway" | "aws_internet_gateway" | 54 more
resource_type: "aws_customer_gateway" | "aws_egress_only_internet_gateway" | "aws_internet_gateway" | 54 more
One of the following:
sections: Array<Section>
sections: Array<Section>
hidden_items: Array<HiddenItem>
hidden_items: Array<HiddenItem>
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
McnListItem { item_type, list }
McnListItem { item_type, list }
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
visible_items: Array<VisibleItem>
visible_items: Array<VisibleItem>
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
McnListItem { item_type, list }
McnListItem { item_type, list }
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
OnRampCreateResponse { id, cloud_type, dynamic_routing, 26 more }
OnRampCreateResponse { id, cloud_type, dynamic_routing, 26 more }
planned_monthly_cost_estimate?: PlannedMonthlyCostEstimate { currency, current_monthly_cost, diff, proposed_monthly_cost }
planned_monthly_cost_estimate?: PlannedMonthlyCostEstimate { currency, current_monthly_cost, diff, proposed_monthly_cost }
planned_resources?: Array<PlannedResource>
planned_resources?: Array<PlannedResource>
monthly_cost_estimate_diff: MonthlyCostEstimateDiff { currency, current_monthly_cost, diff, proposed_monthly_cost }
monthly_cost_estimate_diff: MonthlyCostEstimateDiff { currency, current_monthly_cost, diff, proposed_monthly_cost }
post_apply_resources?: Record<string, PostApplyResources>
post_apply_resources?: Record<string, PostApplyResources>
resource_type: "aws_customer_gateway" | "aws_egress_only_internet_gateway" | "aws_internet_gateway" | 54 more
resource_type: "aws_customer_gateway" | "aws_egress_only_internet_gateway" | "aws_internet_gateway" | 54 more
One of the following:
sections: Array<Section>
sections: Array<Section>
hidden_items: Array<HiddenItem>
hidden_items: Array<HiddenItem>
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
McnListItem { item_type, list }
McnListItem { item_type, list }
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
visible_items: Array<VisibleItem>
visible_items: Array<VisibleItem>
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
McnListItem { item_type, list }
McnListItem { item_type, list }
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
status?: Status { apply_progress, lifecycle_state, plan_progress, 3 more }
status?: Status { apply_progress, lifecycle_state, plan_progress, 3 more }
vpcs_by_id?: Record<string, VPCsByID>
vpcs_by_id?: Record<string, VPCsByID>
resource_type: "aws_customer_gateway" | "aws_egress_only_internet_gateway" | "aws_internet_gateway" | 54 more
resource_type: "aws_customer_gateway" | "aws_egress_only_internet_gateway" | "aws_internet_gateway" | 54 more
One of the following:
sections: Array<Section>
sections: Array<Section>
hidden_items: Array<HiddenItem>
hidden_items: Array<HiddenItem>
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
McnListItem { item_type, list }
McnListItem { item_type, list }
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
visible_items: Array<VisibleItem>
visible_items: Array<VisibleItem>
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
McnListItem { item_type, list }
McnListItem { item_type, list }
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
OnRampUpdateResponse { id, cloud_type, dynamic_routing, 26 more }
OnRampUpdateResponse { id, cloud_type, dynamic_routing, 26 more }
planned_monthly_cost_estimate?: PlannedMonthlyCostEstimate { currency, current_monthly_cost, diff, proposed_monthly_cost }
planned_monthly_cost_estimate?: PlannedMonthlyCostEstimate { currency, current_monthly_cost, diff, proposed_monthly_cost }
planned_resources?: Array<PlannedResource>
planned_resources?: Array<PlannedResource>
monthly_cost_estimate_diff: MonthlyCostEstimateDiff { currency, current_monthly_cost, diff, proposed_monthly_cost }
monthly_cost_estimate_diff: MonthlyCostEstimateDiff { currency, current_monthly_cost, diff, proposed_monthly_cost }
post_apply_resources?: Record<string, PostApplyResources>
post_apply_resources?: Record<string, PostApplyResources>
resource_type: "aws_customer_gateway" | "aws_egress_only_internet_gateway" | "aws_internet_gateway" | 54 more
resource_type: "aws_customer_gateway" | "aws_egress_only_internet_gateway" | "aws_internet_gateway" | 54 more
One of the following:
sections: Array<Section>
sections: Array<Section>
hidden_items: Array<HiddenItem>
hidden_items: Array<HiddenItem>
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
McnListItem { item_type, list }
McnListItem { item_type, list }
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
visible_items: Array<VisibleItem>
visible_items: Array<VisibleItem>
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
McnListItem { item_type, list }
McnListItem { item_type, list }
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
status?: Status { apply_progress, lifecycle_state, plan_progress, 3 more }
status?: Status { apply_progress, lifecycle_state, plan_progress, 3 more }
vpcs_by_id?: Record<string, VPCsByID>
vpcs_by_id?: Record<string, VPCsByID>
resource_type: "aws_customer_gateway" | "aws_egress_only_internet_gateway" | "aws_internet_gateway" | 54 more
resource_type: "aws_customer_gateway" | "aws_egress_only_internet_gateway" | "aws_internet_gateway" | 54 more
One of the following:
sections: Array<Section>
sections: Array<Section>
hidden_items: Array<HiddenItem>
hidden_items: Array<HiddenItem>
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
McnListItem { item_type, list }
McnListItem { item_type, list }
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
visible_items: Array<VisibleItem>
visible_items: Array<VisibleItem>
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
McnListItem { item_type, list }
McnListItem { item_type, list }
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
OnRampEditResponse { id, cloud_type, dynamic_routing, 26 more }
OnRampEditResponse { id, cloud_type, dynamic_routing, 26 more }
planned_monthly_cost_estimate?: PlannedMonthlyCostEstimate { currency, current_monthly_cost, diff, proposed_monthly_cost }
planned_monthly_cost_estimate?: PlannedMonthlyCostEstimate { currency, current_monthly_cost, diff, proposed_monthly_cost }
planned_resources?: Array<PlannedResource>
planned_resources?: Array<PlannedResource>
monthly_cost_estimate_diff: MonthlyCostEstimateDiff { currency, current_monthly_cost, diff, proposed_monthly_cost }
monthly_cost_estimate_diff: MonthlyCostEstimateDiff { currency, current_monthly_cost, diff, proposed_monthly_cost }
post_apply_resources?: Record<string, PostApplyResources>
post_apply_resources?: Record<string, PostApplyResources>
resource_type: "aws_customer_gateway" | "aws_egress_only_internet_gateway" | "aws_internet_gateway" | 54 more
resource_type: "aws_customer_gateway" | "aws_egress_only_internet_gateway" | "aws_internet_gateway" | 54 more
One of the following:
sections: Array<Section>
sections: Array<Section>
hidden_items: Array<HiddenItem>
hidden_items: Array<HiddenItem>
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
McnListItem { item_type, list }
McnListItem { item_type, list }
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
visible_items: Array<VisibleItem>
visible_items: Array<VisibleItem>
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
McnListItem { item_type, list }
McnListItem { item_type, list }
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
status?: Status { apply_progress, lifecycle_state, plan_progress, 3 more }
status?: Status { apply_progress, lifecycle_state, plan_progress, 3 more }
vpcs_by_id?: Record<string, VPCsByID>
vpcs_by_id?: Record<string, VPCsByID>
resource_type: "aws_customer_gateway" | "aws_egress_only_internet_gateway" | "aws_internet_gateway" | 54 more
resource_type: "aws_customer_gateway" | "aws_egress_only_internet_gateway" | "aws_internet_gateway" | 54 more
One of the following:
sections: Array<Section>
sections: Array<Section>
hidden_items: Array<HiddenItem>
hidden_items: Array<HiddenItem>
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
McnListItem { item_type, list }
McnListItem { item_type, list }
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
visible_items: Array<VisibleItem>
visible_items: Array<VisibleItem>
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
McnListItem { item_type, list }
McnListItem { item_type, list }
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
OnRampApplyResponse { errors, messages, success }
OnRampApplyResponse { errors, messages, success }
OnRampPlanResponse { errors, messages, success }
OnRampPlanResponse { errors, messages, success }
Magic Cloud NetworkingOn RampsAddress Spaces
Read Magic WAN Address Space
client.magicCloudNetworking.onRamps.addressSpaces.list(AddressSpaceListParams { account_id } params, RequestOptionsoptions?): AddressSpaceListResponse { prefixes }
GET/accounts/{account_id}/magic/cloud/onramps/magic_wan_address_space
Update Magic WAN Address Space
client.magicCloudNetworking.onRamps.addressSpaces.update(AddressSpaceUpdateParams { account_id, prefixes } params, RequestOptionsoptions?): AddressSpaceUpdateResponse { prefixes }
PUT/accounts/{account_id}/magic/cloud/onramps/magic_wan_address_space
Patch Magic WAN Address Space
client.magicCloudNetworking.onRamps.addressSpaces.edit(AddressSpaceEditParams { account_id, prefixes } params, RequestOptionsoptions?): AddressSpaceEditResponse { prefixes }
PATCH/accounts/{account_id}/magic/cloud/onramps/magic_wan_address_space
Magic Cloud NetworkingCloud Integrations
List Cloud Integrations
client.magicCloudNetworking.cloudIntegrations.list(CloudIntegrationListParams { account_id, cloudflare, desc, 2 more } params, RequestOptionsoptions?): SinglePage<CloudIntegrationListResponse { id, cloud_type, friendly_name, 11 more } >
GET/accounts/{account_id}/magic/cloud/providers
Read Cloud Integration
client.magicCloudNetworking.cloudIntegrations.get(stringproviderId, CloudIntegrationGetParams { account_id, status } params, RequestOptionsoptions?): CloudIntegrationGetResponse { id, cloud_type, friendly_name, 11 more }
GET/accounts/{account_id}/magic/cloud/providers/{provider_id}
Create Cloud Integration
client.magicCloudNetworking.cloudIntegrations.create(CloudIntegrationCreateParams { account_id, cloud_type, friendly_name, 2 more } params, RequestOptionsoptions?): CloudIntegrationCreateResponse { id, cloud_type, friendly_name, 11 more }
POST/accounts/{account_id}/magic/cloud/providers
Update Cloud Integration
client.magicCloudNetworking.cloudIntegrations.update(stringproviderId, CloudIntegrationUpdateParams { account_id, aws_arn, azure_subscription_id, 5 more } params, RequestOptionsoptions?): CloudIntegrationUpdateResponse { id, cloud_type, friendly_name, 11 more }
PUT/accounts/{account_id}/magic/cloud/providers/{provider_id}
Patch Cloud Integration
client.magicCloudNetworking.cloudIntegrations.edit(stringproviderId, CloudIntegrationEditParams { account_id, aws_arn, azure_subscription_id, 5 more } params, RequestOptionsoptions?): CloudIntegrationEditResponse { id, cloud_type, friendly_name, 11 more }
PATCH/accounts/{account_id}/magic/cloud/providers/{provider_id}
Delete Cloud Integration
client.magicCloudNetworking.cloudIntegrations.delete(stringproviderId, CloudIntegrationDeleteParams { account_id } params, RequestOptionsoptions?): CloudIntegrationDeleteResponse { id }
DELETE/accounts/{account_id}/magic/cloud/providers/{provider_id}
Run Discovery for All Integrations
client.magicCloudNetworking.cloudIntegrations.discoverAll(CloudIntegrationDiscoverAllParams { account_id } params, RequestOptionsoptions?): CloudIntegrationDiscoverAllResponse { errors, messages, success }
POST/accounts/{account_id}/magic/cloud/providers/discover
Run Discovery
client.magicCloudNetworking.cloudIntegrations.discover(stringproviderId, CloudIntegrationDiscoverParams { account_id, v2 } params, RequestOptionsoptions?): CloudIntegrationDiscoverResponse { errors, messages, success }
POST/accounts/{account_id}/magic/cloud/providers/{provider_id}/discover
Get Cloud Integration Setup Config
client.magicCloudNetworking.cloudIntegrations.initialSetup(stringproviderId, CloudIntegrationInitialSetupParams { account_id } params, RequestOptionsoptions?): CloudIntegrationInitialSetupResponse
GET/accounts/{account_id}/magic/cloud/providers/{provider_id}/initial_setup
ModelsExpand Collapse
CloudIntegrationListResponse { id, cloud_type, friendly_name, 11 more }
CloudIntegrationListResponse { id, cloud_type, friendly_name, 11 more }
status?: Status { discovery_progress, discovery_progress_v2, last_discovery_status, 13 more }
status?: Status { discovery_progress, discovery_progress_v2, last_discovery_status, 13 more }
CloudIntegrationGetResponse { id, cloud_type, friendly_name, 11 more }
CloudIntegrationGetResponse { id, cloud_type, friendly_name, 11 more }
status?: Status { discovery_progress, discovery_progress_v2, last_discovery_status, 13 more }
status?: Status { discovery_progress, discovery_progress_v2, last_discovery_status, 13 more }
CloudIntegrationCreateResponse { id, cloud_type, friendly_name, 11 more }
CloudIntegrationCreateResponse { id, cloud_type, friendly_name, 11 more }
status?: Status { discovery_progress, discovery_progress_v2, last_discovery_status, 13 more }
status?: Status { discovery_progress, discovery_progress_v2, last_discovery_status, 13 more }
CloudIntegrationUpdateResponse { id, cloud_type, friendly_name, 11 more }
CloudIntegrationUpdateResponse { id, cloud_type, friendly_name, 11 more }
status?: Status { discovery_progress, discovery_progress_v2, last_discovery_status, 13 more }
status?: Status { discovery_progress, discovery_progress_v2, last_discovery_status, 13 more }
CloudIntegrationEditResponse { id, cloud_type, friendly_name, 11 more }
CloudIntegrationEditResponse { id, cloud_type, friendly_name, 11 more }
status?: Status { discovery_progress, discovery_progress_v2, last_discovery_status, 13 more }
status?: Status { discovery_progress, discovery_progress_v2, last_discovery_status, 13 more }
CloudIntegrationDiscoverAllResponse { errors, messages, success }
CloudIntegrationDiscoverAllResponse { errors, messages, success }
CloudIntegrationDiscoverResponse { errors, messages, success }
CloudIntegrationDiscoverResponse { errors, messages, success }
CloudIntegrationInitialSetupResponse = McnAwsTrustPolicy { aws_trust_policy, item_type } | McnAzureSetup { azure_consent_url, integration_identity_tag, item_type, tag_cli_command } | McnGcpSetup { integration_identity_tag, item_type, tag_cli_command }
CloudIntegrationInitialSetupResponse = McnAwsTrustPolicy { aws_trust_policy, item_type } | McnAzureSetup { azure_consent_url, integration_identity_tag, item_type, tag_cli_command } | McnGcpSetup { integration_identity_tag, item_type, tag_cli_command }
Magic Cloud NetworkingResources
List Resources
client.magicCloudNetworking.resources.list(ResourceListParams { account_id, cloudflare, desc, 11 more } params, RequestOptionsoptions?): V4PagePaginationArray<ResourceListResponse { id, account_id, cloud_type, 18 more } >
GET/accounts/{account_id}/magic/cloud/resources
Read Resource
client.magicCloudNetworking.resources.get(stringresourceId, ResourceGetParams { account_id, v2 } params, RequestOptionsoptions?): ResourceGetResponse { id, account_id, cloud_type, 18 more }
GET/accounts/{account_id}/magic/cloud/resources/{resource_id}
Export Resources
client.magicCloudNetworking.resources.export(ResourceExportParams { account_id, desc, order_by, 7 more } params, RequestOptionsoptions?): Response
GET/accounts/{account_id}/magic/cloud/resources/export
Preview Rego Query
client.magicCloudNetworking.resources.policyPreview(ResourcePolicyPreviewParams { account_id, policy } params, RequestOptionsoptions?): ResourcePolicyPreviewResponse
POST/accounts/{account_id}/magic/cloud/resources/policy-preview
ModelsExpand Collapse
ResourceListResponse { id, account_id, cloud_type, 18 more }
ResourceListResponse { id, account_id, cloud_type, 18 more }
resource_type: "aws_customer_gateway" | "aws_egress_only_internet_gateway" | "aws_internet_gateway" | 54 more
resource_type: "aws_customer_gateway" | "aws_egress_only_internet_gateway" | "aws_internet_gateway" | 54 more
One of the following:
sections: Array<Section>
sections: Array<Section>
hidden_items: Array<HiddenItem>
hidden_items: Array<HiddenItem>
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
McnListItem { item_type, list }
McnListItem { item_type, list }
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
visible_items: Array<VisibleItem>
visible_items: Array<VisibleItem>
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
McnListItem { item_type, list }
McnListItem { item_type, list }
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
ResourceGetResponse { id, account_id, cloud_type, 18 more }
ResourceGetResponse { id, account_id, cloud_type, 18 more }
resource_type: "aws_customer_gateway" | "aws_egress_only_internet_gateway" | "aws_internet_gateway" | 54 more
resource_type: "aws_customer_gateway" | "aws_egress_only_internet_gateway" | "aws_internet_gateway" | 54 more
One of the following:
sections: Array<Section>
sections: Array<Section>
hidden_items: Array<HiddenItem>
hidden_items: Array<HiddenItem>
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
McnListItem { item_type, list }
McnListItem { item_type, list }
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
visible_items: Array<VisibleItem>
visible_items: Array<VisibleItem>
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
value?: McnStringItem { item_type, string } | McnYamlItem { item_type, yaml } | McnYamlDiffItem { item_type, yaml_diff } | 2 more
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }
McnListItem { item_type, list }
McnListItem { item_type, list }
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
list: Array<McnStringItem { item_type, string } | McnResourcePreviewItem { item_type, resource_preview } >
One of the following:
McnResourcePreviewItem { item_type, resource_preview }
McnResourcePreviewItem { item_type, resource_preview }