Skip to content
Start here

Create Catalog Sync

client.MagicCloudNetworking.CatalogSyncs.New(ctx, params) (*CatalogSyncNewResponse, error)
POST/accounts/{account_id}/magic/cloud/catalog-syncs

Create a new Catalog Sync (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 Write
ParametersExpand Collapse
params CatalogSyncNewParams
AccountID param.Field[string]

Path param

DestinationType param.Field[CatalogSyncNewParamsDestinationType]

Body param

const CatalogSyncNewParamsDestinationTypeNone CatalogSyncNewParamsDestinationType = "NONE"
const CatalogSyncNewParamsDestinationTypeZeroTrustList CatalogSyncNewParamsDestinationType = "ZERO_TRUST_LIST"
Name param.Field[string]

Body param

UpdateMode param.Field[CatalogSyncNewParamsUpdateMode]

Body param

const CatalogSyncNewParamsUpdateModeAuto CatalogSyncNewParamsUpdateMode = "AUTO"
const CatalogSyncNewParamsUpdateModeManual CatalogSyncNewParamsUpdateMode = "MANUAL"
Description param.Field[string]optional

Body param

Policy param.Field[string]optional

Body param

Forwarded param.Field[string]optional

Header param

ReturnsExpand Collapse
type CatalogSyncNewResponse struct{…}
ID string
formatuuid
Description string
DestinationID string
formatuuid
DestinationType CatalogSyncNewResponseDestinationType
One of the following:
const CatalogSyncNewResponseDestinationTypeNone CatalogSyncNewResponseDestinationType = "NONE"
const CatalogSyncNewResponseDestinationTypeZeroTrustList CatalogSyncNewResponseDestinationType = "ZERO_TRUST_LIST"
LastUserUpdateAt string
Name string
Policy string
UpdateMode CatalogSyncNewResponseUpdateMode
One of the following:
const CatalogSyncNewResponseUpdateModeAuto CatalogSyncNewResponseUpdateMode = "AUTO"
const CatalogSyncNewResponseUpdateModeManual CatalogSyncNewResponseUpdateMode = "MANUAL"
Errors map[string, CatalogSyncNewResponseError]optional
Code CatalogSyncNewResponseErrorsCode
One of the following:
const CatalogSyncNewResponseErrorsCode1001 CatalogSyncNewResponseErrorsCode = 1001
const CatalogSyncNewResponseErrorsCode1002 CatalogSyncNewResponseErrorsCode = 1002
const CatalogSyncNewResponseErrorsCode1003 CatalogSyncNewResponseErrorsCode = 1003
const CatalogSyncNewResponseErrorsCode1004 CatalogSyncNewResponseErrorsCode = 1004
const CatalogSyncNewResponseErrorsCode1005 CatalogSyncNewResponseErrorsCode = 1005
const CatalogSyncNewResponseErrorsCode1006 CatalogSyncNewResponseErrorsCode = 1006
const CatalogSyncNewResponseErrorsCode1007 CatalogSyncNewResponseErrorsCode = 1007
const CatalogSyncNewResponseErrorsCode1008 CatalogSyncNewResponseErrorsCode = 1008
const CatalogSyncNewResponseErrorsCode1009 CatalogSyncNewResponseErrorsCode = 1009
const CatalogSyncNewResponseErrorsCode1010 CatalogSyncNewResponseErrorsCode = 1010
const CatalogSyncNewResponseErrorsCode1011 CatalogSyncNewResponseErrorsCode = 1011
const CatalogSyncNewResponseErrorsCode1012 CatalogSyncNewResponseErrorsCode = 1012
const CatalogSyncNewResponseErrorsCode1013 CatalogSyncNewResponseErrorsCode = 1013
const CatalogSyncNewResponseErrorsCode1014 CatalogSyncNewResponseErrorsCode = 1014
const CatalogSyncNewResponseErrorsCode1015 CatalogSyncNewResponseErrorsCode = 1015
const CatalogSyncNewResponseErrorsCode1016 CatalogSyncNewResponseErrorsCode = 1016
const CatalogSyncNewResponseErrorsCode1017 CatalogSyncNewResponseErrorsCode = 1017
const CatalogSyncNewResponseErrorsCode1018 CatalogSyncNewResponseErrorsCode = 1018
const CatalogSyncNewResponseErrorsCode2001 CatalogSyncNewResponseErrorsCode = 2001
const CatalogSyncNewResponseErrorsCode2002 CatalogSyncNewResponseErrorsCode = 2002
const CatalogSyncNewResponseErrorsCode2003 CatalogSyncNewResponseErrorsCode = 2003
const CatalogSyncNewResponseErrorsCode2004 CatalogSyncNewResponseErrorsCode = 2004
const CatalogSyncNewResponseErrorsCode2005 CatalogSyncNewResponseErrorsCode = 2005
const CatalogSyncNewResponseErrorsCode2006 CatalogSyncNewResponseErrorsCode = 2006
const CatalogSyncNewResponseErrorsCode2007 CatalogSyncNewResponseErrorsCode = 2007
const CatalogSyncNewResponseErrorsCode2008 CatalogSyncNewResponseErrorsCode = 2008
const CatalogSyncNewResponseErrorsCode2009 CatalogSyncNewResponseErrorsCode = 2009
const CatalogSyncNewResponseErrorsCode2010 CatalogSyncNewResponseErrorsCode = 2010
const CatalogSyncNewResponseErrorsCode2011 CatalogSyncNewResponseErrorsCode = 2011
const CatalogSyncNewResponseErrorsCode2012 CatalogSyncNewResponseErrorsCode = 2012
const CatalogSyncNewResponseErrorsCode2013 CatalogSyncNewResponseErrorsCode = 2013
const CatalogSyncNewResponseErrorsCode2014 CatalogSyncNewResponseErrorsCode = 2014
const CatalogSyncNewResponseErrorsCode2015 CatalogSyncNewResponseErrorsCode = 2015
const CatalogSyncNewResponseErrorsCode2016 CatalogSyncNewResponseErrorsCode = 2016
const CatalogSyncNewResponseErrorsCode2017 CatalogSyncNewResponseErrorsCode = 2017
const CatalogSyncNewResponseErrorsCode2018 CatalogSyncNewResponseErrorsCode = 2018
const CatalogSyncNewResponseErrorsCode2019 CatalogSyncNewResponseErrorsCode = 2019
const CatalogSyncNewResponseErrorsCode2020 CatalogSyncNewResponseErrorsCode = 2020
const CatalogSyncNewResponseErrorsCode2021 CatalogSyncNewResponseErrorsCode = 2021
const CatalogSyncNewResponseErrorsCode2022 CatalogSyncNewResponseErrorsCode = 2022
const CatalogSyncNewResponseErrorsCode3001 CatalogSyncNewResponseErrorsCode = 3001
const CatalogSyncNewResponseErrorsCode3002 CatalogSyncNewResponseErrorsCode = 3002
const CatalogSyncNewResponseErrorsCode3003 CatalogSyncNewResponseErrorsCode = 3003
const CatalogSyncNewResponseErrorsCode3004 CatalogSyncNewResponseErrorsCode = 3004
const CatalogSyncNewResponseErrorsCode3005 CatalogSyncNewResponseErrorsCode = 3005
const CatalogSyncNewResponseErrorsCode3006 CatalogSyncNewResponseErrorsCode = 3006
const CatalogSyncNewResponseErrorsCode3007 CatalogSyncNewResponseErrorsCode = 3007
const CatalogSyncNewResponseErrorsCode4001 CatalogSyncNewResponseErrorsCode = 4001
const CatalogSyncNewResponseErrorsCode4002 CatalogSyncNewResponseErrorsCode = 4002
const CatalogSyncNewResponseErrorsCode4003 CatalogSyncNewResponseErrorsCode = 4003
const CatalogSyncNewResponseErrorsCode4004 CatalogSyncNewResponseErrorsCode = 4004
const CatalogSyncNewResponseErrorsCode4005 CatalogSyncNewResponseErrorsCode = 4005
const CatalogSyncNewResponseErrorsCode4006 CatalogSyncNewResponseErrorsCode = 4006
const CatalogSyncNewResponseErrorsCode4007 CatalogSyncNewResponseErrorsCode = 4007
const CatalogSyncNewResponseErrorsCode4008 CatalogSyncNewResponseErrorsCode = 4008
const CatalogSyncNewResponseErrorsCode4009 CatalogSyncNewResponseErrorsCode = 4009
const CatalogSyncNewResponseErrorsCode4010 CatalogSyncNewResponseErrorsCode = 4010
const CatalogSyncNewResponseErrorsCode4011 CatalogSyncNewResponseErrorsCode = 4011
const CatalogSyncNewResponseErrorsCode4012 CatalogSyncNewResponseErrorsCode = 4012
const CatalogSyncNewResponseErrorsCode4013 CatalogSyncNewResponseErrorsCode = 4013
const CatalogSyncNewResponseErrorsCode4014 CatalogSyncNewResponseErrorsCode = 4014
const CatalogSyncNewResponseErrorsCode4015 CatalogSyncNewResponseErrorsCode = 4015
const CatalogSyncNewResponseErrorsCode4016 CatalogSyncNewResponseErrorsCode = 4016
const CatalogSyncNewResponseErrorsCode4017 CatalogSyncNewResponseErrorsCode = 4017
const CatalogSyncNewResponseErrorsCode4018 CatalogSyncNewResponseErrorsCode = 4018
const CatalogSyncNewResponseErrorsCode4019 CatalogSyncNewResponseErrorsCode = 4019
const CatalogSyncNewResponseErrorsCode4020 CatalogSyncNewResponseErrorsCode = 4020
const CatalogSyncNewResponseErrorsCode4021 CatalogSyncNewResponseErrorsCode = 4021
const CatalogSyncNewResponseErrorsCode4022 CatalogSyncNewResponseErrorsCode = 4022
const CatalogSyncNewResponseErrorsCode4023 CatalogSyncNewResponseErrorsCode = 4023
const CatalogSyncNewResponseErrorsCode5001 CatalogSyncNewResponseErrorsCode = 5001
const CatalogSyncNewResponseErrorsCode5002 CatalogSyncNewResponseErrorsCode = 5002
const CatalogSyncNewResponseErrorsCode5003 CatalogSyncNewResponseErrorsCode = 5003
const CatalogSyncNewResponseErrorsCode5004 CatalogSyncNewResponseErrorsCode = 5004
const CatalogSyncNewResponseErrorsCode102000 CatalogSyncNewResponseErrorsCode = 102000
const CatalogSyncNewResponseErrorsCode102001 CatalogSyncNewResponseErrorsCode = 102001
const CatalogSyncNewResponseErrorsCode102002 CatalogSyncNewResponseErrorsCode = 102002
const CatalogSyncNewResponseErrorsCode102003 CatalogSyncNewResponseErrorsCode = 102003
const CatalogSyncNewResponseErrorsCode102004 CatalogSyncNewResponseErrorsCode = 102004
const CatalogSyncNewResponseErrorsCode102005 CatalogSyncNewResponseErrorsCode = 102005
const CatalogSyncNewResponseErrorsCode102006 CatalogSyncNewResponseErrorsCode = 102006
const CatalogSyncNewResponseErrorsCode102007 CatalogSyncNewResponseErrorsCode = 102007
const CatalogSyncNewResponseErrorsCode102008 CatalogSyncNewResponseErrorsCode = 102008
const CatalogSyncNewResponseErrorsCode102009 CatalogSyncNewResponseErrorsCode = 102009
const CatalogSyncNewResponseErrorsCode102010 CatalogSyncNewResponseErrorsCode = 102010
const CatalogSyncNewResponseErrorsCode102011 CatalogSyncNewResponseErrorsCode = 102011
const CatalogSyncNewResponseErrorsCode102012 CatalogSyncNewResponseErrorsCode = 102012
const CatalogSyncNewResponseErrorsCode102013 CatalogSyncNewResponseErrorsCode = 102013
const CatalogSyncNewResponseErrorsCode102014 CatalogSyncNewResponseErrorsCode = 102014
const CatalogSyncNewResponseErrorsCode102015 CatalogSyncNewResponseErrorsCode = 102015
const CatalogSyncNewResponseErrorsCode102016 CatalogSyncNewResponseErrorsCode = 102016
const CatalogSyncNewResponseErrorsCode102017 CatalogSyncNewResponseErrorsCode = 102017
const CatalogSyncNewResponseErrorsCode102018 CatalogSyncNewResponseErrorsCode = 102018
const CatalogSyncNewResponseErrorsCode102019 CatalogSyncNewResponseErrorsCode = 102019
const CatalogSyncNewResponseErrorsCode102020 CatalogSyncNewResponseErrorsCode = 102020
const CatalogSyncNewResponseErrorsCode102021 CatalogSyncNewResponseErrorsCode = 102021
const CatalogSyncNewResponseErrorsCode102022 CatalogSyncNewResponseErrorsCode = 102022
const CatalogSyncNewResponseErrorsCode102023 CatalogSyncNewResponseErrorsCode = 102023
const CatalogSyncNewResponseErrorsCode102024 CatalogSyncNewResponseErrorsCode = 102024
const CatalogSyncNewResponseErrorsCode102025 CatalogSyncNewResponseErrorsCode = 102025
const CatalogSyncNewResponseErrorsCode102026 CatalogSyncNewResponseErrorsCode = 102026
const CatalogSyncNewResponseErrorsCode102027 CatalogSyncNewResponseErrorsCode = 102027
const CatalogSyncNewResponseErrorsCode102028 CatalogSyncNewResponseErrorsCode = 102028
const CatalogSyncNewResponseErrorsCode102029 CatalogSyncNewResponseErrorsCode = 102029
const CatalogSyncNewResponseErrorsCode102030 CatalogSyncNewResponseErrorsCode = 102030
const CatalogSyncNewResponseErrorsCode102031 CatalogSyncNewResponseErrorsCode = 102031
const CatalogSyncNewResponseErrorsCode102032 CatalogSyncNewResponseErrorsCode = 102032
const CatalogSyncNewResponseErrorsCode102033 CatalogSyncNewResponseErrorsCode = 102033
const CatalogSyncNewResponseErrorsCode102034 CatalogSyncNewResponseErrorsCode = 102034
const CatalogSyncNewResponseErrorsCode102035 CatalogSyncNewResponseErrorsCode = 102035
const CatalogSyncNewResponseErrorsCode102036 CatalogSyncNewResponseErrorsCode = 102036
const CatalogSyncNewResponseErrorsCode102037 CatalogSyncNewResponseErrorsCode = 102037
const CatalogSyncNewResponseErrorsCode102038 CatalogSyncNewResponseErrorsCode = 102038
const CatalogSyncNewResponseErrorsCode102039 CatalogSyncNewResponseErrorsCode = 102039
const CatalogSyncNewResponseErrorsCode102040 CatalogSyncNewResponseErrorsCode = 102040
const CatalogSyncNewResponseErrorsCode102041 CatalogSyncNewResponseErrorsCode = 102041
const CatalogSyncNewResponseErrorsCode102042 CatalogSyncNewResponseErrorsCode = 102042
const CatalogSyncNewResponseErrorsCode102043 CatalogSyncNewResponseErrorsCode = 102043
const CatalogSyncNewResponseErrorsCode102044 CatalogSyncNewResponseErrorsCode = 102044
const CatalogSyncNewResponseErrorsCode102045 CatalogSyncNewResponseErrorsCode = 102045
const CatalogSyncNewResponseErrorsCode102046 CatalogSyncNewResponseErrorsCode = 102046
const CatalogSyncNewResponseErrorsCode102047 CatalogSyncNewResponseErrorsCode = 102047
const CatalogSyncNewResponseErrorsCode102048 CatalogSyncNewResponseErrorsCode = 102048
const CatalogSyncNewResponseErrorsCode102049 CatalogSyncNewResponseErrorsCode = 102049
const CatalogSyncNewResponseErrorsCode102050 CatalogSyncNewResponseErrorsCode = 102050
const CatalogSyncNewResponseErrorsCode102051 CatalogSyncNewResponseErrorsCode = 102051
const CatalogSyncNewResponseErrorsCode102052 CatalogSyncNewResponseErrorsCode = 102052
const CatalogSyncNewResponseErrorsCode102053 CatalogSyncNewResponseErrorsCode = 102053
const CatalogSyncNewResponseErrorsCode102054 CatalogSyncNewResponseErrorsCode = 102054
const CatalogSyncNewResponseErrorsCode102055 CatalogSyncNewResponseErrorsCode = 102055
const CatalogSyncNewResponseErrorsCode102056 CatalogSyncNewResponseErrorsCode = 102056
const CatalogSyncNewResponseErrorsCode102057 CatalogSyncNewResponseErrorsCode = 102057
const CatalogSyncNewResponseErrorsCode102058 CatalogSyncNewResponseErrorsCode = 102058
const CatalogSyncNewResponseErrorsCode102059 CatalogSyncNewResponseErrorsCode = 102059
const CatalogSyncNewResponseErrorsCode102060 CatalogSyncNewResponseErrorsCode = 102060
const CatalogSyncNewResponseErrorsCode102061 CatalogSyncNewResponseErrorsCode = 102061
const CatalogSyncNewResponseErrorsCode102062 CatalogSyncNewResponseErrorsCode = 102062
const CatalogSyncNewResponseErrorsCode102063 CatalogSyncNewResponseErrorsCode = 102063
const CatalogSyncNewResponseErrorsCode102064 CatalogSyncNewResponseErrorsCode = 102064
const CatalogSyncNewResponseErrorsCode102065 CatalogSyncNewResponseErrorsCode = 102065
const CatalogSyncNewResponseErrorsCode102066 CatalogSyncNewResponseErrorsCode = 102066
const CatalogSyncNewResponseErrorsCode102067 CatalogSyncNewResponseErrorsCode = 102067
const CatalogSyncNewResponseErrorsCode102068 CatalogSyncNewResponseErrorsCode = 102068
const CatalogSyncNewResponseErrorsCode102069 CatalogSyncNewResponseErrorsCode = 102069
const CatalogSyncNewResponseErrorsCode102070 CatalogSyncNewResponseErrorsCode = 102070
const CatalogSyncNewResponseErrorsCode102071 CatalogSyncNewResponseErrorsCode = 102071
const CatalogSyncNewResponseErrorsCode102072 CatalogSyncNewResponseErrorsCode = 102072
const CatalogSyncNewResponseErrorsCode103001 CatalogSyncNewResponseErrorsCode = 103001
const CatalogSyncNewResponseErrorsCode103002 CatalogSyncNewResponseErrorsCode = 103002
const CatalogSyncNewResponseErrorsCode103003 CatalogSyncNewResponseErrorsCode = 103003
const CatalogSyncNewResponseErrorsCode103004 CatalogSyncNewResponseErrorsCode = 103004
const CatalogSyncNewResponseErrorsCode103005 CatalogSyncNewResponseErrorsCode = 103005
const CatalogSyncNewResponseErrorsCode103006 CatalogSyncNewResponseErrorsCode = 103006
const CatalogSyncNewResponseErrorsCode103007 CatalogSyncNewResponseErrorsCode = 103007
const CatalogSyncNewResponseErrorsCode103008 CatalogSyncNewResponseErrorsCode = 103008
Message string
DocumentationURL stringoptional
Meta CatalogSyncNewResponseErrorsMetaoptional
L10nKey stringoptional
LoggableError stringoptional
TemplateData unknownoptional
TraceID stringoptional
Source CatalogSyncNewResponseErrorsSourceoptional
Parameter stringoptional
ParameterValueIndex int64optional
Pointer stringoptional
IncludesDiscoveriesUntil stringoptional
LastAttemptedUpdateAt stringoptional
LastSuccessfulUpdateAt stringoptional

Create Catalog Sync

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"),
  )
  catalogSync, err := client.MagicCloudNetworking.CatalogSyncs.New(context.TODO(), magic_cloud_networking.CatalogSyncNewParams{
    AccountID: cloudflare.F("account_id"),
    DestinationType: cloudflare.F(magic_cloud_networking.CatalogSyncNewParamsDestinationTypeNone),
    Name: cloudflare.F("name"),
    UpdateMode: cloudflare.F(magic_cloud_networking.CatalogSyncNewParamsUpdateModeAuto),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", catalogSync.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",
    "description": "description",
    "destination_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "destination_type": "NONE",
    "last_user_update_at": "last_user_update_at",
    "name": "name",
    "policy": "policy",
    "update_mode": "AUTO",
    "errors": {
      "foo": {
        "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"
        }
      }
    },
    "includes_discoveries_until": "includes_discoveries_until",
    "last_attempted_update_at": "last_attempted_update_at",
    "last_successful_update_at": "last_successful_update_at"
  },
  "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",
    "description": "description",
    "destination_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "destination_type": "NONE",
    "last_user_update_at": "last_user_update_at",
    "name": "name",
    "policy": "policy",
    "update_mode": "AUTO",
    "errors": {
      "foo": {
        "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"
        }
      }
    },
    "includes_discoveries_until": "includes_discoveries_until",
    "last_attempted_update_at": "last_attempted_update_at",
    "last_successful_update_at": "last_successful_update_at"
  },
  "success": true
}