USusenash
Zones

Update zone restriction

Changed on

Update an existing zone restriction's rules or configuration. Only provided fields are updated.

patch/v1/zone-restrictions/{id}

Request

Path parameters

idstring required

The ID of the zone restriction.

Request body

externalIdstring nullable

The external ID of the zone restriction.

namestring required

The name of the zone restriction.

isActiveboolean nullable

Whether the zone restriction is active.

restrictionMetadataobject nullable

The metadata of the zone restriction.

Example request

{
  "restrictionMetadata": {
    "key": "value"
  }
}

Response

OK

idstring required

The ID of the zone restriction.

externalIdstring required

The external ID of the zone restriction.

namestring required

The name of the zone restriction.

isActiveboolean required

Whether the zone restriction is active.

restrictionMetadataobject nullable required

The metadata of the zone restriction.

Example response

{
  "id": "res_01234567890123456789",
  "externalId": "ext_01234567890123456789",
  "name": "Zone Restriction 1",
  "isActive": true,
  "restrictionMetadata": {
    "restriction_metadata": {
      "key": "value"
    }
  }
}

Changes