Create a new Ringfence Rule.

Prev Next
Post
/ringfence-rules

Create a new Ringfence Rule.

Security
HTTP
Type bearer
Body parameters

Ringfence Rule object.

Expand All
object
id
string (uuid)

ID of the object.

Example4c07bc67-57ea-42dd-b702-c2d6c45419fc
name
string Required

Name of the object.

Exampleobject
notes
string

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
protocol
string Required

Protocol of the ringfence action.

Valid values[ "icmp", "icmpv6", "udp", "tcp" ]
direction
string Required

The direction of the action

Valid values[ "up", "down", "out", "in" ]
action
string 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
Responses
200

Created Ringfence Rule.

Expand All
object
id
string (uuid)

ID of the object.

Example4c07bc67-57ea-42dd-b702-c2d6c45419fc
name
string

Name of the object.

Exampleobject
notes
string

Notes for the object. Used for documentation purposes.

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

Create date.

updated
string (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
protocol
string

Protocol of the ringfence action.

Valid values[ "icmp", "icmpv6", "udp", "tcp" ]
direction
string

The direction of the action

Valid values[ "up", "down", "out", "in" ]
action
string

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.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

401

Token error. Login again.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

403

Insufficient permissions to access this resource.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

406

Invalid 'Accept' header.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

409

The submitted resource conflicts with another.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.

422

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

Expand All
object

Http 422 error for object validation.

id
string

Machine readable error code.

message
string

Human readable error details.

errors
Array of object

List of fields with validation errors.

object
field
string

Name of the field that failed validation.

Examplename
message
string

Failure reason.

Examplemay not be null
500

Unexpected server side error.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.