Read Catalog Sync

client.MagicCloudNetworking.CatalogSyncs.Get(ctx, syncID, query) (*CatalogSyncGetResponse, error)

GET/accounts/{account_id}/magic/cloud/catalog-syncs/{sync_id}

Read a 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 WriteMagic WAN Read

ParametersExpand Collapse

syncID string

formatuuid

query CatalogSyncGetParams

AccountID param.Field[string]

ReturnsExpand Collapse

type CatalogSyncGetResponse struct{…}

ID string

formatuuid

Description string

DestinationID string

formatuuid

DestinationType CatalogSyncGetResponseDestinationType

One of the following:

const CatalogSyncGetResponseDestinationTypeNone CatalogSyncGetResponseDestinationType = "NONE"

const CatalogSyncGetResponseDestinationTypeZeroTrustList CatalogSyncGetResponseDestinationType = "ZERO_TRUST_LIST"

LastUserUpdateAt string

Name string

Policy string

UpdateMode CatalogSyncGetResponseUpdateMode

One of the following:

const CatalogSyncGetResponseUpdateModeAuto CatalogSyncGetResponseUpdateMode = "AUTO"

const CatalogSyncGetResponseUpdateModeManual CatalogSyncGetResponseUpdateMode = "MANUAL"

Errors map[string, CatalogSyncGetResponseError]optional

Code CatalogSyncGetResponseErrorsCode

One of the following:

const CatalogSyncGetResponseErrorsCode1001 CatalogSyncGetResponseErrorsCode = 1001

const CatalogSyncGetResponseErrorsCode1002 CatalogSyncGetResponseErrorsCode = 1002

const CatalogSyncGetResponseErrorsCode1003 CatalogSyncGetResponseErrorsCode = 1003

const CatalogSyncGetResponseErrorsCode1004 CatalogSyncGetResponseErrorsCode = 1004

const CatalogSyncGetResponseErrorsCode1005 CatalogSyncGetResponseErrorsCode = 1005

const CatalogSyncGetResponseErrorsCode1006 CatalogSyncGetResponseErrorsCode = 1006

const CatalogSyncGetResponseErrorsCode1007 CatalogSyncGetResponseErrorsCode = 1007

const CatalogSyncGetResponseErrorsCode1008 CatalogSyncGetResponseErrorsCode = 1008

const CatalogSyncGetResponseErrorsCode1009 CatalogSyncGetResponseErrorsCode = 1009

const CatalogSyncGetResponseErrorsCode1010 CatalogSyncGetResponseErrorsCode = 1010

const CatalogSyncGetResponseErrorsCode1011 CatalogSyncGetResponseErrorsCode = 1011

const CatalogSyncGetResponseErrorsCode1012 CatalogSyncGetResponseErrorsCode = 1012

const CatalogSyncGetResponseErrorsCode1013 CatalogSyncGetResponseErrorsCode = 1013

const CatalogSyncGetResponseErrorsCode1014 CatalogSyncGetResponseErrorsCode = 1014

const CatalogSyncGetResponseErrorsCode1015 CatalogSyncGetResponseErrorsCode = 1015

const CatalogSyncGetResponseErrorsCode1016 CatalogSyncGetResponseErrorsCode = 1016

const CatalogSyncGetResponseErrorsCode1017 CatalogSyncGetResponseErrorsCode = 1017

const CatalogSyncGetResponseErrorsCode1018 CatalogSyncGetResponseErrorsCode = 1018

const CatalogSyncGetResponseErrorsCode2001 CatalogSyncGetResponseErrorsCode = 2001

const CatalogSyncGetResponseErrorsCode2002 CatalogSyncGetResponseErrorsCode = 2002

const CatalogSyncGetResponseErrorsCode2003 CatalogSyncGetResponseErrorsCode = 2003

const CatalogSyncGetResponseErrorsCode2004 CatalogSyncGetResponseErrorsCode = 2004

const CatalogSyncGetResponseErrorsCode2005 CatalogSyncGetResponseErrorsCode = 2005

const CatalogSyncGetResponseErrorsCode2006 CatalogSyncGetResponseErrorsCode = 2006

const CatalogSyncGetResponseErrorsCode2007 CatalogSyncGetResponseErrorsCode = 2007

const CatalogSyncGetResponseErrorsCode2008 CatalogSyncGetResponseErrorsCode = 2008

const CatalogSyncGetResponseErrorsCode2009 CatalogSyncGetResponseErrorsCode = 2009

const CatalogSyncGetResponseErrorsCode2010 CatalogSyncGetResponseErrorsCode = 2010

const CatalogSyncGetResponseErrorsCode2011 CatalogSyncGetResponseErrorsCode = 2011

const CatalogSyncGetResponseErrorsCode2012 CatalogSyncGetResponseErrorsCode = 2012

const CatalogSyncGetResponseErrorsCode2013 CatalogSyncGetResponseErrorsCode = 2013

const CatalogSyncGetResponseErrorsCode2014 CatalogSyncGetResponseErrorsCode = 2014

const CatalogSyncGetResponseErrorsCode2015 CatalogSyncGetResponseErrorsCode = 2015

const CatalogSyncGetResponseErrorsCode2016 CatalogSyncGetResponseErrorsCode = 2016

const CatalogSyncGetResponseErrorsCode2017 CatalogSyncGetResponseErrorsCode = 2017

const CatalogSyncGetResponseErrorsCode2018 CatalogSyncGetResponseErrorsCode = 2018

const CatalogSyncGetResponseErrorsCode2019 CatalogSyncGetResponseErrorsCode = 2019

const CatalogSyncGetResponseErrorsCode2020 CatalogSyncGetResponseErrorsCode = 2020

const CatalogSyncGetResponseErrorsCode2021 CatalogSyncGetResponseErrorsCode = 2021

const CatalogSyncGetResponseErrorsCode2022 CatalogSyncGetResponseErrorsCode = 2022

const CatalogSyncGetResponseErrorsCode3001 CatalogSyncGetResponseErrorsCode = 3001

const CatalogSyncGetResponseErrorsCode3002 CatalogSyncGetResponseErrorsCode = 3002

const CatalogSyncGetResponseErrorsCode3003 CatalogSyncGetResponseErrorsCode = 3003

const CatalogSyncGetResponseErrorsCode3004 CatalogSyncGetResponseErrorsCode = 3004

const CatalogSyncGetResponseErrorsCode3005 CatalogSyncGetResponseErrorsCode = 3005

const CatalogSyncGetResponseErrorsCode3006 CatalogSyncGetResponseErrorsCode = 3006

const CatalogSyncGetResponseErrorsCode3007 CatalogSyncGetResponseErrorsCode = 3007

const CatalogSyncGetResponseErrorsCode4001 CatalogSyncGetResponseErrorsCode = 4001

const CatalogSyncGetResponseErrorsCode4002 CatalogSyncGetResponseErrorsCode = 4002

const CatalogSyncGetResponseErrorsCode4003 CatalogSyncGetResponseErrorsCode = 4003

const CatalogSyncGetResponseErrorsCode4004 CatalogSyncGetResponseErrorsCode = 4004

const CatalogSyncGetResponseErrorsCode4005 CatalogSyncGetResponseErrorsCode = 4005

const CatalogSyncGetResponseErrorsCode4006 CatalogSyncGetResponseErrorsCode = 4006

const CatalogSyncGetResponseErrorsCode4007 CatalogSyncGetResponseErrorsCode = 4007

const CatalogSyncGetResponseErrorsCode4008 CatalogSyncGetResponseErrorsCode = 4008

const CatalogSyncGetResponseErrorsCode4009 CatalogSyncGetResponseErrorsCode = 4009

const CatalogSyncGetResponseErrorsCode4010 CatalogSyncGetResponseErrorsCode = 4010

const CatalogSyncGetResponseErrorsCode4011 CatalogSyncGetResponseErrorsCode = 4011

const CatalogSyncGetResponseErrorsCode4012 CatalogSyncGetResponseErrorsCode = 4012

const CatalogSyncGetResponseErrorsCode4013 CatalogSyncGetResponseErrorsCode = 4013

const CatalogSyncGetResponseErrorsCode4014 CatalogSyncGetResponseErrorsCode = 4014

const CatalogSyncGetResponseErrorsCode4015 CatalogSyncGetResponseErrorsCode = 4015

const CatalogSyncGetResponseErrorsCode4016 CatalogSyncGetResponseErrorsCode = 4016

const CatalogSyncGetResponseErrorsCode4017 CatalogSyncGetResponseErrorsCode = 4017

const CatalogSyncGetResponseErrorsCode4018 CatalogSyncGetResponseErrorsCode = 4018

const CatalogSyncGetResponseErrorsCode4019 CatalogSyncGetResponseErrorsCode = 4019

const CatalogSyncGetResponseErrorsCode4020 CatalogSyncGetResponseErrorsCode = 4020

const CatalogSyncGetResponseErrorsCode4021 CatalogSyncGetResponseErrorsCode = 4021

const CatalogSyncGetResponseErrorsCode4022 CatalogSyncGetResponseErrorsCode = 4022

const CatalogSyncGetResponseErrorsCode4023 CatalogSyncGetResponseErrorsCode = 4023

const CatalogSyncGetResponseErrorsCode5001 CatalogSyncGetResponseErrorsCode = 5001

const CatalogSyncGetResponseErrorsCode5002 CatalogSyncGetResponseErrorsCode = 5002

const CatalogSyncGetResponseErrorsCode5003 CatalogSyncGetResponseErrorsCode = 5003

const CatalogSyncGetResponseErrorsCode5004 CatalogSyncGetResponseErrorsCode = 5004

const CatalogSyncGetResponseErrorsCode102000 CatalogSyncGetResponseErrorsCode = 102000

const CatalogSyncGetResponseErrorsCode102001 CatalogSyncGetResponseErrorsCode = 102001

const CatalogSyncGetResponseErrorsCode102002 CatalogSyncGetResponseErrorsCode = 102002

const CatalogSyncGetResponseErrorsCode102003 CatalogSyncGetResponseErrorsCode = 102003

const CatalogSyncGetResponseErrorsCode102004 CatalogSyncGetResponseErrorsCode = 102004

const CatalogSyncGetResponseErrorsCode102005 CatalogSyncGetResponseErrorsCode = 102005

const CatalogSyncGetResponseErrorsCode102006 CatalogSyncGetResponseErrorsCode = 102006

const CatalogSyncGetResponseErrorsCode102007 CatalogSyncGetResponseErrorsCode = 102007

const CatalogSyncGetResponseErrorsCode102008 CatalogSyncGetResponseErrorsCode = 102008

const CatalogSyncGetResponseErrorsCode102009 CatalogSyncGetResponseErrorsCode = 102009

const CatalogSyncGetResponseErrorsCode102010 CatalogSyncGetResponseErrorsCode = 102010

const CatalogSyncGetResponseErrorsCode102011 CatalogSyncGetResponseErrorsCode = 102011

const CatalogSyncGetResponseErrorsCode102012 CatalogSyncGetResponseErrorsCode = 102012

const CatalogSyncGetResponseErrorsCode102013 CatalogSyncGetResponseErrorsCode = 102013

const CatalogSyncGetResponseErrorsCode102014 CatalogSyncGetResponseErrorsCode = 102014

const CatalogSyncGetResponseErrorsCode102015 CatalogSyncGetResponseErrorsCode = 102015

const CatalogSyncGetResponseErrorsCode102016 CatalogSyncGetResponseErrorsCode = 102016

const CatalogSyncGetResponseErrorsCode102017 CatalogSyncGetResponseErrorsCode = 102017

const CatalogSyncGetResponseErrorsCode102018 CatalogSyncGetResponseErrorsCode = 102018

const CatalogSyncGetResponseErrorsCode102019 CatalogSyncGetResponseErrorsCode = 102019

const CatalogSyncGetResponseErrorsCode102020 CatalogSyncGetResponseErrorsCode = 102020

const CatalogSyncGetResponseErrorsCode102021 CatalogSyncGetResponseErrorsCode = 102021

const CatalogSyncGetResponseErrorsCode102022 CatalogSyncGetResponseErrorsCode = 102022

const CatalogSyncGetResponseErrorsCode102023 CatalogSyncGetResponseErrorsCode = 102023

const CatalogSyncGetResponseErrorsCode102024 CatalogSyncGetResponseErrorsCode = 102024

const CatalogSyncGetResponseErrorsCode102025 CatalogSyncGetResponseErrorsCode = 102025

const CatalogSyncGetResponseErrorsCode102026 CatalogSyncGetResponseErrorsCode = 102026

const CatalogSyncGetResponseErrorsCode102027 CatalogSyncGetResponseErrorsCode = 102027

const CatalogSyncGetResponseErrorsCode102028 CatalogSyncGetResponseErrorsCode = 102028

const CatalogSyncGetResponseErrorsCode102029 CatalogSyncGetResponseErrorsCode = 102029

const CatalogSyncGetResponseErrorsCode102030 CatalogSyncGetResponseErrorsCode = 102030

const CatalogSyncGetResponseErrorsCode102031 CatalogSyncGetResponseErrorsCode = 102031

const CatalogSyncGetResponseErrorsCode102032 CatalogSyncGetResponseErrorsCode = 102032

const CatalogSyncGetResponseErrorsCode102033 CatalogSyncGetResponseErrorsCode = 102033

const CatalogSyncGetResponseErrorsCode102034 CatalogSyncGetResponseErrorsCode = 102034

const CatalogSyncGetResponseErrorsCode102035 CatalogSyncGetResponseErrorsCode = 102035

const CatalogSyncGetResponseErrorsCode102036 CatalogSyncGetResponseErrorsCode = 102036

const CatalogSyncGetResponseErrorsCode102037 CatalogSyncGetResponseErrorsCode = 102037

const CatalogSyncGetResponseErrorsCode102038 CatalogSyncGetResponseErrorsCode = 102038

const CatalogSyncGetResponseErrorsCode102039 CatalogSyncGetResponseErrorsCode = 102039

const CatalogSyncGetResponseErrorsCode102040 CatalogSyncGetResponseErrorsCode = 102040

const CatalogSyncGetResponseErrorsCode102041 CatalogSyncGetResponseErrorsCode = 102041

const CatalogSyncGetResponseErrorsCode102042 CatalogSyncGetResponseErrorsCode = 102042

const CatalogSyncGetResponseErrorsCode102043 CatalogSyncGetResponseErrorsCode = 102043

const CatalogSyncGetResponseErrorsCode102044 CatalogSyncGetResponseErrorsCode = 102044

const CatalogSyncGetResponseErrorsCode102045 CatalogSyncGetResponseErrorsCode = 102045

const CatalogSyncGetResponseErrorsCode102046 CatalogSyncGetResponseErrorsCode = 102046

const CatalogSyncGetResponseErrorsCode102047 CatalogSyncGetResponseErrorsCode = 102047

const CatalogSyncGetResponseErrorsCode102048 CatalogSyncGetResponseErrorsCode = 102048

const CatalogSyncGetResponseErrorsCode102049 CatalogSyncGetResponseErrorsCode = 102049

const CatalogSyncGetResponseErrorsCode102050 CatalogSyncGetResponseErrorsCode = 102050

const CatalogSyncGetResponseErrorsCode102051 CatalogSyncGetResponseErrorsCode = 102051

const CatalogSyncGetResponseErrorsCode102052 CatalogSyncGetResponseErrorsCode = 102052

const CatalogSyncGetResponseErrorsCode102053 CatalogSyncGetResponseErrorsCode = 102053

const CatalogSyncGetResponseErrorsCode102054 CatalogSyncGetResponseErrorsCode = 102054

const CatalogSyncGetResponseErrorsCode102055 CatalogSyncGetResponseErrorsCode = 102055

const CatalogSyncGetResponseErrorsCode102056 CatalogSyncGetResponseErrorsCode = 102056

const CatalogSyncGetResponseErrorsCode102057 CatalogSyncGetResponseErrorsCode = 102057

const CatalogSyncGetResponseErrorsCode102058 CatalogSyncGetResponseErrorsCode = 102058

const CatalogSyncGetResponseErrorsCode102059 CatalogSyncGetResponseErrorsCode = 102059

const CatalogSyncGetResponseErrorsCode102060 CatalogSyncGetResponseErrorsCode = 102060

const CatalogSyncGetResponseErrorsCode102061 CatalogSyncGetResponseErrorsCode = 102061

const CatalogSyncGetResponseErrorsCode102062 CatalogSyncGetResponseErrorsCode = 102062

const CatalogSyncGetResponseErrorsCode102063 CatalogSyncGetResponseErrorsCode = 102063

const CatalogSyncGetResponseErrorsCode102064 CatalogSyncGetResponseErrorsCode = 102064

const CatalogSyncGetResponseErrorsCode102065 CatalogSyncGetResponseErrorsCode = 102065

const CatalogSyncGetResponseErrorsCode102066 CatalogSyncGetResponseErrorsCode = 102066

const CatalogSyncGetResponseErrorsCode102067 CatalogSyncGetResponseErrorsCode = 102067

const CatalogSyncGetResponseErrorsCode102068 CatalogSyncGetResponseErrorsCode = 102068

const CatalogSyncGetResponseErrorsCode102069 CatalogSyncGetResponseErrorsCode = 102069

const CatalogSyncGetResponseErrorsCode102070 CatalogSyncGetResponseErrorsCode = 102070

const CatalogSyncGetResponseErrorsCode102071 CatalogSyncGetResponseErrorsCode = 102071

const CatalogSyncGetResponseErrorsCode102072 CatalogSyncGetResponseErrorsCode = 102072

const CatalogSyncGetResponseErrorsCode103001 CatalogSyncGetResponseErrorsCode = 103001

const CatalogSyncGetResponseErrorsCode103002 CatalogSyncGetResponseErrorsCode = 103002

const CatalogSyncGetResponseErrorsCode103003 CatalogSyncGetResponseErrorsCode = 103003

const CatalogSyncGetResponseErrorsCode103004 CatalogSyncGetResponseErrorsCode = 103004

const CatalogSyncGetResponseErrorsCode103005 CatalogSyncGetResponseErrorsCode = 103005

const CatalogSyncGetResponseErrorsCode103006 CatalogSyncGetResponseErrorsCode = 103006

const CatalogSyncGetResponseErrorsCode103007 CatalogSyncGetResponseErrorsCode = 103007

const CatalogSyncGetResponseErrorsCode103008 CatalogSyncGetResponseErrorsCode = 103008

Message string

DocumentationURL stringoptional

Meta CatalogSyncGetResponseErrorsMetaoptional

L10nKey stringoptional

LoggableError stringoptional

TemplateData unknownoptional

TraceID stringoptional

Source CatalogSyncGetResponseErrorsSourceoptional

Parameter stringoptional

ParameterValueIndex int64optional

Pointer stringoptional

IncludesDiscoveriesUntil stringoptional

LastAttemptedUpdateAt stringoptional

LastSuccessfulUpdateAt stringoptional

Read 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.Get(
    context.TODO(),
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    magic_cloud_networking.CatalogSyncGetParams{
      AccountID: cloudflare.F("account_id"),
    },
  )
  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
}