Skip to content
StratumStratum Docs

Describe a DNS firewall rule group (with its domains + associations).

GET
/v1/projects/{projectId}/dns/firewall-rule-groups/{groupId}
Code sample: Shell / cURL
curl --request GET \
  --url https://stratum.example.com/v1/projects/example/dns/firewall-rule-groups/example \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
projectId
required
string
/^p-[a-z0-9-]+$/
groupId
required
string
/^fwrg-[a-z0-9]+$/

Responses

Section titled “Responses”

200

Section titled “200”

The rule group.

Media typeapplication/json
object
id
required
string
/^fwrg-[a-z0-9]+$/
projectId
required
string
region
string
name
required
string
managed

True for a platform-curated managed group: owned by the platform, read-only to tenants, associable by any project with its own VPCs.

boolean
description

Human-readable description; set on managed groups to explain the curated list.

string
createdAt
string format: date-time
domains

The group’s domain rules. Omitted on the managed-list discovery endpoint (see domainCount).

Array<object>
object
domain
required

FQDN to match (its subtree is included). A trailing dot is added if omitted.

string
action
required

Block sinkholes the domain (NXDOMAIN); alert logs matched queries but resolves normally (monitoring); allow overrides a block/alert for that exact domain.

string
Allowed values: block allow alert
vpcIds

VPCs this rule group is associated with.

Array<string>
domainCount

Number of domain rules; set by the managed-list discovery endpoint in lieu of the full domains array.

integer

Example 

{
  "domains": [
    {
      "action": "block"
    }
  ]
}

404

Section titled “404”

Resource not found.

Media typeapplication/problem+json
object
type
required
string format: uri
title
required
string
status
required
integer
>= 400 <= 599
detail
string
instance
string format: uri-reference
requestId
required
string
code
required
string
issues

The findings of a rejected IAM policy document (custom and resource policies).

Array<object>

One finding of a rejected IAM policy document. A rejection lists every finding, so the author fixes the document in one round trip.

object
code
required

The finding, e.g. INVALID_DOCUMENT, UNKNOWN_ACTION, ACTION_NOT_APPLICABLE.

string
statement
required

Index of the statement at fault; -1 for the document as a whole.

integer
>= -1
detail
required
string
action

The offending action, where one is at fault (ACTION_NOT_APPLICABLE).

string
errors

Field errors, for codes that carry them: each problem at its field (see FieldError). Documented on the responses that set it, e.g. approveNodeJoin’s INVALID_INPUT and JOIN_APPROVAL_REFUSED. Absent otherwise.

Array<object>

One field’s problem, the stage-2 installer API’s shape. field is the field’s path, message what is wrong with it.

object
field
required

The field’s path, e.g. links[0].interface, disks[1].confirm, mgmt.address or role; empty for the whole request.

string
message
required
string
details

Structured facts about the refusal, for codes that carry them. The shape is fixed per code and documented on the response that answers it, e.g. IMAGE_POOL_MISMATCH (see ImagePoolMismatchDetails) and IMAGE_IN_USE. Absent for codes that carry none.

object
key
additional properties
any

Example 

{
  "issues": [
    {
      "code": "ACTION_NOT_APPLICABLE",
      "action": "compute:CreateVpc"
    }
  ]
}