Skip to main content
PATCH
Rename a firewall group

Authorizations

Authorization
string
header
required

Your API key, sent as a bearer token. Create one in the control panel under API Keys, give it only the permissions the integration needs, and copy it when it is created. It cannot be shown again. Each key is restricted to one owned team. The key determines the team for every request.

Path Parameters

firewallGroup
string
required

The firewall group uuid short

Example:

"72a4a737-236f-456f-827f-6145d9c95727"

Body

application/json

Send a JSON object containing the fields below. Required fields are marked in the schema.

name
string
required

A name unique for this group type across the account, 1 to 100 characters. Use letters, numbers, spaces, dots, dashes or underscores.

Example:

"Lambda Complex public ingress"

Response

The record, as a JSON object. There is no envelope.

A reusable set of firewall rules.

id
string
required

The id ID.

Example:

"72a4a737-236f-456f-827f-6145d9c95727"

uuid_short
string
required

The first eight characters of the UUID. Either form can identify the group.

Example:

"Uuid short"

name
string
required

The name shown to customers.

Example:

"Lambda Complex ingress"

applied
boolean
required

Whether the group is applied to the requested server. Always false when no server was requested.

Example:

false

rules
FirewallGroupRuleData · object[]
required

The value of rules.

Example:
servers
FirewallGroupServerData · object[]
required

The value of servers.

Example:
created_at
string | null
required

The date and time for created at, in UTC.

Example:

"2026-03-02T19:31:08+00:00"