---
title: "Get a firewall and its rules"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.ezghcloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Firewall API

`GET /v1/organizations/{orgId}/projects/{projectId}/firewalls/{firewall}`

## Authentication

Requires one of the following:

- `apiKey`, http, header `Authorization`
- `oauth`, http, header `Authorization`
- `sessionCookie`, apiKey, in cookie

## Path parameters

- `GetFirewall.path.orgId` (string, required) — UUID or prefixed ID (org_…)
- `GetFirewall.path.projectId` (string, required) — UUID or prefixed ID (prj_…)
- `GetFirewall.path.firewall` (string, required) — The firewall's slug (fwl_…) or ID.

## Code samples

### cURL

```curl
curl --request GET \
  --url https://firewall-api.ezghcloud.com/v1/organizations/string/projects/string/firewalls/string \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://firewall-api.ezghcloud.com/v1/organizations/string/projects/string/firewalls/string';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://firewall-api.ezghcloud.com/v1/organizations/string/projects/string/firewalls/string"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

## Responses

### 200

The firewall, with its strong ETag (covering name, description, tags and rules).

#### Example

```json
{
  "attachmentCount": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "description": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "isDefault": true,
  "name": "string",
  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  "region": "string",
  "resourceName": "string",
  "rules": [
    {
      "createdAt": "2019-08-24T14:15:22Z",
      "description": "string",
      "direction": "inbound",
      "icmp": {
        "code": 255,
        "type": 255
      },
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "peer": {
        "cidr": "string"
      },
      "ports": {
        "from": 1,
        "to": 1
      },
      "protocol": "string"
    }
  ],
  "slug": "string",
  "status": "active",
  "tags": {
    "property1": "string",
    "property2": "string"
  },
  "updatedAt": "2019-08-24T14:15:22Z",
  "vpc": "string"
}
```

- `GetFirewall.response.200.attachmentCount` (integer, required)
- `GetFirewall.response.200.createdAt` (string, required)
  - format `date-time`
- `GetFirewall.response.200.description` (string, required)
- `GetFirewall.response.200.id` (string, required)
  - format `uuid`
- `GetFirewall.response.200.isDefault` (boolean, required) — The project's default firewall (one per project).
- `GetFirewall.response.200.name` (string, required)
- `GetFirewall.response.200.organizationId` (string, required)
  - format `uuid`
- `GetFirewall.response.200.projectId` (string, required)
  - format `uuid`
- `GetFirewall.response.200.region` (string, required)
- `GetFirewall.response.200.resourceName` (string, required)
- `GetFirewall.response.200.rules` (array<object>, required)
  - `GetFirewall.response.200.rules.createdAt` (string, required)
    - format `date-time`
  - `GetFirewall.response.200.rules.description` (string, required)
  - `GetFirewall.response.200.rules.direction` (string, required)
    - one of `"inbound"`, `"outbound"`
  - `GetFirewall.response.200.rules.icmp` (object | null, required) — icmp and icmpv6 only; null is every type, a null code every code.
    - `GetFirewall.response.200.rules.icmp.type` (integer, required)
      - min 0; max 255
    - `GetFirewall.response.200.rules.icmp.code` (integer | null, optional)
      - min 0; max 255
  - `GetFirewall.response.200.rules.id` (string, required)
    - format `uuid`
  - `GetFirewall.response.200.rules.peer` (one of, required)
    - one of: `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`, `object`
  - `GetFirewall.response.200.rules.ports` (object | null, required) — tcp and udp only; null is every port.
    - `GetFirewall.response.200.rules.ports.from` (integer, required)
      - min 1; max 65535
    - `GetFirewall.response.200.rules.ports.to` (integer, required)
      - min 1; max 65535
  - `GetFirewall.response.200.rules.protocol` (string, required) — tcp, udp, icmp (IPv4), icmpv6 (IPv6), all, or an IANA protocol number as a string (6, 17, 1 and 58 become their names).
- `GetFirewall.response.200.slug` (string, required)
  - pattern `^fwl_[a-z0-9]{12}$`
- `GetFirewall.response.200.status` (string, required)
  - one of `"active"`
- `GetFirewall.response.200.tags` (map<string>, required)
- `GetFirewall.response.200.updatedAt` (string, required)
  - format `date-time`
- `GetFirewall.response.200.vpc` (string | null, required) — The VPC whose default firewall this is: it attaches only to that VPC's network interfaces (409 firewall_vpc_mismatch) and is deleted with the VPC. null for every other firewall.
  - pattern `^vpc_[a-z0-9]{12}$`

### 400

invalid_request (with issues), invalid_cursor, or the endpoint's own 400 codes.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetFirewall.response.400.error` (object, required)
  - `GetFirewall.response.400.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetFirewall.response.400.error.message` (string, required)
    - maxLength 1024
  - `GetFirewall.response.400.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetFirewall.response.400.error.issues.message` (string, required)
    - `GetFirewall.response.400.error.issues.path` (string, required)
  - `GetFirewall.response.400.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetFirewall.response.400.error.quota.id` (string, required)
    - `GetFirewall.response.400.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetFirewall.response.400.error.quota.limit` (integer, required)
      - min 0
    - `GetFirewall.response.400.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetFirewall.response.400.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetFirewall.response.400.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetFirewall.response.400.error.quota.region` (string, optional)
    - `GetFirewall.response.400.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetFirewall.response.400.error.quota.scopeResourceName` (string, optional)
    - `GetFirewall.response.400.error.quota.used` (integer, optional)
      - min 0
    - `GetFirewall.response.400.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 401

unauthenticated: no credential, or one that doesn't check out.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetFirewall.response.401.error` (object, required)
  - `GetFirewall.response.401.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetFirewall.response.401.error.message` (string, required)
    - maxLength 1024
  - `GetFirewall.response.401.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetFirewall.response.401.error.issues.message` (string, required)
    - `GetFirewall.response.401.error.issues.path` (string, required)
  - `GetFirewall.response.401.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetFirewall.response.401.error.quota.id` (string, required)
    - `GetFirewall.response.401.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetFirewall.response.401.error.quota.limit` (integer, required)
      - min 0
    - `GetFirewall.response.401.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetFirewall.response.401.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetFirewall.response.401.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetFirewall.response.401.error.quota.region` (string, optional)
    - `GetFirewall.response.401.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetFirewall.response.401.error.quota.scopeResourceName` (string, optional)
    - `GetFirewall.response.401.error.quota.used` (integer, optional)
      - min 0
    - `GetFirewall.response.401.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 403

access_denied: the caller's policies don't allow the action; forbidden_origin: a cookie-authenticated write from an origin that isn't allowed; spend_limit_reached.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetFirewall.response.403.error` (object, required)
  - `GetFirewall.response.403.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetFirewall.response.403.error.message` (string, required)
    - maxLength 1024
  - `GetFirewall.response.403.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetFirewall.response.403.error.issues.message` (string, required)
    - `GetFirewall.response.403.error.issues.path` (string, required)
  - `GetFirewall.response.403.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetFirewall.response.403.error.quota.id` (string, required)
    - `GetFirewall.response.403.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetFirewall.response.403.error.quota.limit` (integer, required)
      - min 0
    - `GetFirewall.response.403.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetFirewall.response.403.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetFirewall.response.403.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetFirewall.response.403.error.quota.region` (string, optional)
    - `GetFirewall.response.403.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetFirewall.response.403.error.quota.scopeResourceName` (string, optional)
    - `GetFirewall.response.403.error.quota.used` (integer, optional)
      - min 0
    - `GetFirewall.response.403.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 404

not_found: unknown, malformed, or in an organization the caller isn't in.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetFirewall.response.404.error` (object, required)
  - `GetFirewall.response.404.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetFirewall.response.404.error.message` (string, required)
    - maxLength 1024
  - `GetFirewall.response.404.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetFirewall.response.404.error.issues.message` (string, required)
    - `GetFirewall.response.404.error.issues.path` (string, required)
  - `GetFirewall.response.404.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetFirewall.response.404.error.quota.id` (string, required)
    - `GetFirewall.response.404.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetFirewall.response.404.error.quota.limit` (integer, required)
      - min 0
    - `GetFirewall.response.404.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetFirewall.response.404.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetFirewall.response.404.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetFirewall.response.404.error.quota.region` (string, optional)
    - `GetFirewall.response.404.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetFirewall.response.404.error.quota.scopeResourceName` (string, optional)
    - `GetFirewall.response.404.error.quota.used` (integer, optional)
      - min 0
    - `GetFirewall.response.404.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 429

too_many_requests, with Retry-After; or quota_exceeded (a rate, usage or concurrency quota, with quota), never with Retry-After.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetFirewall.response.429.error` (object, required)
  - `GetFirewall.response.429.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetFirewall.response.429.error.message` (string, required)
    - maxLength 1024
  - `GetFirewall.response.429.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetFirewall.response.429.error.issues.message` (string, required)
    - `GetFirewall.response.429.error.issues.path` (string, required)
  - `GetFirewall.response.429.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetFirewall.response.429.error.quota.id` (string, required)
    - `GetFirewall.response.429.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetFirewall.response.429.error.quota.limit` (integer, required)
      - min 0
    - `GetFirewall.response.429.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetFirewall.response.429.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetFirewall.response.429.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetFirewall.response.429.error.quota.region` (string, optional)
    - `GetFirewall.response.429.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetFirewall.response.429.error.quota.scopeResourceName` (string, optional)
    - `GetFirewall.response.429.error.quota.used` (integer, optional)
      - min 0
    - `GetFirewall.response.429.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 500

internal_error: a bug; the details are in the logs, under the request ID.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetFirewall.response.500.error` (object, required)
  - `GetFirewall.response.500.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetFirewall.response.500.error.message` (string, required)
    - maxLength 1024
  - `GetFirewall.response.500.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetFirewall.response.500.error.issues.message` (string, required)
    - `GetFirewall.response.500.error.issues.path` (string, required)
  - `GetFirewall.response.500.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetFirewall.response.500.error.quota.id` (string, required)
    - `GetFirewall.response.500.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetFirewall.response.500.error.quota.limit` (integer, required)
      - min 0
    - `GetFirewall.response.500.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetFirewall.response.500.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetFirewall.response.500.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetFirewall.response.500.error.quota.region` (string, optional)
    - `GetFirewall.response.500.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetFirewall.response.500.error.quota.scopeResourceName` (string, optional)
    - `GetFirewall.response.500.error.quota.used` (integer, optional)
      - min 0
    - `GetFirewall.response.500.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 503

unavailable: a dependency the request needs is down. Retry after Retry-After.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `GetFirewall.response.503.error` (object, required)
  - `GetFirewall.response.503.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `GetFirewall.response.503.error.message` (string, required)
    - maxLength 1024
  - `GetFirewall.response.503.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `GetFirewall.response.503.error.issues.message` (string, required)
    - `GetFirewall.response.503.error.issues.path` (string, required)
  - `GetFirewall.response.503.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `GetFirewall.response.503.error.quota.id` (string, required)
    - `GetFirewall.response.503.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `GetFirewall.response.503.error.quota.limit` (integer, required)
      - min 0
    - `GetFirewall.response.503.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `GetFirewall.response.503.error.quota.inFlight` (integer, optional)
      - min 0
    - `GetFirewall.response.503.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `GetFirewall.response.503.error.quota.region` (string, optional)
    - `GetFirewall.response.503.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `GetFirewall.response.503.error.quota.scopeResourceName` (string, optional)
    - `GetFirewall.response.503.error.quota.used` (integer, optional)
      - min 0
    - `GetFirewall.response.503.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.


Source: https://docs.ezghcloud.com/firewall-api/GetFirewall/index.md
