LogoCloudflare API

Magic Cloud Networking

magic_cloud_networking

Magic Cloud Networking

Catalog Syncs

magic_cloud_networking.catalog_syncs

Methods

List Catalog Syncs -> SinglePage<{ id, description, destination_id, 9 more... }>
get/accounts/{account_id}/magic/cloud/catalog-syncs

List Catalog Syncs (Closed Beta).

Read Catalog Sync -> Envelope<{ id, description, destination_id, 9 more... }>
get/accounts/{account_id}/magic/cloud/catalog-syncs/{sync_id}

Read a Catalog Sync (Closed Beta).

Create Catalog Sync -> Envelope<{ id, description, destination_id, 9 more... }>
post/accounts/{account_id}/magic/cloud/catalog-syncs

Create a new Catalog Sync (Closed Beta).

Update Catalog Sync -> Envelope<{ id, description, destination_id, 9 more... }>
put/accounts/{account_id}/magic/cloud/catalog-syncs/{sync_id}

Update a Catalog Sync (Closed Beta).

Patch Catalog Sync -> Envelope<{ id, description, destination_id, 9 more... }>
patch/accounts/{account_id}/magic/cloud/catalog-syncs/{sync_id}

Update a Catalog Sync (Closed Beta).

Delete Catalog Sync -> Envelope<{ id }>
delete/accounts/{account_id}/magic/cloud/catalog-syncs/{sync_id}

Delete a Catalog Sync (Closed Beta).

Run Catalog Sync -> Envelope<string>
post/accounts/{account_id}/magic/cloud/catalog-syncs/{sync_id}/refresh

Refresh a Catalog Sync's destination by running the sync policy against latest resource catalog (Closed Beta).

Magic Cloud NetworkingCatalog Syncs

Prebuilt Policies

magic_cloud_networking.catalog_syncs.prebuilt_policies

Methods

List Prebuilt Policies -> SinglePage<{ applicable_destinations, policy_description, policy_name, 1 more... }>
get/accounts/{account_id}/magic/cloud/catalog-syncs/prebuilt-policies

List prebuilt catalog sync policies (Closed Beta).

Magic Cloud Networking

Cloud Integrations

magic_cloud_networking.cloud_integrations

Methods

List Cloud Integrations -> SinglePage<{ id, cloud_type, friendly_name, 11 more... }>
get/accounts/{account_id}/magic/cloud/providers

List Cloud Integrations (Closed Beta).

Read Cloud Integration -> Envelope<{ id, cloud_type, friendly_name, 11 more... }>
get/accounts/{account_id}/magic/cloud/providers/{provider_id}

Read a Cloud Integration (Closed Beta).

Create Cloud Integration -> Envelope<{ id, cloud_type, friendly_name, 11 more... }>
post/accounts/{account_id}/magic/cloud/providers

Create a new Cloud Integration (Closed Beta).

Update Cloud Integration -> Envelope<{ id, cloud_type, friendly_name, 11 more... }>
put/accounts/{account_id}/magic/cloud/providers/{provider_id}

Update a Cloud Integration (Closed Beta).

Patch Cloud Integration -> Envelope<{ id, cloud_type, friendly_name, 11 more... }>
patch/accounts/{account_id}/magic/cloud/providers/{provider_id}

Update a Cloud Integration (Closed Beta).

Delete Cloud Integration -> Envelope<{ id }>
delete/accounts/{account_id}/magic/cloud/providers/{provider_id}

Delete a Cloud Integration (Closed Beta).

Security

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example: Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Accepted Permissions (at least one required)

Magic WAN Write

path Parameters
account_id: string
provider_id: string
(format: uuid)
Response fields
errors: Array<{ code, message, documentation_url, 2 more... }>
(maxLength: 0)
messages: Array<{ code, message, documentation_url, 2 more... }>
result: { id }
success: boolean
Request example
200Example
Run Discovery For All Integrations -> { errors, messages, success }
post/accounts/{account_id}/magic/cloud/providers/discover

Run discovery for all Cloud Integrations in an account (Closed Beta).

Run Discovery -> { errors, messages, success }
post/accounts/{account_id}/magic/cloud/providers/{provider_id}/discover

Run discovery for a Cloud Integration (Closed Beta).

Get Cloud Integration Setup Config -> Envelope<{ aws_trust_policy, item_type } | { azure_consent_url, integration_identity_tag, item_type, 1 more... } | { integration_identity_tag, item_type, tag_cli_command }>
get/accounts/{account_id}/magic/cloud/providers/{provider_id}/initial_setup

Get initial configuration to complete Cloud Integration setup (Closed Beta).

Magic Cloud Networking

On Ramps

magic_cloud_networking.on_ramps

Methods

List On Ramps -> SinglePage<{ id, cloud_type, install_routes_in_cloud, 24 more... }>
get/accounts/{account_id}/magic/cloud/onramps

List On-ramps (Closed Beta).

Read On Ramp -> Envelope<{ id, cloud_type, install_routes_in_cloud, 24 more... }>
get/accounts/{account_id}/magic/cloud/onramps/{onramp_id}

Read an On-ramp (Closed Beta).

Create On Ramp -> Envelope<{ id, cloud_type, install_routes_in_cloud, 24 more... }>
post/accounts/{account_id}/magic/cloud/onramps

Create a new On-ramp (Closed Beta).

Update On Ramp -> Envelope<{ id, cloud_type, install_routes_in_cloud, 24 more... }>
put/accounts/{account_id}/magic/cloud/onramps/{onramp_id}

Update an On-ramp (Closed Beta).

Patch On Ramp -> Envelope<{ id, cloud_type, install_routes_in_cloud, 24 more... }>
patch/accounts/{account_id}/magic/cloud/onramps/{onramp_id}

Update an On-ramp (Closed Beta).

Delete On Ramp -> Envelope<{ id }>
delete/accounts/{account_id}/magic/cloud/onramps/{onramp_id}

Delete an On-ramp (Closed Beta).

Apply On Ramp -> { errors, messages, success }
post/accounts/{account_id}/magic/cloud/onramps/{onramp_id}/apply

Apply an On-ramp (Closed Beta).

Export As Terraform -> unknown
post/accounts/{account_id}/magic/cloud/onramps/{onramp_id}/export

Export an On-ramp to terraform ready file(s) (Closed Beta).

Plan On Ramp -> { errors, messages, success }
post/accounts/{account_id}/magic/cloud/onramps/{onramp_id}/plan

Plan an On-ramp (Closed Beta).

Magic Cloud NetworkingOn Ramps

Address Spaces

magic_cloud_networking.on_ramps.address_spaces

Methods

Read Magic WAN Address Space -> Envelope<{ prefixes }>
get/accounts/{account_id}/magic/cloud/onramps/magic_wan_address_space

Read the Magic WAN Address Space (Closed Beta).

Update Magic WAN Address Space -> Envelope<{ prefixes }>
put/accounts/{account_id}/magic/cloud/onramps/magic_wan_address_space

Update the Magic WAN Address Space (Closed Beta).

Patch Magic WAN Address Space -> Envelope<{ prefixes }>
patch/accounts/{account_id}/magic/cloud/onramps/magic_wan_address_space

Update the Magic WAN Address Space (Closed Beta).

Magic Cloud Networking

Resources

magic_cloud_networking.resources

Methods

List Resources -> V4PagePaginationArray<{ id, account_id, cloud_type, 18 more... }>
get/accounts/{account_id}/magic/cloud/resources

List resources in the Resource Catalog (Closed Beta).

Read Resource -> Envelope<{ id, account_id, cloud_type, 18 more... }>
get/accounts/{account_id}/magic/cloud/resources/{resource_id}

Read an resource from the Resource Catalog (Closed Beta).

Export Resources -> unknown
get/accounts/{account_id}/magic/cloud/resources/export

Export resources in the Resource Catalog as a JSON file (Closed Beta).

Preview Rego Query -> Envelope<string>
post/accounts/{account_id}/magic/cloud/resources/policy-preview

Preview Rego query result against the latest resource catalog (Closed Beta).