Get the address you are calling from
Answers the address this request came from, whether it can connect to the environment now, and the levels it can be added at with what each opens. The address is always the one the request came from; it cannot be sent.
Query parameters
The environment to check the address against. At least 1.
Returns
200 The address and where it can be added.
Fields of the 200 answer
46Fields of each item
me adds it for yourself, on every environment you can reach.
meenvironmentwebsitecompanyWhat an address at this level opens.
Fields
address_refused is a private, shared, reserved or provider range, platform_address an address of Corefinity. Null when the address can be added.
address_refusedplatform_addressnullFalse when this address cannot be added; reason says why.
Fields of each item
agencycompanywebsiteenvironmentuserpresethttp_auth_ruleWhere 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
At least 1.
companywebsiteenvironmentuserhttp_auth_ruleIf 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. |
422 | invalid_arguments | The 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. |
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/my-ip?environment_id=1311' \
-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/my-ip?environment_id=1311');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/firewall/my-ip?environment_id=1311', {
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/my-ip?environment_id=1311",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"address": "198.51.100.24",
"allowed": false,
"family": 4,
"options": [
{
"description": "Every environment you can reach",
"label": "Me",
"level": "me",
"reach": {
"environments": 1,
"websites": 1
}
},
{
"description": "Production of harbourandfinch.example.com",
"label": "This environment",
"level": "environment",
"reach": {
"environments": 1,
"websites": 1
}
},
{
"description": "Every environment of harbourandfinch.example.com",
"label": "This website",
"level": "website",
"reach": {
"environments": 1,
"websites": 1
}
},
{
"description": "Every Harbour & Finch environment",
"label": "My company",
"level": "company",
"reach": {
"environments": 1,
"websites": 1
}
}
],
"reason": null,
"usable": true,
"via": []
}{
"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": "invalid_arguments",
"errors": {
"environment_id": [
"Some of the details are missing or not valid."
]
},
"field": "environment_id",
"message": "Some of the details are missing or not valid.",
"reason": "invalid_arguments"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}