## Purge Cached Content by Environment

`client.cache.purgeEnvironment(stringenvironmentId, CachePurgeEnvironmentParamsparams, RequestOptionsoptions?): CachePurgeEnvironmentResponse | 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).

### Parameters

- `environmentId: string`

- `CachePurgeEnvironmentParams = CachePurgeFlexPurgeByTags | CachePurgeFlexPurgeByHostnames | CachePurgeFlexPurgeByPrefixes | 3 more`

  - `CachePurgeEnvironmentParamsBase`

  - `CachePurgeFlexPurgeByTags extends CachePurgeEnvironmentParamsBase`

  - `CachePurgeFlexPurgeByHostnames extends CachePurgeEnvironmentParamsBase`

  - `CachePurgeFlexPurgeByPrefixes extends CachePurgeEnvironmentParamsBase`

  - `CachePurgeEverything extends CachePurgeEnvironmentParamsBase`

  - `CachePurgeSingleFile extends CachePurgeEnvironmentParamsBase`

  - `CachePurgeSingleFileWithURLAndHeaders extends CachePurgeEnvironmentParamsBase`

### Returns

- `CachePurgeEnvironmentResponse`

  - `id: string`

### Example

```node
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);
```

#### Response

```json
{
  "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"
  }
}
```