CorefinityCorefinityDocs
Open the Control PanelControl Panel
Firewall · 7 of 20

Get a firewall change

Answers how far a firewall change has been applied. Read it again until state is applied, failed or recorded.

GET/api/firewall/changes/{change}

Path parameters

changeintegerRequired

The id of a change, as a firewall request answers it in change_id. Digits only. At least 1.

Returns

200 The change.

Fields of the 200 answer
appliedintegerRequired

Environments the change is live on.

deferredintegerRequired

Environments that take the change later, when the firewall is enforced there.

failedarray of objectsRequired

The environments the change failed on, each with a reason.

Fields of each item
environment_idintegerRequired

At least 1.

reasonstringRequired
idintegerRequired

At least 1.

statestringRequired

applied and failed are final for this read; a failed environment is tried again. recorded means there was nothing to apply yet.

applyingappliedfailedrecorded
totalintegerRequired

Environments the change goes to.

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/firewall/changes/5308 \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
{
  "applied": 1,
  "deferred": 0,
  "failed": [],
  "id": 5308,
  "state": "applying",
  "total": 2
}
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