CorefinityCorefinityDocs
Open the Control PanelControl Panel
Firewall · 17 of 20

Get your own firewall

Answers the addresses held for you. Each opens every environment you can reach.

GET/api/user/firewall

Returns

200 Your addresses.

Fields of the 200 answer
entriesarray of objectsRequired
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.

reachobjectRequired

How far addresses at this level reach, with the environments.

Fields
environmentsintegerRequired
itemsarray of objectsRequired
Fields of each item
idintegerRequired

At least 1.

namestringRequired
productstringRequired
csecorestackcorecluster
websiteobjectRequired
Fields
idintegerRequired

At least 1.

namestringRequired
websitesintegerRequired
userobjectRequired
Fields
idintegerRequired

At least 1.

namestringRequired

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/user/firewall \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
{
  "entries": [
    {
      "added_by": {
        "name": "Eleanor Finch",
        "on_behalf_of": null,
        "support": false
      },
      "carried_from": null,
      "changed_at": "2026-11-06T09:16:40Z",
      "cidr": "198.51.100.24/32",
      "comment": "Home",
      "created_at": "2026-11-06T09:16:40Z",
      "decision_reason": null,
      "editable": true,
      "expires_at": "2026-11-05T09:16:40Z",
      "family": 4,
      "id": 9005,
      "layer": "user",
      "owner": {
        "id": 2041,
        "name": "Eleanor Finch",
        "type": "user"
      },
      "path": null,
      "request_reason": null,
      "scope": {
        "ssh": true,
        "web": true
      },
      "source": "one_click",
      "status": "active",
      "web_paused": false
    }
  ],
  "reach": {
    "environments": 1,
    "items": [
      {
        "id": 1311,
        "name": "Production",
        "product": "corecluster",
        "website": {
          "id": 1310,
          "name": "harbourandfinch.example.com"
        }
      }
    ],
    "websites": 1
  },
  "user": {
    "id": 2041,
    "name": "Eleanor Finch"
  }
}
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