## Create a User Agent Blocking rule

`client.firewall.uaRules.create(UARuleCreateParamsparams, RequestOptionsoptions?): UARuleCreateResponse`

**post** `/zones/{zone_id}/firewall/ua_rules`

Creates a new User Agent Blocking rule in a zone.

### Parameters

- `params: UARuleCreateParams`

  - `zone_id: string`

    Path param: Defines an identifier.

  - `configuration: Configuration`

    Body param

    - `target?: "ua"`

      The configuration target. You must set the target to `ua` when specifying a user agent in the rule.

      - `"ua"`

    - `value?: string`

      the user agent to exactly match

  - `mode: "block" | "challenge" | "whitelist" | 2 more`

    Body param: The action to apply to a matched request.

    - `"block"`

    - `"challenge"`

    - `"whitelist"`

    - `"js_challenge"`

    - `"managed_challenge"`

  - `description?: string`

    Body param: An informative summary of the rule. This value is sanitized and any tags will be removed.

  - `paused?: boolean`

    Body param: When true, indicates that the rule is currently paused.

### Returns

- `UARuleCreateResponse`

  - `id?: string`

    The unique identifier of the User Agent Blocking rule.

  - `configuration?: Configuration`

    The configuration object for the current rule.

    - `target?: string`

      The configuration target for this rule. You must set the target to `ua` for User Agent Blocking rules.

    - `value?: string`

      The exact user agent string to match. This value will be compared to the received `User-Agent` HTTP header value.

  - `description?: string`

    An informative summary of the rule.

  - `mode?: "block" | "challenge" | "js_challenge" | "managed_challenge"`

    The action to apply to a matched request.

    - `"block"`

    - `"challenge"`

    - `"js_challenge"`

    - `"managed_challenge"`

  - `paused?: boolean`

    When true, indicates that the rule is currently paused.

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const uaRule = await client.firewall.uaRules.create({
  zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
  configuration: {},
  mode: 'challenge',
});

console.log(uaRule.id);
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "id": "372e67954025e0ba6aaa6d586b9e0b59",
    "configuration": {
      "target": "ua",
      "value": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/603.2.4 (KHTML, like Gecko) Version/10.1.1 Safari/603.2.4"
    },
    "description": "Prevent access from abusive clients identified by this User Agent to mitigate a DDoS attack",
    "mode": "js_challenge",
    "paused": false
  },
  "success": true
}
```