---
title: "Get the address you are calling from"
url: https://docs.corefinity.com/api/reference/firewall/get-my-ip
type: endpoint
last_updated: 2026-11-13
feature: firewall
related:
  - https://docs.corefinity.com/guides/sites/access-and-security/firewall.md
---
# 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.

```http
GET /api/firewall/my-ip
```

- Scope: `read`
- Rate limit: 120 a minute
- Try it in the console: on

## Query parameters

- `environment_id` (integer, required): The environment to check the address against.

## Request

### curl

```bash
curl 'https://manage.corefinity.com/api/firewall/my-ip?environment_id=1311' \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
```

### PHP

```php
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();
```

### Node

```javascript
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);
```

### Python

```python
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
```

## Responses

### 200 The address and where it can be added.

```json
{
  "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": []
}
```

### 401 No token, or a token that is not valid.

```json
{
  "message": "Unauthenticated."
}
```

### 403 The token lacks the scope this endpoint needs. `scope` names it.

```json
{
  "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"
}
```

### 404 The id does not exist or is something you cannot reach (`not_found`; both answer the same body), or the firewall is not on for it (`feature_off`).

```json
{
  "code": "feature_off",
  "message": "Not found.",
  "reason": "feature_off"
}
```

### 422 `environment_id` is missing or is not an environment id (`invalid_arguments`).

```json
{
  "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"
}
```

### 429 Too many requests (`rate_limited`). Wait for the number of seconds in `Retry-After`, which `retry_after_seconds` repeats.

```json
{
  "code": "rate_limited",
  "message": "Too many requests. Try again in 60 seconds.",
  "reason": "rate_limited",
  "retry_after_seconds": 60
}
```

## If it is refused

| Status | Reason | What to do |
|---|---|---|
| 401 |  | 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`. |

## The same task elsewhere

- Guide: [Firewall](https://docs.corefinity.com/guides/sites/access-and-security/firewall.md)
