---
title: "Security Group Rule"
description: "Security Group Rule object in the Exoscale API reference."
url: https://community.exoscale.com/reference/api/_schemas/security-group-rule/
section: reference
last_updated: 2026-10-14
---
> For AI agents: the documentation index is at https://community.exoscale.com/llms.txt. Every page is available as markdown at `<page URL>index.md` or with `Accept: text/markdown`.

# Security Group Rule

Security Group rule

## Properties

| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `description` | string | no | Security Group rule description<br/><br/>Max length: `255`. |
| `end-port` | integer | no | End port of the range<br/><br/>Min: `1`. Max: `65535`. |
| `flow-direction` | string | no | Network flow direction to match<br/><br/>Allowed values: `ingress`, `egress`. |
| `icmp` | [ICMP](https://community.exoscale.com/reference/api/_schemas/security-group-rule/index.md#icmp) | no | ICMP details |
| `id` | string | no | Security Group rule ID<br/><br/>Must be a valid UUID. |
| `network` | string | no | CIDR-formatted network allowed |
| `protocol` | string | no | Network protocol<br/><br/>Allowed values: `tcp`, `esp`, `all`, `icmp`, `udp`, `gre`, `ah`, `ipip`, `icmpv6`. |
| `security-group` | [Security Group](https://community.exoscale.com/reference/api/_schemas/security-group-resource/index.md) | no | Security Group allowed |
| `start-port` | integer | no | Start port of the range<br/><br/>Min: `1`. Max: `65535`. |

### ICMP {#icmp}

ICMP details

| Property | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | integer | no | Min: `-1`. Max: `254`. |
| `type` | integer | no | Min: `-1`. Max: `254`. |