CorefinityCorefinityDocs
Open the Control PanelControl Panel
Firewall · 12 of 20

Create an entry for your address

Adds the address this request came from, for SSH and for the website, at the level you choose: me (every environment you can reach), this environment, its website or your company. When the address can already connect, nothing is added and the answer says what allows it. When the level already holds the address for SSH only or for the website only, that entry is widened to both rather than a second one added, and it keeps its expiry unless the one you ask for is later: an entry with no expiry stays without one, so expires_in_days never shortens it. Read entry.expires_at in the answer for when the address stops being allowed.

POST/api/firewall/my-ip

Body

commentstring or null

Up to 200 characters.

environment_idintegerRequired

The environment you want to reach. At least 1.

expires_in_daysinteger or null

After how many days a new entry stops being allowed. Null, or left out, for no expiry. An entry the level already holds for the address is widened instead and keeps its own expiry when that is later, or when it has none: read entry.expires_at in the answer. After how many days the address stops being allowed. Null, or left out, for no expiry.

13090365null
Fields
levelstringRequired

Where to add the address: for yourself (me), for this environment, for its website or for your company.

meenvironmentwebsitecompany

Returns

200 The address can already connect. Nothing was added.

201 The address was added, or the entry the level already held for it was widened to SSH and the website. entry is the entry as it now stands, with the expiry it has. Follow change_id with GET /firewall/changes/{change}.

Fields of the 200 answer
presentbooleanRequired
viaarray of objectsRequired
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
Fields of the 201 answer
change_idinteger or nullRequired
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_refusedThat address is in a private range and cannot be allowed.
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/my-ip \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "comment": "Home",
    "environment_id": 1311,
    "expires_in_days": 30,
    "level": "me"
  }'
{
  "present": true,
  "via": [
    {
      "cidr": "198.51.100.0/24",
      "entry_id": 9003,
      "layer": "company",
      "owner": {
        "id": 1204,
        "name": "Harbour & Finch",
        "type": "company"
      },
      "subscription_id": null
    }
  ]
}
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