Skip to main content
GET
Get cluster firewall
Updated August 24, 2026

Authorizations

X-API-Key
string
header
required

API key for authentication. Each key is bound to a specific account.

Headers

X-Project-ID
string<uuid>
required

Project ID. Required for all mutating operations (create, delete, power actions, resize).

Path Parameters

cluster_id
string
required

Cluster ID (short id, e.g. q7z7zg)

Response

Firewall state

success
boolean
enabled
boolean
default_name
string

Platform baseline security group

Example:

"raff-default-secure"

assigned_sg_id
string<uuid>

Custom security group currently assigned (absent when on the baseline)

assigned_name
string
available
object[]

Your security groups that can be assigned

Last modified on August 24, 2026