Delete Address Map

client.Addressing.AddressMaps.Delete(ctx, addressMapID, body) (*AddressMapDeleteResponse, error)

DELETE/accounts/{account_id}/addressing/address_maps/{address_map_id}

Delete a particular address map owned by the account. An Address Map must be disabled before it can be deleted.

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

Accepted Permissions (at least one required)

Address Maps Write

ParametersExpand Collapse

addressMapID string

Identifier of an Address Map.

maxLength32

body AddressMapDeleteParams

AccountID param.Field[string]

Identifier of a Cloudflare account.

maxLength32

ReturnsExpand Collapse

type AddressMapDeleteResponse struct{…}

Errors []AddressMapDeleteResponseError

Code int64

minimum1000

Message string

DocumentationURL stringoptional

Source AddressMapDeleteResponseErrorsSourceoptional

Pointer stringoptional

Messages []AddressMapDeleteResponseMessage

Code int64

minimum1000

Message string

DocumentationURL stringoptional

Source AddressMapDeleteResponseMessagesSourceoptional

Pointer stringoptional

Success AddressMapDeleteResponseSuccess

Whether the API call was successful.

ResultInfo AddressMapDeleteResponseResultInfooptional

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.

Delete 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"),
  )
  addressMap, err := client.Addressing.AddressMaps.Delete(
    context.TODO(),
    "055817b111884e0227e1be16a0be6ee0",
    addressing.AddressMapDeleteParams{
      AccountID: cloudflare.F("258def64c72dae45f3e4c8516e2111f2"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", addressMap.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
  }
}