CorefinityCorefinityDocs
Open the Control PanelControl Panel
Firewall · 8 of 20

Create a firewall entry

Adds an address or a range at one level: a company, a website, one environment, or yourself. A range may be as wide as /24 (IPv6 /48); ask for a wider one with a range request. The address works once the change has been applied.

POST/api/firewall/entries

Body

addressstringRequired

An IPv4 or IPv6 address, or a range in CIDR form. A range may be as wide as /24 (IPv6 /48). Private, reserved and provider ranges are refused. Up to 64 characters.

commentstring or null

A note to recognise the address by. Up to 200 characters.

expires_in_daysinteger or null

After how many days the address stops being allowed. Null, or left out, for no expiry.

13090365null
owner_idintegerRequired

The id of the environment, website or company. For user, your own user id. At least 1.

owner_typestringRequired

The level an address is held at. user is yourself.

environmentwebsitecompanyuser
scopestring

Left out, the address gets both. What the address may reach. ssh is SSH only, web the website only, both both.

bothsshweb
Fields

Returns

201 The address was added. Follow change_id with GET /firewall/changes/{change} to see it applied.

Fields of the 201 answer
change_idinteger or nullRequired

The change to follow with GET /firewall/changes/{change}. Null when nothing needs applying.

covered_bystring or nullRequired

Set when an entry at another level already allows the address: the level that does.

agencycompanywebsiteenvironmentuserpresethttp_auth_rulenull
entryobjectRequired

One address or range on a firewall list.

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

If it is refused

StatusReasonWhat to do
401noneSend a valid token as Authorization: Bearer <token>.
403company_unavailableYour company is unavailable.
403firewall_not_editableYou can see this entry but you cannot change it.
403scope_requiredUse a token with the scope named in scope.
403two_factor_requiredTurn on two-factor on your account, then send again.
404feature_offThis feature is not on for your organisation yet.
404not_foundNot found.
422firewall_address_invalidEnter an IPv4 or IPv6 address, or a range in CIDR form (for example 203.0.113.0/24).
422firewall_address_refusedThat address is in a private range and cannot be allowed.
422firewall_approval_requiredRanges wider than /24 (IPv6 /48) need approval from Corefinity. Send it as a range request.
422firewall_cap_exceededThis list already holds its limit of 200 addresses.
422firewall_duplicateThat address is already on this list.
422firewall_width_refusedThat range is far too wide to allow. Ranges of /8 or wider are never accepted.
422invalid_argumentsThe arguments do not match the tool's input schema, or the Control Panel refused a field. Fix the fields named in the answer and call again.
429firewall_throttledToo many firewall changes. Wait a minute and try again.
429rate_limitedWait for the seconds in Retry-After.

Reasons are listed by name in Errors and refusals.

The same task elsewhere

curl -X POST https://manage.corefinity.com/api/firewall/entries \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "address": "198.51.100.0/24",
    "comment": "Head office",
    "owner_id": 1204,
    "owner_type": "company",
    "scope": "ssh"
  }'
{
  "change_id": 5310,
  "covered_by": null,
  "entry": {
    "added_by": {
      "name": "Eleanor Finch",
      "on_behalf_of": null,
      "support": false
    },
    "carried_from": null,
    "changed_at": "2026-11-06T09:16:40Z",
    "cidr": "203.0.113.42/32",
    "comment": "Contractor",
    "created_at": "2026-11-06T09:16:40Z",
    "decision_reason": null,
    "editable": true,
    "expires_at": "2027-01-04T09:16:40Z",
    "family": 4,
    "id": 9002,
    "layer": "environment",
    "owner": {
      "id": 1311,
      "name": "Production",
      "type": "environment"
    },
    "path": null,
    "request_reason": null,
    "scope": {
      "ssh": true,
      "web": true
    },
    "source": "manual",
    "status": "active",
    "web_paused": false
  }
}
Try it

Try it is off for this endpointIt has not been cleared for the console. Copy the request and run it yourself when you are sure.

Was this helpful?
Open in ClaudeOpen in ChatGPT