---
schema_version: "1"
id: b53a6f09948ba0fd595b1258d72d74145f1248507bea1590d3cc44d3b9487c63
title: IPAddressRange
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_ipaddressrange.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_ipaddressrange.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: bcf15afea1cf7bc7eea841ac4d41e47e4ce035ad8d688459547bfea4d405ca72
description: Represents a range of IP addresses to include in or exclude from the specified feature.
---
# IPAddressRange

Represents a range of IP addresses to include in or exclude from the specified feature.

## Parent Type

This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/metadata.htm "The base class for all metadata types. You can’t edit this object. A component is an instance of a metadata type.") metadata type and inherits its fullName field.

## File Suffix and Directory Location

IP Address Range components have the suffix .IPAddressRange and are stored in the IPAddressRanges folder.

## Version

IPAddressRange components are available in API version 52.0 and later.

## Special Access Rules

To access IpAddressRange, enable the HtmlEmail permission in your org.

## Fields

| Field Name | Description |
| --- | --- |
| Description | 
Field Type

string

Description

Not required. The description of the IP address range. For example, the name of the company that owns the IP address range.



 |
| developerName | 

Field Type

string

Description

Not required. Gives you a way to distinguish ipAddressRange entries among developers in your org.



 |
| endIpAddress | 

Field Type

string

Description

The end of the IP address range. Must be an IPv4 or IPv6 Internet address and equal to or greater than the startIpAddress.



 |
| ipAddressFeature | 

Field Type

picklist

Description

The feature that uses the range of IP addresses. Possible values are:

- EmailIpFiltering (default) —Filter email engagement activities such as email opens and email clicks.





 |
| ipAddressUsageScope | 

Field Type

picklist

Description

Whether the specified IP addresses are included or excluded. Possible values are:

- Exclusion
- Inclusion





 |
| isProtected | 

Field Type

boolean

Description

Whether the specified IP address range is protected. The default is false.



 |
| masterLabel | 

Field Type

string

Description

Master label for the IP address range. This internal label doesn’t get translated.



 |
| startIpAddress | 

Field Type

string

Description

The start of the IP address range. Must be an IPv4 or IPv6 Internet address and equal to or smaller than the endIpAddress.



 |

## Declarative Metadata Sample Definition

The following is an example of an ipAddressName component.

<?xml version="1.0" encoding="UTF-8"?>
<IPAddressRange xmlns="http://soap.sforce.com/2006/04/metadata">
    <description\>Filter emails from google.com</description\>
    <endIpAddress\>221.224.222.158</endIpAddress\>
    <ipAddressFeature\>EmailIpFiltering</ipAddressFeature\>
    <ipAddressUsageScope\>Exclusion</ipAddressUsageScope\>
    <masterLabel\>MasterLabelValue</masterLabel\>
    <startIpAddress\>221.224.0.158</startIpAddress\>
    <isProtected\>false</isProtected\>
</IPAddressRange\>

The following is an example package.xml that references the previous definition.

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types>
        <members>\*</members>
        <name>IPAddressRange</name>
    </types>
    <version>1.0</version>
</Package>

## Wildcard Support in the Manifest File

This metadata type doesn’t support the wildcard character \* (asterisk) in the package.xml manifest file. For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/file_based_zip_file.htm "The deploy() and retrieve() calls are used to deploy and retrieve a .zip file. Within the .zip file is a project manifest (package.xml) that lists what to retrieve or deploy, and one or more XML components that are organized into folders.").