@opusdns/api 1.25.0 → 1.27.0

package/src/openapi.yaml

@@ -432,6 +432,17 @@ components:
       - claims_notices
       title: ClaimsNoticesResponse
       type: object
+    ClearVanityNameserverSetDefaultRes:
+      properties:
+        cleared:
+          description: True if an ACTIVE default was unset; False on an idempotent
+            no-op (org had no default).
+          title: Cleared
+          type: boolean
+      required:
+      - cleared
+      title: ClearVanityNameserverSetDefaultRes
+      type: object
     CommandError:
       properties:
         code:
@@ -2368,6 +2379,16 @@ components:
       - rdata
       title: DnsRecordCreate
       type: object
+    DnsRecordDTO:
+      properties:
+        rdata:
+          description: The record data (e.g., IP address, domain name)
+          title: Rdata
+          type: string
+      required:
+      - rdata
+      title: DnsRecordDTO
+      type: object
     DnsRecordPatchOp:
       properties:
         op:
@@ -2420,6 +2441,31 @@ components:
       - records
       title: DnsRrsetCreate
       type: object
+    DnsRrsetDTO:
+      properties:
+        name:
+          description: The RRset name (e.g., '@', 'www')
+          title: Name
+          type: string
+        records:
+          description: List of records in this RRset
+          items:
+            $ref: '#/components/schemas/DnsRecordDTO'
+          title: Records
+          type: array
+        ttl:
+          description: Time to live in seconds
+          title: Ttl
+          type: integer
+        type:
+          $ref: '#/components/schemas/DnsRrsetType'
+          description: The RRset type
+      required:
+      - name
+      - type
+      - ttl
+      title: DnsRrsetDTO
+      type: object
     DnsRrsetPatch:
       properties:
         name:
@@ -2729,6 +2775,52 @@ components:
       - zone_name
       title: DnsZoneCreateWorkerResult
       type: object
+    DnsZoneDTO:
+      properties:
+        created_on:
+          anyOf:
+          - format: date-time
+            type: string
+          - type: 'null'
+          description: Zone creation timestamp
+          title: Created On
+        dnssec_status:
+          $ref: '#/components/schemas/DnssecStatus'
+          default: disabled
+          description: DNSSEC status
+        name:
+          description: The zone name (e.g., 'example.com')
+          title: Name
+          type: string
+        rrsets:
+          description: List of RRsets in the zone
+          items:
+            $ref: '#/components/schemas/DnsRrsetDTO'
+          title: Rrsets
+          type: array
+        updated_on:
+          anyOf:
+          - format: date-time
+            type: string
+          - type: 'null'
+          description: Zone last update timestamp
+          title: Updated On
+        vanity_nameserver_set_id:
+          anyOf:
+          - examples:
+            - vns_01h45ytscbebyvny4gc8cr8ma2
+            format: typeid
+            pattern: ^vns_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+            type: string
+            x-typeid-prefix: vns
+          - type: 'null'
+          description: Vanity NS set branding this zone's apex, or null for system
+            default NS
+          title: Vanity Nameserver Set Id
+      required:
+      - name
+      title: DnsZoneDTO
+      type: object
     DnsZonePatchRecordsBulkCommand:
       properties:
         command:
@@ -3146,6 +3238,15 @@ components:
       - zone
       title: DnsZoneUpdateWorkerPayload
       type: object
+    DnsZoneVanitySetUpdateRes:
+      properties:
+        zone:
+          $ref: '#/components/schemas/DnsZoneDTO'
+          description: The zone after restamping
+      required:
+      - zone
+      title: DnsZoneVanitySetUpdateRes
+      type: object
     DnssecAlgorithm:
       enum:
       - 1
@@ -7994,6 +8095,36 @@ components:
       - confirmation
       title: LegalRequirementType
       type: string
+    ListVanityNameserverSetsRes:
+      properties:
+        pagination:
+          $ref: '#/components/schemas/PaginationMetadataDTO'
+          description: Pagination metadata
+        results:
+          description: Sets owned by the org, newest first; includes non-ACTIVE rows
+          items:
+            $ref: '#/components/schemas/VanityNameserverSetSummaryDTO'
+          title: Results
+          type: array
+      required:
+      - pagination
+      title: ListVanityNameserverSetsRes
+      type: object
+    ListZonesReferencingSetRes:
+      properties:
+        pagination:
+          $ref: '#/components/schemas/PaginationMetadataDTO'
+          description: Pagination metadata
+        results:
+          description: Zones whose apex is branded by the set, ordered by zone name
+          items:
+            $ref: '#/components/schemas/DnsZoneDTO'
+          title: Results
+          type: array
+      required:
+      - pagination
+      title: ListZonesReferencingSetRes
+      type: object
     LocalPresenceBase:
       properties:
         eligible_countries:
@@ -9250,6 +9381,41 @@ components:
       - has_previous_page
       title: PaginationMetadata
       type: object
+    PaginationMetadataDTO:
+      properties:
+        current_page:
+          description: Current page number
+          title: Current Page
+          type: integer
+        has_next_page:
+          description: Whether there is a next page
+          title: Has Next Page
+          type: boolean
+        has_previous_page:
+          description: Whether there is a previous page
+          title: Has Previous Page
+          type: boolean
+        page_size:
+          description: Items per page
+          title: Page Size
+          type: integer
+        total_items:
+          description: Total number of items
+          title: Total Items
+          type: integer
+        total_pages:
+          description: Total number of pages
+          title: Total Pages
+          type: integer
+      required:
+      - total_pages
+      - total_items
+      - current_page
+      - page_size
+      - has_next_page
+      - has_previous_page
+      title: PaginationMetadataDTO
+      type: object
     Pagination_BillingTransactionResponse_:
       properties:
         pagination:
@@ -10858,6 +11024,16 @@ components:
           type: boolean
       title: RgpOperations
       type: object
+    SetVanityNameserverSetDefaultRes:
+      properties:
+        vanity_nameserver_set:
+          $ref: '#/components/schemas/VanityNameserverSetDTO'
+          description: The set that is now the org's default (or unchanged set on
+            a no-op 200).
+      required:
+      - vanity_nameserver_set
+      title: SetVanityNameserverSetDefaultRes
+      type: object
     SldLength:
       properties:
         max:
@@ -12437,107 +12613,422 @@ components:
       - type
       title: ValidationError
       type: object
-    VerificationClaimType:
-      enum:
-      - name
-      - address
-      - email
-      - phone
-      title: VerificationClaimType
-      type: string
-    VerificationDeadline:
+    VanityNameserverDTO:
       properties:
-        date:
-          format: date-time
-          title: Date
+        hostname:
+          description: Fully-qualified hostname of the vanity nameserver
+          title: Hostname
           type: string
-        type:
-          $ref: '#/components/schemas/VerificationDeadlineType'
+        position:
+          description: Ordering within the set; lowest position becomes SOA MNAME
+          minimum: 0.0
+          title: Position
+          type: integer
       required:
-      - type
-      - date
-      title: VerificationDeadline
+      - hostname
+      - position
+      title: VanityNameserverDTO
       type: object
-    VerificationDeadlineType:
-      enum:
-      - dedelegation
-      - deletion
-      title: VerificationDeadlineType
-      type: string
-    VerificationRegistrantDetails:
+    VanityNameserverSetCreate:
+      description: 'Public create request body. The owning org comes from auth context,
+        and the
+
+        anycast IPs are allocated server-side from `VanityNameserversConfig`, so neither
+        is
+
+        accepted here.'
       properties:
-        contact_id:
-          title: Contact Id
-          type: string
-        email:
-          title: Email
-          type: string
+        hostnames:
+          description: Fully-qualified vanity NS hostnames, ordered by intended position.
+          items:
+            type: string
+          minItems: 1
+          title: Hostnames
+          type: array
         name:
+          description: Human-readable name for the set
+          maxLength: 255
+          minLength: 1
           title: Name
           type: string
+        parent_domain_name:
+          description: Apex domain of the vanity NS zone; all hostnames must be subdomains.
+          title: Parent Domain Name
+          type: string
+        soa_rname:
+          description: SOA RNAME stamped verbatim into the vanity NS zone
+          maxLength: 255
+          minLength: 1
+          title: Soa Rname
+          type: string
       required:
-      - contact_id
       - name
-      - email
-      title: VerificationRegistrantDetails
+      - parent_domain_name
+      - soa_rname
+      - hostnames
+      title: VanityNameserverSetCreate
       type: object
-    VerificationResponse:
+    VanityNameserverSetDTO:
       properties:
-        claims:
-          description: Verification claims
+        name:
+          description: Human-readable name for the vanity NS set
+          title: Name
+          type: string
+        nameservers:
+          description: Nameservers in the set, ordered by position
           items:
-            $ref: '#/components/schemas/VerificationClaimType'
-          title: Claims
+            $ref: '#/components/schemas/VanityNameserverDTO'
+          title: Nameservers
           type: array
-        deadlines:
-          description: Verification deadlines
+        parent_domain_name:
+          description: Parent domain used as the apex of the vanity NS zone
+          title: Parent Domain Name
+          type: string
+        set_id:
+          description: Stable identifier for the vanity NS set
+          examples:
+          - vns_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^vns_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Set Id
+          type: string
+          x-typeid-prefix: vns
+        soa_rname:
+          description: SOA RNAME used verbatim when creating vanity-branded zones
+          title: Soa Rname
+          type: string
+      required:
+      - set_id
+      - name
+      - parent_domain_name
+      - soa_rname
+      title: VanityNameserverSetDTO
+      type: object
+    VanityNameserverSetStatusDTO:
+      description: "Wire mirror of `VanityNameserverSetStatus` \u2014 local so dns_client\
+        \ doesn't\npull schema imports."
+      enum:
+      - provisioning
+      - active
+      - suspended
+      - failed
+      - deleting
+      title: VanityNameserverSetStatusDTO
+      type: string
+    VanityNameserverSetSummaryDTO:
+      description: 'Status-aware variant of `VanityNameserverSetDTO` for list/get
+        endpoints.
+
+        `VanityNameserverSetDTO` stays the brandable-only read shape (always ACTIVE).'
+      properties:
+        is_default:
+          description: Whether this is the org's default vanity NS set
+          title: Is Default
+          type: boolean
+        name:
+          description: Human-readable name for the vanity NS set
+          title: Name
+          type: string
+        nameservers:
+          description: Nameservers in the set, ordered by position
           items:
-            $ref: '#/components/schemas/VerificationDeadline'
-          title: Deadlines
+            $ref: '#/components/schemas/VanityNameserverDTO'
+          title: Nameservers
           type: array
+        organization_id:
+          description: Owning organization
+          examples:
+          - organization_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Organization Id
+          type: string
+          x-typeid-prefix: organization
+        parent_domain_name:
+          description: Parent domain used as the apex of the vanity NS zone
+          title: Parent Domain Name
+          type: string
+        set_id:
+          description: Stable identifier for the vanity NS set
+          examples:
+          - vns_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^vns_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Set Id
+          type: string
+          x-typeid-prefix: vns
+        soa_rname:
+          description: SOA RNAME used verbatim when creating vanity-branded zones
+          title: Soa Rname
+          type: string
+        status:
+          $ref: '#/components/schemas/VanityNameserverSetStatusDTO'
+          description: Lifecycle status of the set
       required:
-      - claims
-      title: VerificationResponse
+      - set_id
+      - organization_id
+      - name
+      - parent_domain_name
+      - soa_rname
+      - status
+      - is_default
+      title: VanityNameserverSetSummaryDTO
       type: object
-    VerificationType:
+    VanityNsCheckConfidence:
       enum:
-      - api
-      - email
-      title: VerificationType
+      - authoritative
+      - best_effort
+      title: VanityNsCheckConfidence
       type: string
-    VisitsByKeyBucket:
+    VanityNsCheckPublicReq:
+      description: 'Public `/check` request body. The owning org comes from auth context,
+        so only
+
+        the set identifier is accepted here.'
       properties:
-        key:
-          title: Key
+        set_id:
+          description: The vanity NS set to diagnose
+          examples:
+          - vns_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^vns_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Set Id
           type: string
-        total:
-          title: Total
-          type: integer
-        unique:
-          title: Unique
-          type: integer
+          x-typeid-prefix: vns
       required:
-      - key
-      - total
-      - unique
-      title: VisitsByKeyBucket
+      - set_id
+      title: VanityNsCheckPublicReq
       type: object
-    WhoisBase:
+    VanityNsCheckRes:
       properties:
-        whois_server:
-          anyOf:
-          - type: string
-          - type: 'null'
-          description: WHOIS server
-          title: Whois Server
-      title: WhoisBase
-      type: object
-    ZoneIncludeField:
-      enum:
-      - tags
-      title: ZoneIncludeField
-      type: string
-    ZoneSortField:
+        checks:
+          description: Individual diagnostic checks
+          items:
+            $ref: '#/components/schemas/VanityNsCheckResultDTO'
+          title: Checks
+          type: array
+        parent_domain_name:
+          description: Parent domain of the set's vanity NS hostnames
+          title: Parent Domain Name
+          type: string
+        set_id:
+          description: The diagnosed set
+          examples:
+          - vns_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^vns_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Set Id
+          type: string
+          x-typeid-prefix: vns
+        status:
+          $ref: '#/components/schemas/VanityNameserverSetStatusDTO'
+          description: Lifecycle status of the set at check time
+        summary:
+          $ref: '#/components/schemas/VanityNsCheckSummaryDTO'
+          description: Synthesized overall verdict
+      required:
+      - set_id
+      - parent_domain_name
+      - status
+      - summary
+      title: VanityNsCheckRes
+      type: object
+    VanityNsCheckResultDTO:
+      properties:
+        confidence:
+          $ref: '#/components/schemas/VanityNsCheckConfidence'
+          description: How authoritative the observation is
+        detail:
+          description: Customer-facing explanation of the result
+          title: Detail
+          type: string
+        id:
+          description: Stable identifier for the individual check
+          title: Id
+          type: string
+        label:
+          description: Human-readable check name
+          title: Label
+          type: string
+        observed:
+          anyOf:
+          - additionalProperties: true
+            type: object
+          - type: 'null'
+          description: Structured observation (e.g. addresses seen, mismatches) for
+            the customer
+          title: Observed
+        remediation:
+          anyOf:
+          - type: string
+          - type: 'null'
+          description: Suggested next step when the check did not pass
+          title: Remediation
+        severity:
+          $ref: '#/components/schemas/VanityNsCheckSeverity'
+          description: How much this check matters to the overall verdict
+        source:
+          $ref: '#/components/schemas/VanityNsCheckSource'
+          description: Where the observation came from
+        status:
+          $ref: '#/components/schemas/VanityNsCheckStatus'
+          description: Per-check verdict
+      required:
+      - id
+      - label
+      - status
+      - severity
+      - source
+      - confidence
+      - detail
+      title: VanityNsCheckResultDTO
+      type: object
+    VanityNsCheckSeverity:
+      enum:
+      - required
+      - recommended
+      - optional
+      title: VanityNsCheckSeverity
+      type: string
+    VanityNsCheckSource:
+      enum:
+      - public_dns
+      - authoritative_dns
+      - registry_epp
+      title: VanityNsCheckSource
+      type: string
+    VanityNsCheckStatus:
+      enum:
+      - pass
+      - fail
+      - warn
+      - info
+      title: VanityNsCheckStatus
+      type: string
+    VanityNsCheckSummaryDTO:
+      properties:
+        detail:
+          description: Customer-facing summary of the overall verdict
+          title: Detail
+          type: string
+        state:
+          $ref: '#/components/schemas/VanityNsCheckSummaryState'
+          description: Overall verdict synthesized from the checks
+      required:
+      - state
+      - detail
+      title: VanityNsCheckSummaryDTO
+      type: object
+    VanityNsCheckSummaryState:
+      description: Top-level verdict synthesized from the individual checks.
+      enum:
+      - ready
+      - propagating
+      - action_required
+      - degraded
+      title: VanityNsCheckSummaryState
+      type: string
+    VerificationClaimType:
+      enum:
+      - name
+      - address
+      - email
+      - phone
+      title: VerificationClaimType
+      type: string
+    VerificationDeadline:
+      properties:
+        date:
+          format: date-time
+          title: Date
+          type: string
+        type:
+          $ref: '#/components/schemas/VerificationDeadlineType'
+      required:
+      - type
+      - date
+      title: VerificationDeadline
+      type: object
+    VerificationDeadlineType:
+      enum:
+      - dedelegation
+      - deletion
+      title: VerificationDeadlineType
+      type: string
+    VerificationRegistrantDetails:
+      properties:
+        contact_id:
+          title: Contact Id
+          type: string
+        email:
+          title: Email
+          type: string
+        name:
+          title: Name
+          type: string
+      required:
+      - contact_id
+      - name
+      - email
+      title: VerificationRegistrantDetails
+      type: object
+    VerificationResponse:
+      properties:
+        claims:
+          description: Verification claims
+          items:
+            $ref: '#/components/schemas/VerificationClaimType'
+          title: Claims
+          type: array
+        deadlines:
+          description: Verification deadlines
+          items:
+            $ref: '#/components/schemas/VerificationDeadline'
+          title: Deadlines
+          type: array
+      required:
+      - claims
+      title: VerificationResponse
+      type: object
+    VerificationType:
+      enum:
+      - api
+      - email
+      title: VerificationType
+      type: string
+    VisitsByKeyBucket:
+      properties:
+        key:
+          title: Key
+          type: string
+        total:
+          title: Total
+          type: integer
+        unique:
+          title: Unique
+          type: integer
+      required:
+      - key
+      - total
+      - unique
+      title: VisitsByKeyBucket
+      type: object
+    WhoisBase:
+      properties:
+        whois_server:
+          anyOf:
+          - type: string
+          - type: 'null'
+          description: WHOIS server
+          title: Whois Server
+      title: WhoisBase
+      type: object
+    ZoneIncludeField:
+      enum:
+      - tags
+      title: ZoneIncludeField
+      type: string
+    ZoneSortField:
       enum:
       - name
       - created_on
@@ -12545,6 +13036,23 @@ components:
       - dnssec_status
       title: ZoneSortField
       type: string
+    ZoneVanitySetUpdate:
+      description: Public request body for assigning/clearing a zone's vanity NS branding.
+      properties:
+        vanity_nameserver_set_id:
+          anyOf:
+          - examples:
+            - vns_01h45ytscbebyvny4gc8cr8ma2
+            format: typeid
+            pattern: ^vns_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+            type: string
+            x-typeid-prefix: vns
+          - type: 'null'
+          description: Vanity NS set to brand the zone's apex NS + SOA with, or null
+            to unassign and restamp the apex back to OpusDNS system defaults.
+          title: Vanity Nameserver Set Id
+      title: ZoneVanitySetUpdate
+      type: object
     api__domain__tld_specific__be__models__RequestAuthcodeResponse:
       properties:
         detail:
@@ -12735,7 +13243,7 @@ info:
     \n\n"
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-06-22-103725
+  version: 2026-06-22-124913
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -17563,6 +18071,58 @@ paths:
       - dns
       x-required-permissions:
       - dns:manage
+  /v1/dns/{zone_name}/vanity-set:
+    patch:
+      operationId: update_zone_vanity_set_v1_dns__zone_name__vanity_set_patch
+      parameters:
+      - description: DNS zone name (trailing dot optional)
+        in: path
+        name: zone_name
+        required: true
+        schema:
+          description: DNS zone name (trailing dot optional)
+          title: Zone Name
+          type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/ZoneVanitySetUpdate'
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/DnsZoneVanitySetUpdateRes'
+          description: Successful Response
+        '400':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_DNS
+                detail: Additional error context.
+                status: 400
+                title: DNS Error
+                type: dns
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Bad Request
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      - APIKeyHeader: []
+      summary: Assign or clear a zone's vanity nameserver set
+      tags:
+      - dns
+      x-required-permissions:
+      - dns:manage
+      - vanity_ns:manage
   /v1/domain-forwards:
     get:
       description: Retrieves a paginated list of domain forwards by hostname for the
@@ -27754,6 +28314,450 @@ paths:
       summary: Set user role
       tags:
       - user
+  /v1/vanity-nameserver-sets:
+    get:
+      operationId: list_vanity_nameserver_sets_v1_vanity_nameserver_sets_get
+      parameters:
+      - in: query
+        name: page
+        required: false
+        schema:
+          default: 1
+          minimum: 1
+          title: Page
+          type: integer
+      - in: query
+        name: page_size
+        required: false
+        schema:
+          default: 10
+          maximum: 1000
+          minimum: 1
+          title: Page Size
+          type: integer
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ListVanityNameserverSetsRes'
+          description: Successful Response
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      - APIKeyHeader: []
+      summary: List vanity nameserver sets
+      tags:
+      - nameserver
+      x-required-permissions:
+      - vanity_ns:read
+    post:
+      operationId: create_vanity_nameserver_set_v1_vanity_nameserver_sets_post
+      requestBody:
+        content:
+          application/json:
+            examples:
+              three_nameservers:
+                description: A set with three branded hostnames under a different
+                  parent domain.
+                summary: Three-nameserver set
+                value:
+                  hostnames:
+                  - ns1.acme.example
+                  - ns2.acme.example
+                  - ns3.acme.example
+                  name: Acme nameservers
+                  parent_domain_name: acme.example
+                  soa_rname: hostmaster.acme.example
+              two_nameservers:
+                description: Create a vanity NS set with two branded hostnames under
+                  example.com.
+                summary: Two-nameserver set
+                value:
+                  hostnames:
+                  - ns1.example.com
+                  - ns2.example.com
+                  name: Example brand nameservers
+                  parent_domain_name: example.com
+                  soa_rname: hostmaster.example.com
+            schema:
+              $ref: '#/components/schemas/VanityNameserverSetCreate'
+        required: true
+      responses:
+        '202':
+          content:
+            application/json:
+              examples:
+                provisioning:
+                  description: The set is accepted and activates once its prerequisites
+                    check out.
+                  summary: Newly created set (provisioning)
+                  value:
+                    is_default: false
+                    name: Example brand nameservers
+                    nameservers:
+                    - hostname: ns1.example.com
+                      position: 0
+                    - hostname: ns2.example.com
+                      position: 1
+                    organization_id: organization_01kvn2kr34e9ts01z1330tkvfx
+                    parent_domain_name: example.com
+                    set_id: vns_01kvn2kr1qep2bd7e60tt65fxn
+                    soa_rname: hostmaster.example.com
+                    status: provisioning
+              schema:
+                $ref: '#/components/schemas/VanityNameserverSetSummaryDTO'
+          description: The set was accepted and is provisioning asynchronously.
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      - APIKeyHeader: []
+      summary: Create a vanity nameserver set
+      tags:
+      - nameserver
+      x-required-permissions:
+      - vanity_ns:manage
+  /v1/vanity-nameserver-sets/check:
+    post:
+      operationId: check_vanity_nameserver_set_v1_vanity_nameserver_sets_check_post
+      requestBody:
+        content:
+          application/json:
+            examples:
+              by_set_id:
+                description: Run the read-only diagnostic for a vanity NS set by its
+                  set_id.
+                summary: Diagnose a set
+                value:
+                  set_id: vns_01kvn2kr1qep2bd7e60tt65fxn
+            schema:
+              $ref: '#/components/schemas/VanityNsCheckPublicReq'
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              examples:
+                action_required:
+                  description: An externally-registered parent domain whose nameserver
+                    A/AAAA records are not yet in place.
+                  summary: "Action required \u2014 records not yet published"
+                  value:
+                    checks:
+                    - confidence: authoritative
+                      detail: Vanity NS hostnames are not yet resolving to the assigned
+                        anycast addresses.
+                      id: ns_a_records
+                      label: Nameserver A/AAAA records
+                      observed:
+                        required_records:
+                          A:
+                          - 192.174.68.145
+                          - 176.97.158.145
+                          AAAA:
+                          - 2001:67c:1bc::145
+                          - 2001:67c:10b8::145
+                      remediation: Publish A (and AAAA) records for each nameserver
+                        hostname pointing at the addresses in required_records.
+                      severity: required
+                      source: public_dns
+                      status: fail
+                    parent_domain_name: example.com
+                    set_id: vns_01kvn2kr1qep2bd7e60tt65fxn
+                    status: provisioning
+                    summary:
+                      detail: Nameserver A/AAAA records are not yet published for
+                        ns1.example.com, ns2.example.com.
+                      state: action_required
+                ready:
+                  description: The vanity nameservers resolve and glue is in place.
+                  summary: "Ready \u2014 all checks pass"
+                  value:
+                    checks:
+                    - confidence: authoritative
+                      detail: All nameserver hostnames resolve to the assigned anycast
+                        addresses.
+                      id: ns_a_records
+                      label: Nameserver A/AAAA records
+                      observed:
+                        required_records:
+                          A:
+                          - 192.174.68.145
+                          - 176.97.158.145
+                          AAAA:
+                          - 2001:67c:1bc::145
+                          - 2001:67c:10b8::145
+                      severity: required
+                      source: public_dns
+                      status: pass
+                    - confidence: authoritative
+                      detail: Every nameserver is registered as a host object at the
+                        registry.
+                      id: registry_glue_registered
+                      label: Glue registered at registry
+                      severity: recommended
+                      source: registry_epp
+                      status: pass
+                    - confidence: best_effort
+                      detail: The parent zone publishes glue for every nameserver.
+                      id: registry_glue_visible
+                      label: Glue visible in parent zone
+                      severity: recommended
+                      source: authoritative_dns
+                      status: pass
+                    parent_domain_name: example.com
+                    set_id: vns_01kvn2kr1qep2bd7e60tt65fxn
+                    status: active
+                    summary:
+                      detail: All required checks passed; the vanity nameservers are
+                        live.
+                      state: ready
+              schema:
+                $ref: '#/components/schemas/VanityNsCheckRes'
+          description: Diagnostic report for the set.
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      - APIKeyHeader: []
+      summary: Run a read-only diagnostic on a vanity nameserver set
+      tags:
+      - nameserver
+      x-required-permissions:
+      - vanity_ns:read
+  /v1/vanity-nameserver-sets/default:
+    delete:
+      operationId: clear_vanity_nameserver_set_default_v1_vanity_nameserver_sets_default_delete
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ClearVanityNameserverSetDefaultRes'
+          description: Successful Response
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      - APIKeyHeader: []
+      summary: Unset the organization's default vanity nameserver set
+      tags:
+      - nameserver
+      x-required-permissions:
+      - vanity_ns:manage
+  /v1/vanity-nameserver-sets/{set_id}:
+    delete:
+      operationId: delete_vanity_nameserver_set_v1_vanity_nameserver_sets__set_id__delete
+      parameters:
+      - in: path
+        name: set_id
+        required: true
+        schema:
+          examples:
+          - vns_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^vns_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Set Id
+          type: string
+          x-typeid-prefix: vns
+      responses:
+        '202':
+          content:
+            application/json:
+              schema: {}
+          description: Successful Response
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      - APIKeyHeader: []
+      summary: Delete a vanity nameserver set
+      tags:
+      - nameserver
+      x-required-permissions:
+      - vanity_ns:manage
+    get:
+      operationId: get_vanity_nameserver_set_v1_vanity_nameserver_sets__set_id__get
+      parameters:
+      - in: path
+        name: set_id
+        required: true
+        schema:
+          examples:
+          - vns_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^vns_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Set Id
+          type: string
+          x-typeid-prefix: vns
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/VanityNameserverSetSummaryDTO'
+          description: Successful Response
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      - APIKeyHeader: []
+      summary: Get a vanity nameserver set
+      tags:
+      - nameserver
+      x-required-permissions:
+      - vanity_ns:read
+  /v1/vanity-nameserver-sets/{set_id}/default:
+    patch:
+      operationId: set_vanity_nameserver_set_default_v1_vanity_nameserver_sets__set_id__default_patch
+      parameters:
+      - in: path
+        name: set_id
+        required: true
+        schema:
+          examples:
+          - vns_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^vns_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Set Id
+          type: string
+          x-typeid-prefix: vns
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/SetVanityNameserverSetDefaultRes'
+          description: Successful Response
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      - APIKeyHeader: []
+      summary: Set a vanity nameserver set as the org default
+      tags:
+      - nameserver
+      x-required-permissions:
+      - vanity_ns:manage
+  /v1/vanity-nameserver-sets/{set_id}/restore:
+    post:
+      operationId: restore_vanity_nameserver_set_v1_vanity_nameserver_sets__set_id__restore_post
+      parameters:
+      - in: path
+        name: set_id
+        required: true
+        schema:
+          examples:
+          - vns_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^vns_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Set Id
+          type: string
+          x-typeid-prefix: vns
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/VanityNameserverSetSummaryDTO'
+          description: Successful Response
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      - APIKeyHeader: []
+      summary: Restore a suspended vanity nameserver set
+      tags:
+      - nameserver
+      x-required-permissions:
+      - vanity_ns:manage
+  /v1/vanity-nameserver-sets/{set_id}/zones:
+    get:
+      operationId: list_zones_referencing_vanity_nameserver_set_v1_vanity_nameserver_sets__set_id__zones_get
+      parameters:
+      - in: path
+        name: set_id
+        required: true
+        schema:
+          examples:
+          - vns_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^vns_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Set Id
+          type: string
+          x-typeid-prefix: vns
+      - in: query
+        name: page
+        required: false
+        schema:
+          default: 1
+          minimum: 1
+          title: Page
+          type: integer
+      - in: query
+        name: page_size
+        required: false
+        schema:
+          default: 10
+          maximum: 1000
+          minimum: 1
+          title: Page Size
+          type: integer
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ListZonesReferencingSetRes'
+          description: Successful Response
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      - APIKeyHeader: []
+      summary: List DNS zones referencing a vanity nameserver set
+      tags:
+      - nameserver
+      x-required-permissions:
+      - vanity_ns:read
 servers:
 - description: Production environment
   url: https://api.opusdns.com
@@ -28266,6 +29270,7 @@ x-tagGroups:
 - name: Services
   tags:
   - dns
+  - nameserver
   - email_forward
   - domain_forward
   - parking