---
title: "Get a WAF"
---

> 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: WAF API

`GET /v1/organizations/{orgId}/projects/{projectId}/wafs/{wafId}`

## Authentication

Requires one of the following:

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

## Path parameters

- `GetWaf.path.orgId` (string, required) — UUID or prefixed ID (org_…)
- `GetWaf.path.projectId` (string, required) — UUID or prefixed ID (prj_…)
- `GetWaf.path.wafId` (string, required) — UUID or prefixed ID (waf_…)

## Code samples

### cURL

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

### TypeScript

```typescript
const url = 'https://waf-api.ezghcloud.com/v1/organizations/string/projects/string/wafs/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://waf-api.ezghcloud.com/v1/organizations/string/projects/string/wafs/string"

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

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

print(response.text)
```

## Responses

### 200

The WAF.

#### Example

```json
{
  "attachments": [
    "string"
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "defaultAction": "allow",
  "description": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "logging": {
    "environment": "string",
    "scope": "off"
  },
  "managedRuleSets": [
    {
      "mode": "block",
      "name": "ezgh/core",
      "paranoiaLevel": 1,
      "ruleOverrides": [
        {
          "action": "off",
          "ruleId": 0
        }
      ]
    }
  ],
  "mode": "block",
  "name": "string",
  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  "region": "string",
  "resourceName": "string",
  "rules": [
    {
      "action": "allow",
      "conditions": [
        {
          "cidrs": [
            "string"
          ],
          "negate": true,
          "type": "ipSet"
        }
      ],
      "mode": "block",
      "name": "string",
      "rateLimit": {
        "limit": 1,
        "windowSeconds": 60
      }
    }
  ],
  "slug": "string",
  "status": "string",
  "tags": {
    "property1": "string",
    "property2": "string"
  },
  "updatedAt": "2019-08-24T14:15:22Z",
  "version": 0
}
```

- `GetWaf.response.200.attachments` (array<string>, required) — The load balancers (lbr_…) and CDN distributions (cdn_…) it's attached to. Attach on the load balancer or the distribution.
- `GetWaf.response.200.createdAt` (string, required)
  - format `date-time`
- `GetWaf.response.200.defaultAction` (unknown, required)
  - one of `"allow"`
- `GetWaf.response.200.description` (string | null, required)
- `GetWaf.response.200.id` (string, required)
  - format `uuid`
- `GetWaf.response.200.logging` (object, required)
  - `GetWaf.response.200.logging.environment` (string | null, required) — The Obs environment in the WAF's project; required unless scope is off. Turning logging on needs obs.logs.ingest on the project.
    - pattern `^[a-z0-9][a-z0-9._-]{0,62}$`
  - `GetWaf.response.200.logging.scope` (unknown, required) — Request logs to Obs: none, the requests a rule matched, or every request.
    - one of `"off"`, `"matched"`, `"all"`
- `GetWaf.response.200.managedRuleSets` (array<object>, required) — Run in order, after the custom rules.
  - `GetWaf.response.200.managedRuleSets.mode` (unknown, required) — Default block.
    - one of `"block"`, `"log"`
  - `GetWaf.response.200.managedRuleSets.name` (unknown, required)
    - one of `"ezgh/core"`, `"ezgh/php"`, `"ezgh/node"`, `"ezgh/known-bad-inputs"`
  - `GetWaf.response.200.managedRuleSets.paranoiaLevel` (integer | null, required) — ezgh/core only (default 1); null for the others.
    - min 1; max 2
  - `GetWaf.response.200.managedRuleSets.ruleOverrides` (array<object>, required)
    - `GetWaf.response.200.managedRuleSets.ruleOverrides.action` (unknown, required)
      - one of `"off"`, `"log"`
    - `GetWaf.response.200.managedRuleSets.ruleOverrides.ruleId` (integer, required) — A rule of the set.
- `GetWaf.response.200.mode` (unknown, required) — log turns every block of the WAF into a log.
  - one of `"block"`, `"log"`
- `GetWaf.response.200.name` (string, required)
- `GetWaf.response.200.organizationId` (string, required)
  - format `uuid`
- `GetWaf.response.200.projectId` (string, required)
  - format `uuid`
- `GetWaf.response.200.region` (string, required)
- `GetWaf.response.200.resourceName` (string, required)
- `GetWaf.response.200.rules` (array<object>, required) — Custom rules, top to bottom; the first that ends a request wins.
  - `GetWaf.response.200.rules.action` (unknown, required) — allow stops and skips the managed sets; block answers 403; log records and continues; rateLimit counts matching requests per client address and blocks (or logs) a client over the limit.
    - one of `"allow"`, `"block"`, `"log"`, `"rateLimit"`
  - `GetWaf.response.200.rules.conditions` (array<one of>, required) — All must match.
    - one of: [IpSetCondition](/waf-api/schemas/IpSetCondition/), [AsnCondition](/waf-api/schemas/AsnCondition/), [CountryCondition](/waf-api/schemas/CountryCondition/), [RegexCondition](/waf-api/schemas/RegexCondition/), [ContainsCondition](/waf-api/schemas/ContainsCondition/), [EqualsCondition](/waf-api/schemas/EqualsCondition/)
    - discriminator: `type`
  - `GetWaf.response.200.rules.mode` (string | null, required) — rateLimit only (default block); null otherwise.
    - one of `"block"`, `"log"`, `null`
  - `GetWaf.response.200.rules.name` (string, required) — Unique in the WAF.
    - pattern `^[a-z0-9-]{1,64}$`
  - `GetWaf.response.200.rules.rateLimit` (one of, required) — rateLimit only; null otherwise.
    - one of: [RateLimit](/waf-api/schemas/RateLimit/), `null`
- `GetWaf.response.200.slug` (string, required) — waf_…
- `GetWaf.response.200.status` (string, required) — active; clients treat others as unknown.
- `GetWaf.response.200.tags` (map<string>, required) — At most 50; keys 1-128 characters (ezgh: is reserved), values at most 256.
- `GetWaf.response.200.updatedAt` (string, required)
  - format `date-time`
- `GetWaf.response.200.version` (integer, required) — Rises on every change; the ETag is its value in quotes.

### 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"
    }
  }
}
```

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

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

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

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

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

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

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


Source: https://docs.ezghcloud.com/waf-api/GetWaf/index.md
