Skip to content
StratumStratum Docs

List hosted zones in a project.

GET
/v1/projects/{projectId}/dns/zones
Code sample: Shell / cURL
curl --request GET \
  --url https://stratum.example.com/v1/projects/example/dns/zones \
  --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-]+$/

Responses

Section titled “Responses”

200

Section titled “200”

Hosted zones.

Media typeapplication/json
object
items
required
Array<object>
object
id
required
string
/^zone-[a-z0-9]+$/
projectId
required
string
region
string
name
required

The logical zone FQDN with a trailing dot.

string
servedFqdn

The on-wire delegated FQDN the zone is served at (...), recorded by the reconciler when it publishes the zone’s delegation. Read-only; empty until the zone becomes active.

string
soaMName
string
soaRName
string
soaSerial
integer format: int64
soaRefresh
integer
soaRetry
integer
soaExpire
integer
soaMinimum
integer
defaultTtl
integer
dnssecEnabled

The DESIRED signing state — what was asked for. Whether the zone is signed and anchored right now is dnssecState.

boolean
dnssecState

The OBSERVED signing state, converged by the reconciler. A pending_ds zone is signed but anchored by nothing, which every validating resolver treats as unsigned. Read-only.

string
Allowed values: insecure pending_ds secure withdrawing
dnssecDsWithdrawnAt

When the zone’s DS was withdrawn from its parent. Set only while withdrawing, during which the zone keeps signing until the DS expires from resolver caches. Read-only.

string format: date-time
visibility
string
Allowed values: public private
vpcId
string
nullable
systemManaged

True for a control-plane-owned zone (e.g. stratum.internal): it is desired state the reconciler keeps present and cannot be deleted through this API (a delete returns 403). Read-only; tenant-created zones are always false.

boolean
generation
integer format: int64
comment
string
nullable
tags
object
key
additional properties
any
state
required
string
createdAt
string format: date-time
updatedAt
string format: date-time
createdBy
string
nextPageToken
string

Example 

{
  "items": [
    {
      "dnssecState": "insecure",
      "visibility": "public"
    }
  ]
}