List Prebuilt Policies

client.MagicCloudNetworking.CatalogSyncs.PrebuiltPolicies.List(ctx, params) (*SinglePage[CatalogSyncPrebuiltPolicyListResponse], error)

GET/accounts/{account_id}/magic/cloud/catalog-syncs/prebuilt-policies

List prebuilt catalog sync policies (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 CatalogSyncPrebuiltPolicyListParams

AccountID param.Field[string]

Path param

DestinationType param.Field[CatalogSyncPrebuiltPolicyListParamsDestinationType]Optional

Query param: Specify type of destination, omit to return all.

const CatalogSyncPrebuiltPolicyListParamsDestinationTypeNone CatalogSyncPrebuiltPolicyListParamsDestinationType = "NONE"

const CatalogSyncPrebuiltPolicyListParamsDestinationTypeZeroTrustList CatalogSyncPrebuiltPolicyListParamsDestinationType = "ZERO_TRUST_LIST"

ReturnsExpand Collapse

type CatalogSyncPrebuiltPolicyListResponse struct{…}

ApplicableDestinations []CatalogSyncPrebuiltPolicyListResponseApplicableDestination

One of the following:

const CatalogSyncPrebuiltPolicyListResponseApplicableDestinationNone CatalogSyncPrebuiltPolicyListResponseApplicableDestination = "NONE"

const CatalogSyncPrebuiltPolicyListResponseApplicableDestinationZeroTrustList CatalogSyncPrebuiltPolicyListResponseApplicableDestination = "ZERO_TRUST_LIST"

PolicyDescription string

PolicyName string

PolicyString string

List Prebuilt Policies

package main

import (
  "context"
  "fmt"

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

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

{
  "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": [
    {
      "applicable_destinations": [
        "NONE"
      ],
      "policy_description": "policy_description",
      "policy_name": "policy_name",
      "policy_string": "policy_string"
    }
  ],
  "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": [
    {
      "applicable_destinations": [
        "NONE"
      ],
      "policy_description": "policy_description",
      "policy_name": "policy_name",
      "policy_string": "policy_string"
    }
  ],
  "success": true
}