Skip to main content
POST
Create an IP 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.

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:

"Sector C lab"

Response

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

A named list of addresses a customer points firewall rules at.

id
string
required

The id ID.

Example:

"145e6e6f-a6b0-4b9e-9060-2d4f017baff8"

name
string
required

The name shown to customers.

Example:

"Sector C lab"

entries
FirewallIpGroupEntryData · object[]
required

The value of entries.

Example:
rules_count
integer
required

How many firewall rules point at this group - what makes it unsafe to delete, so the list needs it even without the detail below.

Example:

1

created_at
string | null
required

The date and time for created at, in UTC.

Example:

"2026-03-02T19:24:51+00:00"

used_by

Which firewall groups use this one, named.