API Reference

Magic Cloud Networking

Cloud Integrations

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List Cloud Integrations

client.MagicCloudNetworking.CloudIntegrations.List(ctx, params) (*SinglePage[CloudIntegrationListResponse], error)

GET/accounts/{account_id}/magic/cloud/providers

List Cloud Integrations (Closed Beta).

Security

API Token

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

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API 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.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Magic WAN WriteMagic WAN Read

ParametersExpand Collapse

params CloudIntegrationListParams

AccountID param.Field[string]

Path param

Cloudflare param.Field[bool]optional

Query param

Desc param.Field[bool]optional

Query param

OrderBy param.Field[string]optional

Query param: One of ["updated_at", "id", "cloud_type", "name"].

Status param.Field[bool]optional

Query param

ReturnsExpand Collapse

type CloudIntegrationListResponse struct{…}

ID string

formatuuid

CloudType CloudIntegrationListResponseCloudType

One of the following:

const CloudIntegrationListResponseCloudTypeAws CloudIntegrationListResponseCloudType = "AWS"

const CloudIntegrationListResponseCloudTypeAzure CloudIntegrationListResponseCloudType = "AZURE"

const CloudIntegrationListResponseCloudTypeGoogle CloudIntegrationListResponseCloudType = "GOOGLE"

const CloudIntegrationListResponseCloudTypeCloudflare CloudIntegrationListResponseCloudType = "CLOUDFLARE"

FriendlyName string

LastUpdated string

LifecycleState CloudIntegrationListResponseLifecycleState

One of the following:

const CloudIntegrationListResponseLifecycleStateActive CloudIntegrationListResponseLifecycleState = "ACTIVE"

const CloudIntegrationListResponseLifecycleStatePendingSetup CloudIntegrationListResponseLifecycleState = "PENDING_SETUP"

const CloudIntegrationListResponseLifecycleStateRetired CloudIntegrationListResponseLifecycleState = "RETIRED"

State CloudIntegrationListResponseState

One of the following:

const CloudIntegrationListResponseStateUnspecified CloudIntegrationListResponseState = "UNSPECIFIED"

const CloudIntegrationListResponseStatePending CloudIntegrationListResponseState = "PENDING"

const CloudIntegrationListResponseStateDiscovering CloudIntegrationListResponseState = "DISCOVERING"

const CloudIntegrationListResponseStateFailed CloudIntegrationListResponseState = "FAILED"

const CloudIntegrationListResponseStateSucceeded CloudIntegrationListResponseState = "SUCCEEDED"

StateV2 CloudIntegrationListResponseStateV2

One of the following:

const CloudIntegrationListResponseStateV2Unspecified CloudIntegrationListResponseStateV2 = "UNSPECIFIED"

const CloudIntegrationListResponseStateV2Pending CloudIntegrationListResponseStateV2 = "PENDING"

const CloudIntegrationListResponseStateV2Discovering CloudIntegrationListResponseStateV2 = "DISCOVERING"

const CloudIntegrationListResponseStateV2Failed CloudIntegrationListResponseStateV2 = "FAILED"

const CloudIntegrationListResponseStateV2Succeeded CloudIntegrationListResponseStateV2 = "SUCCEEDED"

AwsArn stringoptional

AzureSubscriptionID stringoptional

AzureTenantID stringoptional

Description stringoptional

GcpProjectID stringoptional

GcpServiceAccountEmail stringoptional

Status CloudIntegrationListResponseStatusoptional

DiscoveryProgress CloudIntegrationListResponseStatusDiscoveryProgress

Done int64

Total int64

Unit string

DiscoveryProgressV2 CloudIntegrationListResponseStatusDiscoveryProgressV2

Done int64

Total int64

Unit string

LastDiscoveryStatus CloudIntegrationListResponseStatusLastDiscoveryStatus

One of the following:

const CloudIntegrationListResponseStatusLastDiscoveryStatusUnspecified CloudIntegrationListResponseStatusLastDiscoveryStatus = "UNSPECIFIED"

const CloudIntegrationListResponseStatusLastDiscoveryStatusPending CloudIntegrationListResponseStatusLastDiscoveryStatus = "PENDING"

const CloudIntegrationListResponseStatusLastDiscoveryStatusDiscovering CloudIntegrationListResponseStatusLastDiscoveryStatus = "DISCOVERING"

const CloudIntegrationListResponseStatusLastDiscoveryStatusFailed CloudIntegrationListResponseStatusLastDiscoveryStatus = "FAILED"

const CloudIntegrationListResponseStatusLastDiscoveryStatusSucceeded CloudIntegrationListResponseStatusLastDiscoveryStatus = "SUCCEEDED"

LastDiscoveryStatusV2 CloudIntegrationListResponseStatusLastDiscoveryStatusV2

One of the following:

const CloudIntegrationListResponseStatusLastDiscoveryStatusV2Unspecified CloudIntegrationListResponseStatusLastDiscoveryStatusV2 = "UNSPECIFIED"

const CloudIntegrationListResponseStatusLastDiscoveryStatusV2Pending CloudIntegrationListResponseStatusLastDiscoveryStatusV2 = "PENDING"

const CloudIntegrationListResponseStatusLastDiscoveryStatusV2Discovering CloudIntegrationListResponseStatusLastDiscoveryStatusV2 = "DISCOVERING"

const CloudIntegrationListResponseStatusLastDiscoveryStatusV2Failed CloudIntegrationListResponseStatusLastDiscoveryStatusV2 = "FAILED"

const CloudIntegrationListResponseStatusLastDiscoveryStatusV2Succeeded CloudIntegrationListResponseStatusLastDiscoveryStatusV2 = "SUCCEEDED"

Regions []string

CredentialsGoodSince stringoptional

CredentialsMissingSince stringoptional

CredentialsRejectedSince stringoptional

DiscoveryMessage stringoptional

DiscoveryMessageV2 stringoptional

InUseBy []CloudIntegrationListResponseStatusInUseByoptional

ID string

formatuuid

ClientType CloudIntegrationListResponseStatusInUseByClientType

Name string

LastDiscoveryCompletedAt stringoptional

LastDiscoveryCompletedAtV2 stringoptional

LastDiscoveryStartedAt stringoptional

LastDiscoveryStartedAtV2 stringoptional

LastUpdated stringoptional

List Cloud Integrations

Go

HTTP

TypeScript

Python

Go

Terraform

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/magic_cloud_networking"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  page, err := client.MagicCloudNetworking.CloudIntegrations.List(context.TODO(), magic_cloud_networking.CloudIntegrationListParams{
    AccountID: cloudflare.F("account_id"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

200 example

{
  "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",
      "friendly_name": "friendly_name",
      "last_updated": "last_updated",
      "lifecycle_state": "ACTIVE",
      "state": "UNSPECIFIED",
      "state_v2": "UNSPECIFIED",
      "aws_arn": "aws_arn",
      "azure_subscription_id": "azure_subscription_id",
      "azure_tenant_id": "azure_tenant_id",
      "description": "description",
      "gcp_project_id": "gcp_project_id",
      "gcp_service_account_email": "gcp_service_account_email",
      "status": {
        "discovery_progress": {
          "done": 0,
          "total": 0,
          "unit": "unit"
        },
        "discovery_progress_v2": {
          "done": 0,
          "total": 0,
          "unit": "unit"
        },
        "last_discovery_status": "UNSPECIFIED",
        "last_discovery_status_v2": "UNSPECIFIED",
        "regions": [
          "string"
        ],
        "credentials_good_since": "credentials_good_since",
        "credentials_missing_since": "credentials_missing_since",
        "credentials_rejected_since": "credentials_rejected_since",
        "discovery_message": "discovery_message",
        "discovery_message_v2": "discovery_message_v2",
        "in_use_by": [
          {
            "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "client_type": "MAGIC_WAN_CLOUD_ONRAMP",
            "name": "name"
          }
        ],
        "last_discovery_completed_at": "last_discovery_completed_at",
        "last_discovery_completed_at_v2": "last_discovery_completed_at_v2",
        "last_discovery_started_at": "last_discovery_started_at",
        "last_discovery_started_at_v2": "last_discovery_started_at_v2",
        "last_updated": "last_updated"
      }
    }
  ],
  "success": true
}

Returns Examples

200 example

{
  "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",
      "friendly_name": "friendly_name",
      "last_updated": "last_updated",
      "lifecycle_state": "ACTIVE",
      "state": "UNSPECIFIED",
      "state_v2": "UNSPECIFIED",
      "aws_arn": "aws_arn",
      "azure_subscription_id": "azure_subscription_id",
      "azure_tenant_id": "azure_tenant_id",
      "description": "description",
      "gcp_project_id": "gcp_project_id",
      "gcp_service_account_email": "gcp_service_account_email",
      "status": {
        "discovery_progress": {
          "done": 0,
          "total": 0,
          "unit": "unit"
        },
        "discovery_progress_v2": {
          "done": 0,
          "total": 0,
          "unit": "unit"
        },
        "last_discovery_status": "UNSPECIFIED",
        "last_discovery_status_v2": "UNSPECIFIED",
        "regions": [
          "string"
        ],
        "credentials_good_since": "credentials_good_since",
        "credentials_missing_since": "credentials_missing_since",
        "credentials_rejected_since": "credentials_rejected_since",
        "discovery_message": "discovery_message",
        "discovery_message_v2": "discovery_message_v2",
        "in_use_by": [
          {
            "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            "client_type": "MAGIC_WAN_CLOUD_ONRAMP",
            "name": "name"
          }
        ],
        "last_discovery_completed_at": "last_discovery_completed_at",
        "last_discovery_completed_at_v2": "last_discovery_completed_at_v2",
        "last_discovery_started_at": "last_discovery_started_at",
        "last_discovery_started_at_v2": "last_discovery_started_at_v2",
        "last_updated": "last_updated"
      }
    }
  ],
  "success": true
}