CorefinityCorefinityDocs
Open the Control PanelControl Panel
Firewall · 4 of 20

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.

GET/api/environments/{environment}/firewall

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 firewall.

Fields of the 200 answer
closed_by_defaultbooleanRequired

True when SSH is refused to every address that is not listed.

coveredbooleanRequired

False for an environment whose SSH the firewall does not manage.

enforcementobjectRequired

How far the firewall is in force on the environment.

Fields
stagestringRequired
darkprepareenforcepauseddeferred
entriesarray of objectsRequired

The addresses, from every level that reaches the environment.

Fields of each item
added_byobjectRequired

Who added an address or made a change.

Fields
namestring or nullRequired

Null when the person has been removed, or when Corefinity support added the address.

on_behalf_ofstring or nullRequired

The person Corefinity support added it for.

supportbooleanRequired

True when Corefinity support added the address for a customer.

carried_fromstring or nullRequired

Where a carried address came from.

changed_atstringRequired

When the entry last changed where it applies. Compare it with a target's applied_at to tell whether the change is live there. Format: date-time.

cidrstringRequired

The address in CIDR form. A single address reads /32 (IPv6 /128). Removing the entry asks you to send this back.

commentstring or nullRequired
created_atstringRequired

Format: date-time.

decision_reasonstring or nullRequired

Corefinity's reason, once a range request is rejected.

editablebooleanRequired

Whether you may change or remove the entry.

expires_atstring or nullRequired

When the address stops being allowed. Null for no expiry. Format: date-time.

familyintegerRequired

The IP version.

46
idintegerRequired

The entry id the /firewall/entries/{entry} endpoints take.

layerstringRequired

The level the address comes from, as you see it. agency is an address of your agency.

agencycompanywebsiteenvironmentuserpresethttp_auth_rule
ownerobjectRequired

Where an address is held: a company, a website, an environment or a person. http_auth_rule is an address carried over with a password-protected path.

Fields
idintegerRequired

At least 1.

namestringRequired
typestringRequired
companywebsiteenvironmentuserhttp_auth_rule
pathstring or nullRequired

The protected path of a carried http_auth_rule address.

request_reasonstring or nullRequired

The reason given with a range request.

scopeobjectRequired

What an address may reach.

Fields
sshbooleanRequired

The address may connect over SSH.

webbooleanRequired

The address sees the website without the HTTP authentication login or the maintenance page.

sourcestringRequired

How the entry came to be, such as manual, one_click (the address you were calling from) or an import.

manualone_clickon_behalfip_whitelistlegacy_importlegacy_usagegcp_rule_importlegacy_deltaplatform_seedhttp_auth_carry
statusstringRequired

pending_approval is a range request waiting for Corefinity. removing lasts until the address is gone everywhere.

activepending_approvalrejectedremovingexpired
web_pausedbooleanRequired

True while the address's website access is paused by the platform.

environmentobjectRequired

An environment, with the website and company it belongs to.

Fields
companyobjectRequired
Fields
idintegerRequired

At least 1.

namestringRequired
idintegerRequired

The environment id, the {environment} these endpoints take and the owner_id of an environment entry.

namestringRequired
productstringRequired

cse is CoreStack Enterprise.

csecorestackcorecluster
site_idinteger or nullRequired

The site row id the /corestack/sites/{site} endpoints take. Null on CoreStack Enterprise.

websiteobjectRequired
Fields
idintegerRequired

At least 1.

namestringRequired
legacyobjectRequired

The older open SSH access of the environment, while it lasts.

Fields
bannerbooleanRequired

Whether the Control Panel shows a notice about it.

ends_onstring or nullRequired

The day it ends, once a day is set. Format: date.

statestringRequired
noneopenendingended
presetsarray of objectsRequired

The presets attached at any level that reaches the environment.

Fields of each item
added_byobjectRequired

Who added an address or made a change.

Fields
namestring or nullRequired

Null when the person has been removed, or when Corefinity support added the address.

on_behalf_ofstring or nullRequired

The person Corefinity support added it for.

supportbooleanRequired

True when Corefinity support added the address for a customer.

created_atstringRequired

Format: date-time.

editablebooleanRequired

Whether you may detach it.

idintegerRequired

The id DELETE /firewall/preset-subscriptions/{subscription} takes.

layerstringRequired
agencycompanywebsiteenvironmentuserpresethttp_auth_rule
ownerobjectRequired

Where an address is held: a company, a website, an environment or a person. http_auth_rule is an address carried over with a password-protected path.

Fields
idintegerRequired

At least 1.

namestringRequired
typestringRequired
companywebsiteenvironmentuserhttp_auth_rule
presetobjectRequired

The published address ranges of a common service, kept up to date by Corefinity.

Fields
descriptionstring or nullRequired
idintegerRequired

At least 1.

namestringRequired
ranges_countintegerRequired

How many ranges the preset holds.

slugstringRequired

The preset's short name. Detaching it asks you to send this back.

ssh_reachobjectRequired

Who can reach SSH now.

Fields
ends_onstring or nullRequired

The day the older access ends, once a day is set. Format: date.

statestringRequired

restricted: only listed addresses. legacy_open: the older open access continues. legacy_list: listed addresses and Corefinity's older SSH allow list. world_open: Corefinity has opened the environment to everyone. not_enforced: the firewall is not in force.

world_openlegacy_openlegacy_listrestrictednot_enforced
targetsarray of objectsRequired

The SSH ports the list is applied to.

Fields of each item
applied_atstring or nullRequired

When the list was last applied to the port. Format: date-time.

last_error_publicstring or nullRequired

Why the last apply failed, in plain words.

movingbooleanRequired

True while the port is being moved.

portintegerRequired
statestringRequired
pendingapplyingappliedfaileddriftdeletingabsent
your_addressobjectRequired

The address this request came from, and whether it can connect.

Fields
addressstringRequired
allowedbooleanRequired
viaarray of objectsRequired

The entries and presets that allow it.

Fields of each item
cidrstringRequired
entry_idinteger or nullRequired
layerstringRequired
agencycompanywebsiteenvironmentuserpresethttp_auth_rule
ownerobjectRequired

Where an address is held: a company, a website, an environment or a person. http_auth_rule is an address carried over with a password-protected path.

Fields
idintegerRequired

At least 1.

namestringRequired
typestringRequired
companywebsiteenvironmentuserhttp_auth_rule
subscription_idinteger or nullRequired

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.
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/firewall \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/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
      }
    ]
  }
}
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