---
title: "Create a new Ringfence Rule."
slug: "create-a-new-ringfence-rule-1"
updated: 2026-03-02T22:30:52Z
published: 2026-03-02T22:35:48Z
canonical: "support.appgate.com/create-a-new-ringfence-rule-1"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://support.appgate.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a new Ringfence Rule.

Post/ringfence-rules

Create a new Ringfence Rule.

SecurityHTTPType bearer

Body parameters

Ringfence Rule object.

<select class='api-response-data' aria-label='Media type'><option value='82c32727-d31b-49dd-bdea-8de3a26e1257'>application/json</option>
</select>Expand Allobject  idstring  (uuid)    

ID of the object.

Example4c07bc67-57ea-42dd-b702-c2d6c45419fc
namestring    Required

Name of the object.

Exampleobject
notesstring    

Notes for the object. Used for documentation purposes.

ExampleThis object has been created for test purposes.

tags Array of string   

Array of tags.

Example[
  "developer",
  "api-created"
]string    
actions Array of object   Required

List of all ringfence actions in this Ringfence Rule.

object  protocolstring    Required

Protocol of the ringfence action.

Valid values[
  "icmp",
  "icmpv6",
  "udp",
  "tcp"
]
directionstring    Required

The direction of the action

Valid values[
  "up",
  "down",
  "out",
  "in"
]
actionstring    Required

Applied action to the traffic.

Valid values[
  "allow",
  "block"
]
hosts Array of string   Required

Destination address. IP address or hostname.

string    Example10.0.2.0/24
ports Array of string   

Destination port. Multiple ports can be entered comma separated. Port ranges can be entered dash separated. Only valid for tcp and udp subtypes.

Example[
  "80",
  "443",
  "1024-2048"
]string    
types Array of string   

ICMP type. Only valid for icmp protocol.

string    Example0-255

Responses200

Created Ringfence Rule.

<select class='api-response-data' aria-label='Media type'><option value='e87a711a-4301-4982-a44e-1ad66afaaeb3'>application/json</option>
</select>Expand Allobject  idstring  (uuid)    

ID of the object.

Example4c07bc67-57ea-42dd-b702-c2d6c45419fc
namestring    

Name of the object.

Exampleobject
notesstring    

Notes for the object. Used for documentation purposes.

ExampleThis object has been created for test purposes.
createdstring  (date-time)    

Create date.

updatedstring  (date-time)    

Last update date.

tags Array of string   

Array of tags.

Example[
  "developer",
  "api-created"
]string    
actions Array of object   

List of all ringfence actions in this Ringfence Rule.

object  protocolstring    

Protocol of the ringfence action.

Valid values[
  "icmp",
  "icmpv6",
  "udp",
  "tcp"
]
directionstring    

The direction of the action

Valid values[
  "up",
  "down",
  "out",
  "in"
]
actionstring    

Applied action to the traffic.

Valid values[
  "allow",
  "block"
]
hosts Array of string   

Destination address. IP address or hostname.

string    Example10.0.2.0/24
ports Array of string   

Destination port. Multiple ports can be entered comma separated. Port ranges can be entered dash separated. Only valid for tcp and udp subtypes.

Example[
  "80",
  "443",
  "1024-2048"
]string    
types Array of string   

ICMP type. Only valid for icmp protocol.

string    Example0-255

400

JSON error. Check the JSON format.

<select class='api-response-data' aria-label='Media type'><option value='2341a587-78af-4f36-a0f8-6bf67dec4629'>application/json</option>
</select>object  

Generic HTTP error.

idstring    

Machine readable error code.

messagestring    

Human readable error details.

401

Token error. Login again.

<select class='api-response-data' aria-label='Media type'><option value='99ed9364-3e7e-417b-a608-e64cd47421a0'>application/json</option>
</select>object  

Generic HTTP error.

idstring    

Machine readable error code.

messagestring    

Human readable error details.

403

Insufficient permissions to access this resource.

<select class='api-response-data' aria-label='Media type'><option value='d4e6444f-3a66-424c-9917-a30567f95efc'>application/json</option>
</select>object  

Generic HTTP error.

idstring    

Machine readable error code.

messagestring    

Human readable error details.

406

Invalid 'Accept' header.

<select class='api-response-data' aria-label='Media type'><option value='bed1a834-5a88-4f98-a011-35b2af350e44'>application/json</option>
</select>object  

Generic HTTP error.

idstring    

Machine readable error code.

messagestring    

Human readable error details.

409

The submitted resource conflicts with another.

<select class='api-response-data' aria-label='Media type'><option value='6415cbbb-84be-43a5-8c3e-0af2c606b260'>application/json</option>
</select>object  

Generic HTTP error.

idstring    

Machine readable error code.

messagestring    

Human readable error details.

422

Request validation error. Check "errors" array for details.

<select class='api-response-data' aria-label='Media type'><option value='5503024c-d1d2-400b-aaa7-3f43ccfa646e'>application/json</option>
</select>Expand Allobject  

Http 422 error for object validation.

idstring    

Machine readable error code.

messagestring    

Human readable error details.

errors Array of object   

List of fields with validation errors.

object  fieldstring    

Name of the field that failed validation.

Examplename
messagestring    

Failure reason.

Examplemay not be null

500

Unexpected server side error.

<select class='api-response-data' aria-label='Media type'><option value='e04e9fdd-931b-4cf0-8b4c-1f2228fa4e49'>application/json</option>
</select>object  

Generic HTTP error.

idstring    

Machine readable error code.

messagestring    

Human readable error details.