Patch Site

client.MagicTransit.Sites.Edit(ctx, siteID, params) (*Site, error)

PATCH/accounts/{account_id}/magic/sites/{site_id}

Patch a specific Site.

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 Transit Write

ParametersExpand Collapse

siteID string

Identifier

maxLength32

params SiteEditParams

AccountID param.Field[string]

Path param: Identifier

maxLength32

ConnectorID param.Field[string]optional

Body param: Magic Connector identifier tag.

Description param.Field[string]optional

Body param

Location param.Field[SiteLocation]optional

Body param: Location of site in latitude and longitude.

Name param.Field[string]optional

Body param: The name of the site.

SecondaryConnectorID param.Field[string]optional

Body param: Magic Connector identifier tag. Used when high availability mode is on.

ReturnsExpand Collapse

type Site struct{…}

ID stringoptional

Identifier

maxLength32

ConnectorID stringoptional

Magic Connector identifier tag.

Description stringoptional

HaMode booloptional

Site high availability mode. If set to true, the site can have two connectors and runs in high availability mode.

Location SiteLocationoptional

Location of site in latitude and longitude.

Lat stringoptional

Latitude

Lon stringoptional

Longitude

Name stringoptional

The name of the site.

SecondaryConnectorID stringoptional

Magic Connector identifier tag. Used when high availability mode is on.

Patch Site

package main

import (
  "context"
  "fmt"

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

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  site, err := client.MagicTransit.Sites.Edit(
    context.TODO(),
    "023e105f4ecef8ad9ca31a8372d0c353",
    magic_transit.SiteEditParams{
      AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", site.ID)
}

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "023e105f4ecef8ad9ca31a8372d0c353",
    "connector_id": "ac60d3d0435248289d446cedd870bcf4",
    "description": "description",
    "ha_mode": true,
    "location": {
      "lat": "37.6192",
      "lon": "122.3816"
    },
    "name": "site_1",
    "secondary_connector_id": "8d67040d3835dbcf46ce29da440dc482"
  },
  "success": true
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "023e105f4ecef8ad9ca31a8372d0c353",
    "connector_id": "ac60d3d0435248289d446cedd870bcf4",
    "description": "description",
    "ha_mode": true,
    "location": {
      "lat": "37.6192",
      "lon": "122.3816"
    },
    "name": "site_1",
    "secondary_connector_id": "8d67040d3835dbcf46ce29da440dc482"
  },
  "success": true
}