---
title: "Update"
method: PATCH
path: "/ip_restrictions/{id}"
tags: ["IPRestrictions"]
---

# Update

`PATCH /ip_restrictions/{id}`

Update attributes of an IP restriction by ID

## Path parameters

- `id` string, required

## Headers

- `ngrok-version` integer, required

## Request body

- IPRestrictionUpdate
  - `id` string — n/a
  - `description` string — human-readable description of this IP restriction. optional, max 255 bytes.
  - `metadata` string — arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes.
  - `enforced` boolean — true if the IP restriction will be enforced. if false, only warnings will be issued
  - `ip_policy_ids` string[] — the set of IP policy identifiers that are used to enforce the restriction

## Response `200`

Update attributes of an IP restriction by ID

- IPRestriction
  - `id` string — unique identifier for this IP restriction
  - `uri` string — URI of the IP restriction API resource
  - `created_at` string — timestamp when the IP restriction was created, RFC 3339 format
  - `description` string — human-readable description of this IP restriction. optional, max 255 bytes.
  - `metadata` string — arbitrary user-defined machine-readable data of this IP restriction. optional, max 4096 bytes.
  - `enforced` boolean — true if the IP restriction will be enforced. if false, only warnings will be issued
  - `type` string — the type of IP restriction. this defines what traffic will be restricted with the attached policies. four values are currently supported: `dashboard`, `api`, `agent`, and `endpoints`
  - `ip_policies` Ref[] — the set of IP policies that are used to enforce the restriction
    - `id` string — a resource identifier
    - `uri` string — a uri for locating a resource

---

[API](https://skmtc.net/ngrok/apis/ngrok-openapi.md) · [All operations](https://skmtc.net/ngrok/apis/ngrok-openapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ngrok/ngrok-openapi/versions/1994bbb04714/schema)