Add an IP to an Address Map

client.Addressing.AddressMaps.IPs.Update(ctx, addressMapID, ipAddress, params) (*AddressMapIPUpdateResponse, error)

PUT/accounts/{account_id}/addressing/address_maps/{address_map_id}/ips/{ip_address}

Add an IP from a prefix owned by the account to 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

Accepted Permissions (at least one required)

Address Maps Write

ParametersExpand Collapse

addressMapID string

Identifier of an Address Map.

maxLength32

ipAddress string

An IPv4 or IPv6 address.

params AddressMapIPUpdateParams

AccountID param.Field[string]

Path param: Identifier of a Cloudflare account.

maxLength32

Body param.Field[unknown]

Body param

ReturnsExpand Collapse

type AddressMapIPUpdateResponse struct{…}

Errors []AddressMapIPUpdateResponseError

Code int64

minimum1000

Message string

DocumentationURL stringOptional

Source AddressMapIPUpdateResponseErrorsSourceOptional

Pointer stringOptional

Messages []AddressMapIPUpdateResponseMessage

Code int64

minimum1000

Message string

DocumentationURL stringOptional

Source AddressMapIPUpdateResponseMessagesSourceOptional

Pointer stringOptional

Success AddressMapIPUpdateResponseSuccess

Whether the API call was successful.

ResultInfo AddressMapIPUpdateResponseResultInfoOptional

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.

TotalPages float64Optional

The number of total pages in the entire result set.

Add an IP to an Address Map

package main

import (
  "context"
  "fmt"

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

func main() {
  client := cloudflare.NewClient(
    option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
    option.WithAPIEmail("user@example.com"),
  )
  ip, err := client.Addressing.AddressMaps.IPs.Update(
    context.TODO(),
    "055817b111884e0227e1be16a0be6ee0",
    "192.0.2.1",
    addressing.AddressMapIPUpdateParams{
      AccountID: cloudflare.F("258def64c72dae45f3e4c8516e2111f2"),
      Body: map[string]interface{}{
      },
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", ip.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,
    "total_pages": 100
  }
}

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,
    "total_pages": 100
  }
}