CorefinityCorefinityDocs
Open the Control PanelControl Panel
Firewall · 6 of 20

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.

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

Path parameters

environmentintegerRequired

The id of a CoreStack Enterprise environment. Not the same number as a site row id. At least 1.

Returns

200 The environment's website access.

Fields of the 200 answer
bypassobjectRequired

The website access of listed addresses.

Fields
applied_atstring or nullRequired

Format: date-time.

countintegerRequired

How many addresses have website access.

coversobjectRequired

What a listed address skips: the login, the maintenance page or both.

Fields
http_authbooleanRequired
maintenancebooleanRequired
entriesarray of objectsRequired

Each entry's own state on the website.

Fields of each item
idintegerRequired

At least 1.

statestringRequired
appliedapplyingfailed
last_error_publicstring or nullRequired
statestringRequired

none while website access is not enforced on the site.

appliedapplyingfailednone
http_authobjectRequired

The site's HTTP authentication. Passwords are never answered.

Fields
enabledbooleanRequired
rules_countintegerRequired
usersarray of objectsRequired
Fields of each item
idintegerRequired

At least 1.

revealablebooleanRequired
usernamestringRequired
versionintegerRequired
maintenanceobjectRequired

Whether maintenance mode is on.

Fields
onbooleanRequired
site_idintegerRequired

The site row id the /corestack/sites/{site} endpoints take.

If it is refused

StatusReasonWhat to do
401noneSend a valid token as Authorization: Bearer <token>.
403scope_requiredUse a token with the scope named in scope.
404feature_offThis feature is not on for your organisation yet.
404not_foundNot found.
422firewall_scope_unavailableWebsite access is not available for this environment.
429rate_limitedWait for the seconds in Retry-After.

Reasons are listed by name in Errors and refusals.

The same task elsewhere

curl https://manage.corefinity.com/api/environments/1311/web-access \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/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
}
Try it
Held in this tab's memory only. Never stored or sent to us.

Use a token with only the read scope. How to make one

Was this helpful?
Open in ClaudeOpen in ChatGPT