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.
Path parameters
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
The website access of listed addresses.
Fields
Format: date-time.
How many addresses have website access.
What a listed address skips: the login, the maintenance page or both.
Fields
Each entry's own state on the website.
Fields of each item
At least 1.
appliedapplyingfailednone while website access is not enforced on the site.
appliedapplyingfailednoneThe site's HTTP authentication. Passwords are never answered.
Fields
Fields of each item
At least 1.
Whether maintenance mode is on.
Fields
The site row id the /corestack/sites/{site} endpoints take.
If it is refused
| Status | Reason | What to do |
|---|---|---|
401 | none | 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. |
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"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();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);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{
"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
}{
"message": "Unauthenticated."
}{
"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"
}{
"code": "feature_off",
"message": "Not found.",
"reason": "feature_off"
}{
"code": "firewall_scope_unavailable",
"field": null,
"message": "Website access is not available for this environment.",
"reason": "firewall_scope_unavailable"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}