---
title: "Get an environment's website access"
url: https://docs.corefinity.com/api/reference/firewall/get-environment-web-access
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 website access

For a CoreStack or CoreCluster environment, answers whether HTTP authentication and maintenance mode are on, the
logins (never their passwords), and what an address with website access skips.

```http
GET /api/environments/{environment}/web-access
```

- 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/web-access \
  -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/web-access');

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

### Node

```javascript
const res = await fetch('https://manage.corefinity.com/api/environments/1311/web-access', {
  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/web-access",
    headers={
        "Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
        "Accept": "application/json",
    },
)

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

## Responses

### 200 The environment's website access.

```json
{
  "bypass": {
    "applied_at": "2026-11-01T10:05:31Z",
    "count": 1,
    "covers": {
      "http_auth": true,
      "maintenance": true
    },
    "entries": [
      {
        "id": 9001,
        "state": "applied"
      }
    ],
    "last_error_public": null,
    "state": "applied"
  },
  "http_auth": {
    "enabled": true,
    "rules_count": 1,
    "users": [
      {
        "id": 77,
        "revealable": true,
        "username": "client"
      }
    ],
    "version": 4
  },
  "maintenance": {
    "on": false
  },
  "site_id": 1042
}
```

### 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"
}
```

### 422 Website access is not available for this environment (`firewall_scope_unavailable`): it is a CoreStack Enterprise environment, or its site has been removed.

```json
{
  "code": "firewall_scope_unavailable",
  "field": null,
  "message": "Website access is not available for this environment.",
  "reason": "firewall_scope_unavailable"
}
```

### 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. |
| 422 | `firewall_scope_unavailable` | Website access is not available for this environment. |
| 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)
