Create a URL ignore pattern

client.emailSecurity.settings.urlIgnorePatterns.create(, ?): URLIgnorePatternCreateResponse { id, created_at, pattern, 3 more }

POST/accounts/{account_id}/email-security/settings/url_ignore_patterns

Creates a new URL rewrite ignore pattern. URLs matching this pattern will not be rewritten.

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)

Cloud Email Security: Write

ParametersExpand Collapse

params: URLIgnorePatternCreateParams { account_id, pattern, comments }

account_id: string

Path param: Identifier.

maxLength32

pattern: string

Body param: Regular expression matching URLs that should not be rewritten.

maxLength1024

minLength1

comments?: string | null

Body param: Optional note describing the reason for the ignore pattern.

maxLength1024

ReturnsExpand Collapse

URLIgnorePatternCreateResponse { id, created_at, pattern, 3 more }

A URL ignore pattern that exempts matching URLs from being rewritten by Email Security.

id: string

URL ignore pattern identifier

formatuuid

created_at: string

formatdate-time

pattern: string

Regular expression matching URLs that should not be rewritten.

maxLength1024

minLength1

comments?: string | null

Optional note describing the reason for the ignore pattern.

maxLength1024

Deprecatedlast_modified?: string

Deprecated, use modified_at instead. End of life: November 1, 2026.

formatdate-time

modified_at?: string

formatdate-time

Create a URL ignore pattern

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const urlIgnorePattern = await client.emailSecurity.settings.urlIgnorePatterns.create({
  account_id: '023e105f4ecef8ad9ca31a8372d0c353',
  pattern: 'https://example\\.com/.*',
});

console.log(urlIgnorePattern.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"
      }
    }
  ],
  "success": true,
  "result": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "created_at": "2019-12-27T18:11:19.117Z",
    "pattern": "https://example\\.com/.*",
    "comments": "Trusted internal redirect service",
    "last_modified": "2019-12-27T18:11:19.117Z",
    "modified_at": "2019-12-27T18:11:19.117Z"
  }
}

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": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "created_at": "2019-12-27T18:11:19.117Z",
    "pattern": "https://example\\.com/.*",
    "comments": "Trusted internal redirect service",
    "last_modified": "2019-12-27T18:11:19.117Z",
    "modified_at": "2019-12-27T18:11:19.117Z"
  }
}