Skip to content
Start here

Add a zone membership to an Address Map

client.Addressing.AddressMaps.Zones.Update(ctx, addressMapID, params) (*AddressMapZoneUpdateResponse, error)
PUT/accounts/{account_id}/addressing/address_maps/{address_map_id}/zones/{zone_id}

Add a zone as a member of a particular address map.

Security

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
ParametersExpand Collapse
addressMapID string

Identifier of an Address Map.

maxLength32
params AddressMapZoneUpdateParams
ZoneID param.Field[string]

Path param: Identifier of a zone.

maxLength32
AccountID param.Field[string]

Path param: Identifier of a Cloudflare account.

maxLength32
Body param.Field[unknown]

Body param

ReturnsExpand Collapse
type AddressMapZoneUpdateResponse struct{…}
Errors []AddressMapZoneUpdateResponseError
Code int64
minimum1000
Message string
DocumentationURL stringoptional
Source AddressMapZoneUpdateResponseErrorsSourceoptional
Pointer stringoptional
Messages []AddressMapZoneUpdateResponseMessage
Code int64
minimum1000
Message string
DocumentationURL stringoptional
Source AddressMapZoneUpdateResponseMessagesSourceoptional
Pointer stringoptional
Success AddressMapZoneUpdateResponseSuccess

Whether the API call was successful.

ResultInfo AddressMapZoneUpdateResponseResultInfooptional
Count float64optional

Total number of results for the requested service.

Page float64optional

Current page within paginated list of results.

PerPage float64optional

Number of results per page of results.

TotalCount float64optional

Total results available without any search parameters.

Add a zone membership to an Address Map

package main

import (
  "context"
  "fmt"

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

func main() {
  client := cloudflare.NewClient(
    option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
    option.WithAPIEmail("user@example.com"),
  )
  zone, err := client.Addressing.AddressMaps.Zones.Update(
    context.TODO(),
    "055817b111884e0227e1be16a0be6ee0",
    addressing.AddressMapZoneUpdateParams{
      ZoneID: cloudflare.F("8ac8489932db6327334c9b6d58544cfe"),
      AccountID: cloudflare.F("258def64c72dae45f3e4c8516e2111f2"),
      Body: map[string]interface{}{
      },
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", zone.Errors)
}
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}
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"
      }
    }
  ],
  "success": true,
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}