Get a specific Ringfence Rule.

Prev Next
Get
/ringfence-rules/{id}

Get a specific Ringfence Rule.

Security
HTTP
Type bearer
Path parameters
id
string (uuid) Required

ID of the object.

Example12699e27-b584-464a-81ee-5b4784b6d425
Responses
200

Single Ringfence Rule object.

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
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.

404

The requested resource can not be found.

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.

500

Unexpected server side error.

object

Generic HTTP error.

id
string

Machine readable error code.

message
string

Human readable error details.