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.
applyingappliedfailedrecordedtotalintegerRequired
Environments the change goes to.
If it is refused
| Status | Reason | What to do |
|---|---|---|
401 | none | Send a valid token as Authorization: Bearer <token>. |
403 | scope_required | Use a token with the scope named in scope. |
404 | feature_off | This feature is not on for your organisation yet. |
404 | not_found | Not found. |
429 | rate_limited | Wait 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"use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->get('https://manage.corefinity.com/api/firewall/changes/5308');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/firewall/changes/5308', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
Accept: 'application/json',
},
});
// An answer with no body (204) has nothing to parse.
const text = await res.text();
const data = text && JSON.parse(text);import os
import requests
res = requests.get(
"https://manage.corefinity.com/api/firewall/changes/5308",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"applied": 1,
"deferred": 0,
"failed": [],
"id": 5308,
"state": "applying",
"total": 2
}{
"message": "Unauthenticated."
}{
"code": "scope_required",
"message": "This access token does not have the destructive scope this needs. Use a token with the destructive scope.",
"reason": "scope_required",
"scope": "destructive"
}{
"code": "feature_off",
"message": "Not found.",
"reason": "feature_off"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}Try it
Was this helpful?