---
title: Purge Cached Content by Environment
---

[Skip to content](#%5Ftop) 

[API Reference](https://developers.cloudflare.com/api/typescript)

[Cache](https://developers.cloudflare.com/api/typescript/resources/cache)

Copy Markdown

Open in **Claude**

Open in **ChatGPT**

Open in **Cursor**

---

**Copy Markdown**

**View as Markdown**

# Purge Cached Content by Environment

client.cache.purgeEnvironment(stringenvironmentID, CachePurgeEnvironmentParamsparams, RequestOptionsoptions?): [CachePurgeEnvironmentResponse](https://developers.cloudflare.com/api/typescript/resources/cache#%28resource%29%20cache%20%3E%20%28model%29%20cache%5Fpurge%5Fenvironment%5Fresponse%20%3E%20%28schema%29) { id } | null

POST/zones/{zone\_id}/environments/{environment\_id}/purge\_cache

Purge cached content scoped to a specific environment. Supports the same purge types as the zone-level endpoint (purge everything, by URL, by tag, host, or prefix).

### Availability and limits

Please refer to [purge cache availability and limits documentation page](https://developers.cloudflare.com/cache/how-to/purge-cache/#availability-and-limits).

##### Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. [Create a token](https://developers.cloudflare.com/fundamentals/api/get-started/create-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)

`Cache Purge`

##### ParametersExpand Collapse 

environmentID: string

maxLength32

CachePurgeEnvironmentParams \= CachePurgeFlexPurgeByTags | CachePurgeFlexPurgeByHostnames | CachePurgeFlexPurgeByPrefixes | 3 more

CachePurgeEnvironmentParamsBase { zone\_id, tags } 

zone\_id: string

Path param

maxLength32

tags?: Array<string\>

Body param: For more information on cache tags and purging by tags, please refer to [purge by cache-tags documentation page](https://developers.cloudflare.com/cache/how-to/purge-cache/purge-by-tags/).

CachePurgeFlexPurgeByTags extends CachePurgeEnvironmentParamsBase { zone\_id, tags } 

CachePurgeFlexPurgeByHostnames extends CachePurgeEnvironmentParamsBase { zone\_id, tags } 

CachePurgeFlexPurgeByPrefixes extends CachePurgeEnvironmentParamsBase { zone\_id, tags } 

CachePurgeEverything extends CachePurgeEnvironmentParamsBase { zone\_id, tags } 

CachePurgeSingleFile extends CachePurgeEnvironmentParamsBase { zone\_id, tags } 

CachePurgeSingleFileWithURLAndHeaders extends CachePurgeEnvironmentParamsBase { zone\_id, tags } 

##### ReturnsExpand Collapse 

CachePurgeEnvironmentResponse { id } 

id: string

maxLength32

### Purge Cached Content by Environment

TypeScript

HTTPHTTP

TypeScriptTypeScript

PythonPython

GoGo

TerraformTerraform

```
import Cloudflare from 'cloudflare';

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

const response = await client.cache.purgeEnvironment('023e105f4ecef8ad9ca31a8372d0c353', {
  zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
});

console.log(response.id);
```

200 example

```
{
  "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": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}
```

##### Returns Examples

200 example

```
{
  "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": "023e105f4ecef8ad9ca31a8372d0c353"
  }
}
```