Read Cloud Integration

client.MagicCloudNetworking.CloudIntegrations.Get(ctx, providerID, params) (*CloudIntegrationGetResponse, error)

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

Read a Cloud Integration (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

providerID string

formatuuid

params CloudIntegrationGetParams

AccountID param.Field[string]

Path param

Status param.Field[bool]optional

Query param

ReturnsExpand Collapse

type CloudIntegrationGetResponse struct{…}

ID string

formatuuid

CloudType CloudIntegrationGetResponseCloudType

One of the following:

const CloudIntegrationGetResponseCloudTypeAws CloudIntegrationGetResponseCloudType = "AWS"

const CloudIntegrationGetResponseCloudTypeAzure CloudIntegrationGetResponseCloudType = "AZURE"

const CloudIntegrationGetResponseCloudTypeGoogle CloudIntegrationGetResponseCloudType = "GOOGLE"

const CloudIntegrationGetResponseCloudTypeCloudflare CloudIntegrationGetResponseCloudType = "CLOUDFLARE"

FriendlyName string

LastUpdated string

LifecycleState CloudIntegrationGetResponseLifecycleState

One of the following:

const CloudIntegrationGetResponseLifecycleStateActive CloudIntegrationGetResponseLifecycleState = "ACTIVE"

const CloudIntegrationGetResponseLifecycleStatePendingSetup CloudIntegrationGetResponseLifecycleState = "PENDING_SETUP"

const CloudIntegrationGetResponseLifecycleStateRetired CloudIntegrationGetResponseLifecycleState = "RETIRED"

State CloudIntegrationGetResponseState

One of the following:

const CloudIntegrationGetResponseStateUnspecified CloudIntegrationGetResponseState = "UNSPECIFIED"

const CloudIntegrationGetResponseStatePending CloudIntegrationGetResponseState = "PENDING"

const CloudIntegrationGetResponseStateDiscovering CloudIntegrationGetResponseState = "DISCOVERING"

const CloudIntegrationGetResponseStateFailed CloudIntegrationGetResponseState = "FAILED"

const CloudIntegrationGetResponseStateSucceeded CloudIntegrationGetResponseState = "SUCCEEDED"

StateV2 CloudIntegrationGetResponseStateV2

One of the following:

const CloudIntegrationGetResponseStateV2Unspecified CloudIntegrationGetResponseStateV2 = "UNSPECIFIED"

const CloudIntegrationGetResponseStateV2Pending CloudIntegrationGetResponseStateV2 = "PENDING"

const CloudIntegrationGetResponseStateV2Discovering CloudIntegrationGetResponseStateV2 = "DISCOVERING"

const CloudIntegrationGetResponseStateV2Failed CloudIntegrationGetResponseStateV2 = "FAILED"

const CloudIntegrationGetResponseStateV2Succeeded CloudIntegrationGetResponseStateV2 = "SUCCEEDED"

AwsArn stringoptional

AzureSubscriptionID stringoptional

AzureTenantID stringoptional

Description stringoptional

GcpProjectID stringoptional

GcpServiceAccountEmail stringoptional

Status CloudIntegrationGetResponseStatusoptional

DiscoveryProgress CloudIntegrationGetResponseStatusDiscoveryProgress

Done int64

Total int64

Unit string

DiscoveryProgressV2 CloudIntegrationGetResponseStatusDiscoveryProgressV2

Done int64

Total int64

Unit string

LastDiscoveryStatus CloudIntegrationGetResponseStatusLastDiscoveryStatus

One of the following:

const CloudIntegrationGetResponseStatusLastDiscoveryStatusUnspecified CloudIntegrationGetResponseStatusLastDiscoveryStatus = "UNSPECIFIED"

const CloudIntegrationGetResponseStatusLastDiscoveryStatusPending CloudIntegrationGetResponseStatusLastDiscoveryStatus = "PENDING"

const CloudIntegrationGetResponseStatusLastDiscoveryStatusDiscovering CloudIntegrationGetResponseStatusLastDiscoveryStatus = "DISCOVERING"

const CloudIntegrationGetResponseStatusLastDiscoveryStatusFailed CloudIntegrationGetResponseStatusLastDiscoveryStatus = "FAILED"

const CloudIntegrationGetResponseStatusLastDiscoveryStatusSucceeded CloudIntegrationGetResponseStatusLastDiscoveryStatus = "SUCCEEDED"

LastDiscoveryStatusV2 CloudIntegrationGetResponseStatusLastDiscoveryStatusV2

One of the following:

const CloudIntegrationGetResponseStatusLastDiscoveryStatusV2Unspecified CloudIntegrationGetResponseStatusLastDiscoveryStatusV2 = "UNSPECIFIED"

const CloudIntegrationGetResponseStatusLastDiscoveryStatusV2Pending CloudIntegrationGetResponseStatusLastDiscoveryStatusV2 = "PENDING"

const CloudIntegrationGetResponseStatusLastDiscoveryStatusV2Discovering CloudIntegrationGetResponseStatusLastDiscoveryStatusV2 = "DISCOVERING"

const CloudIntegrationGetResponseStatusLastDiscoveryStatusV2Failed CloudIntegrationGetResponseStatusLastDiscoveryStatusV2 = "FAILED"

const CloudIntegrationGetResponseStatusLastDiscoveryStatusV2Succeeded CloudIntegrationGetResponseStatusLastDiscoveryStatusV2 = "SUCCEEDED"

Regions []string

CredentialsGoodSince stringoptional

CredentialsMissingSince stringoptional

CredentialsRejectedSince stringoptional

DiscoveryMessage stringoptional

DiscoveryMessageV2 stringoptional

InUseBy []CloudIntegrationGetResponseStatusInUseByoptional

ID string

formatuuid

ClientType CloudIntegrationGetResponseStatusInUseByClientType

Name string

LastDiscoveryCompletedAt stringoptional

LastDiscoveryCompletedAtV2 stringoptional

LastDiscoveryStartedAt stringoptional

LastDiscoveryStartedAtV2 stringoptional

LastUpdated stringoptional

Read Cloud Integration

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"),
  )
  cloudIntegration, err := client.MagicCloudNetworking.CloudIntegrations.Get(
    context.TODO(),
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    magic_cloud_networking.CloudIntegrationGetParams{
      AccountID: cloudflare.F("account_id"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", cloudIntegration.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",
    "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

{
  "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
}