---
title: "Get an environment's firewall"
url: https://docs.corefinity.com/api/reference/firewall/get-environment-firewall
type: endpoint
last_updated: 2026-11-13
feature: firewall
related:
  - https://docs.corefinity.com/guides/sites/access-and-security/firewall.md
---
# Get an environment's firewall

Answers every address that reaches the environment, from every level, with the presets attached, the address this
request came from, and how far the firewall is in force on the environment.

```http
GET /api/environments/{environment}/firewall
```

- Scope: `read`
- Rate limit: 120 a minute
- Try it in the console: on

## Path parameters

- `environment` (integer, required): The id of a CoreStack Enterprise environment. Not the same number as a site row id.

## Request

### curl

```bash
curl https://manage.corefinity.com/api/environments/1311/firewall \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
```

### PHP

```php
use Illuminate\Support\Facades\Http;

$response = Http::withToken(env('COREFINITY_TOKEN'))
    ->acceptJson()
    ->get('https://manage.corefinity.com/api/environments/1311/firewall');

$data = $response->json();
```

### Node

```javascript
const res = await fetch('https://manage.corefinity.com/api/environments/1311/firewall', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
    Accept: 'application/json',
  },
});

// An answer with no body (204) has nothing to parse.
const text = await res.text();
const data = text && JSON.parse(text);
```

### Python

```python
import os
import requests

res = requests.get(
    "https://manage.corefinity.com/api/environments/1311/firewall",
    headers={
        "Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
        "Accept": "application/json",
    },
)

data = res.json() if res.content else None
```

## Responses

### 200 The environment's firewall.

```json
{
  "closed_by_default": true,
  "covered": true,
  "enforcement": {
    "stage": "enforce"
  },
  "entries": [
    {
      "added_by": {
        "name": "Eleanor Finch",
        "on_behalf_of": null,
        "support": false
      },
      "carried_from": null,
      "changed_at": "2026-11-01T10:02:44Z",
      "cidr": "203.0.113.7/32",
      "comment": "Office",
      "created_at": "2026-11-01T10:02:44Z",
      "decision_reason": null,
      "editable": true,
      "expires_at": null,
      "family": 4,
      "id": 9001,
      "layer": "company",
      "owner": {
        "id": 1204,
        "name": "Harbour & Finch",
        "type": "company"
      },
      "path": null,
      "request_reason": null,
      "scope": {
        "ssh": true,
        "web": true
      },
      "source": "manual",
      "status": "active",
      "web_paused": false
    }
  ],
  "environment": {
    "company": {
      "id": 1204,
      "name": "Harbour & Finch"
    },
    "id": 1311,
    "name": "Production",
    "product": "corecluster",
    "site_id": 1042,
    "website": {
      "id": 1310,
      "name": "harbourandfinch.example.com"
    }
  },
  "legacy": {
    "banner": false,
    "ends_on": null,
    "state": "none"
  },
  "presets": [
    {
      "added_by": {
        "name": "Eleanor Finch",
        "on_behalf_of": null,
        "support": false
      },
      "created_at": "2026-11-01T10:05:10Z",
      "editable": true,
      "id": 310,
      "layer": "company",
      "owner": {
        "id": 1204,
        "name": "Harbour & Finch",
        "type": "company"
      },
      "preset": {
        "description": "The addresses GitHub Actions runners connect from.",
        "id": 14,
        "name": "GitHub Actions",
        "ranges_count": 1,
        "slug": "github-actions"
      }
    }
  ],
  "ssh_reach": {
    "ends_on": null,
    "state": "restricted"
  },
  "targets": [
    {
      "applied_at": "2026-11-01T10:05:31Z",
      "last_error_public": null,
      "moving": false,
      "port": 21044,
      "state": "applied"
    }
  ],
  "your_address": {
    "address": "203.0.113.7",
    "allowed": true,
    "via": [
      {
        "cidr": "203.0.113.7/32",
        "entry_id": 9001,
        "layer": "company",
        "owner": {
          "id": 1204,
          "name": "Harbour & Finch",
          "type": "company"
        },
        "subscription_id": null
      }
    ]
  }
}
```

### 401 No token, or a token that is not valid.

```json
{
  "message": "Unauthenticated."
}
```

### 403 The token lacks the scope this endpoint needs. `scope` names it.

```json
{
  "code": "scope_required",
  "message": "This access token does not have the destructive scope this needs. Use a token with the destructive scope.",
  "reason": "scope_required",
  "scope": "destructive"
}
```

### 404 The id does not exist or is something you cannot reach (`not_found`; both answer the same body), or the firewall is not on for it (`feature_off`).

```json
{
  "code": "feature_off",
  "message": "Not found.",
  "reason": "feature_off"
}
```

### 429 Too many requests (`rate_limited`). Wait for the number of seconds in `Retry-After`, which `retry_after_seconds` repeats.

```json
{
  "code": "rate_limited",
  "message": "Too many requests. Try again in 60 seconds.",
  "reason": "rate_limited",
  "retry_after_seconds": 60
}
```

## If it is refused

| Status | Reason | What to do |
|---|---|---|
| 401 |  | Send a valid token as `Authorization: Bearer <token>`. |
| 403 | `scope_required` | Use a token with the scope named in `scope`. |
| 404 | `feature_off` | This feature is not on for your organisation yet. |
| 404 | `not_found` | Not found. |
| 429 | `rate_limited` | Wait for the seconds in `Retry-After`. |

## The same task elsewhere

- Guide: [Firewall](https://docs.corefinity.com/guides/sites/access-and-security/firewall.md)
