Documentation Index
Fetch the complete documentation index at: https://mintlify.com/cloudflare/cloudflare-typescript/llms.txt
Use this file to discover all available pages before exploring further.
Overview
Magic Cloud Networking provides secure, high-performance connectivity between your cloud environments and Cloudflare’s network. Manage cloud integrations, on-ramps, resources, and catalog synchronization.
Initialize the client
import Cloudflare from 'cloudflare';
const client = new Cloudflare({
apiToken: 'your-api-token',
});
Resources
Cloud integrations
Manage integrations with cloud providers (AWS, Azure, GCP).
const cloudIntegrations = client.magicCloudNetworking.cloudIntegrations;
Create integration
Create a new cloud provider integration.
const integration = await client.magicCloudNetworking.cloudIntegrations.create({
account_id: '023e105f4ecef8ad9ca31a8372d0c353',
// integration configuration
});
List integrations
List all cloud integrations.
const integrations = await client.magicCloudNetworking.cloudIntegrations.list({
account_id: '023e105f4ecef8ad9ca31a8372d0c353',
});
Get integration
Retrieve a specific cloud integration.
const integration = await client.magicCloudNetworking.cloudIntegrations.get(
integrationId,
{ account_id: '023e105f4ecef8ad9ca31a8372d0c353' }
);
Update integration
Update an existing cloud integration.
const integration = await client.magicCloudNetworking.cloudIntegrations.update(
integrationId,
params
);
Delete integration
Delete a cloud integration.
await client.magicCloudNetworking.cloudIntegrations.delete(
integrationId,
{ account_id: '023e105f4ecef8ad9ca31a8372d0c353' }
);
Discover resources
Discover cloud resources available for integration.
const resources = await client.magicCloudNetworking.cloudIntegrations.discover(
integrationId,
params
);
Discover all resources
Discover all available cloud resources across integrations.
const allResources = await client.magicCloudNetworking.cloudIntegrations.discoverAll(params);
Initial setup
Perform initial setup for a cloud integration.
const setup = await client.magicCloudNetworking.cloudIntegrations.initialSetup(params);
On-ramps
Manage network on-ramps for cloud connectivity.
const onRamps = client.magicCloudNetworking.onRamps;
Create on-ramp
const onRamp = await client.magicCloudNetworking.onRamps.create(params);
Update on-ramp
const onRamp = await client.magicCloudNetworking.onRamps.update(onRampId, params);
List on-ramps
const onRamps = await client.magicCloudNetworking.onRamps.list(params);
Delete on-ramp
await client.magicCloudNetworking.onRamps.delete(onRampId, params);
Plan configuration
Plan configuration changes for an on-ramp.
const plan = await client.magicCloudNetworking.onRamps.plan(onRampId, params);
Apply configuration
Apply planned configuration changes.
const result = await client.magicCloudNetworking.onRamps.apply(onRampId, params);
Export configuration
Export on-ramp configuration.
await client.magicCloudNetworking.onRamps.export(onRampId, params);
Resources
Manage cloud resources integrated with Magic Cloud Networking.
const resources = client.magicCloudNetworking.resources;
List resources
const resourceList = await client.magicCloudNetworking.resources.list(params);
Get resource
const resource = await client.magicCloudNetworking.resources.get(resourceId, params);
Export resources
await client.magicCloudNetworking.resources.export(params);
Policy preview
Preview policy changes for resources.
const preview = await client.magicCloudNetworking.resources.policyPreview(params);
Catalog syncs
Manage catalog synchronization for cloud resources.
const catalogSyncs = client.magicCloudNetworking.catalogSyncs;
Create sync
const sync = await client.magicCloudNetworking.catalogSyncs.create(params);
Update sync
const sync = await client.magicCloudNetworking.catalogSyncs.update(syncId, params);
List syncs
const syncs = await client.magicCloudNetworking.catalogSyncs.list(params);
Delete sync
await client.magicCloudNetworking.catalogSyncs.delete(syncId, params);
Refresh catalog
Manually trigger a catalog refresh.
const result = await client.magicCloudNetworking.catalogSyncs.refresh(syncId, params);