---
title: "Create System Bypass Rule"
method: POST
path: "/v1/security/firewall/bypass"
tags: ["security"]
---

# Create System Bypass Rule

`POST /v1/security/firewall/bypass`

Create new system bypass rules

## Query parameters

- `projectId` string, required
- `teamId` string
- `slug` string

## Request body

- union
  - object
    - `domain` string, required
    - `projectScope` boolean — If the specified bypass will apply to all domains for a project.
    - `sourceIp` string
    - `allSources` boolean
    - `ttl` number — Time to live in milliseconds
    - `note` string
  - object
    - `domain` string
    - `projectScope` boolean, required — If the specified bypass will apply to all domains for a project.
    - `sourceIp` string
    - `allSources` boolean
    - `ttl` number — Time to live in milliseconds
    - `note` string

## Response `200`

- union
  - object
    - `ok` false | true, required
    - `result` object[], required
      - `OwnerId` string, required
      - `Id` string, required
      - `Domain` string, required
      - `Ip` string
      - `ProjectId` string, required
      - `Note` string, required
      - `IsProjectRule` false | true, required
    - `pagination` unknown, required
  - object
    - `ok` false | true, required
    - `result` object[]
      - `OwnerId` string, required
      - `Id` string, required
      - `Domain` string, required
      - `Ip` string, required
      - `Action` 'block' | 'bypass'
      - `ProjectId` string
      - `IsProjectRule` false | true
      - `Note` string
      - `CreatedAt` string, required
      - `ActorId` string
      - `UpdatedAt` string, required
      - `UpdatedAtHour` string, required
      - `DeletedAt` string
      - `ExpiresAt` number, nullable

## Other responses

- `400` — One of the provided values in the request body is invalid. One of the provided values in the request query is invalid.
- `401` — The request is not authorized.
- `403` — You do not have permission to access this resource.
- `404`
- `410`
- `500`

---

[API](https://skmtc.net/vercel/apis/api.md) · [All operations](https://skmtc.net/vercel/apis/api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vercel/api/versions/61d1ba3f6dac/schema)
