@opusdns/api 0.270.0 → 0.271.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/src/helpers/keys.ts +2 -3
- package/src/openapi.yaml +51 -36
- package/src/schema.d.ts +3 -3
package/package.json
CHANGED
package/src/helpers/keys.ts
CHANGED
|
@@ -10032,7 +10032,7 @@ export const KEY_DNS_ZONE_UPDATE_BULK_INSTANCE_NAME: keyof DnsZoneUpdateBulkInst
|
|
|
10032
10032
|
/**
|
|
10033
10033
|
* Rrsets
|
|
10034
10034
|
*
|
|
10035
|
-
* Override RRsets for this zone
|
|
10035
|
+
* Override RRsets for this zone. Omit to inherit the template (or leave records unchanged if the template also omits rrsets). Provide an empty list to delete all records.
|
|
10036
10036
|
*
|
|
10037
10037
|
*
|
|
10038
10038
|
*
|
|
@@ -10186,9 +10186,8 @@ export const KEY_DNS_ZONE_UPDATE_BULK_TEMPLATE_DNSSEC_STATUS: keyof DnsZoneUpdat
|
|
|
10186
10186
|
/**
|
|
10187
10187
|
* Rrsets
|
|
10188
10188
|
*
|
|
10189
|
-
* DNS record sets to
|
|
10189
|
+
* DNS record sets to apply to every zone. Omit to leave each zone's RRsets unchanged (useful for bulk DNSSEC toggles). Provide an empty list to delete all records.
|
|
10190
10190
|
*
|
|
10191
|
-
* @type {array}
|
|
10192
10191
|
*
|
|
10193
10192
|
*
|
|
10194
10193
|
* @remarks
|
package/src/openapi.yaml
CHANGED
|
@@ -2345,7 +2345,9 @@ components:
|
|
|
2345
2345
|
$ref: '#/components/schemas/DnsRrsetCreate'
|
|
2346
2346
|
type: array
|
|
2347
2347
|
- type: 'null'
|
|
2348
|
-
description: Override RRsets for this zone
|
|
2348
|
+
description: Override RRsets for this zone. Omit to inherit the template
|
|
2349
|
+
(or leave records unchanged if the template also omits rrsets). Provide
|
|
2350
|
+
an empty list to delete all records.
|
|
2349
2351
|
title: Rrsets
|
|
2350
2352
|
required:
|
|
2351
2353
|
- name
|
|
@@ -2377,11 +2379,15 @@ components:
|
|
|
2377
2379
|
- type: 'null'
|
|
2378
2380
|
description: DNSSEC status for all zones
|
|
2379
2381
|
rrsets:
|
|
2380
|
-
|
|
2381
|
-
items:
|
|
2382
|
-
|
|
2382
|
+
anyOf:
|
|
2383
|
+
- items:
|
|
2384
|
+
$ref: '#/components/schemas/DnsRrsetCreate'
|
|
2385
|
+
type: array
|
|
2386
|
+
- type: 'null'
|
|
2387
|
+
description: DNS record sets to apply to every zone. Omit to leave each
|
|
2388
|
+
zone's RRsets unchanged (useful for bulk DNSSEC toggles). Provide an empty
|
|
2389
|
+
list to delete all records.
|
|
2383
2390
|
title: Rrsets
|
|
2384
|
-
type: array
|
|
2385
2391
|
title: DnsZoneUpdateBulkTemplate
|
|
2386
2392
|
type: object
|
|
2387
2393
|
DnsZoneUpdateCommand:
|
|
@@ -10147,7 +10153,7 @@ info:
|
|
|
10147
10153
|
\n\n"
|
|
10148
10154
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
10149
10155
|
title: OpusDNS API
|
|
10150
|
-
version: 2026-04-
|
|
10156
|
+
version: 2026-04-27-130908
|
|
10151
10157
|
x-logo:
|
|
10152
10158
|
altText: OpusDNS API Reference
|
|
10153
10159
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -22474,7 +22480,12 @@ tags:
|
|
|
22474
22480
|
\ updates. For each zone, whatever rrsets you supply become the zone's rrsets\
|
|
22475
22481
|
\ \u2014 anything not listed is removed. System-managed record types (SOA, DNSKEY,\
|
|
22476
22482
|
\ DS) cannot be set via this command. This is also the command to flip DNSSEC\
|
|
22477
|
-
\ on or off across many zones.\n\
|
|
22483
|
+
\ on or off across many zones.\n\nBoth `rrsets` and `dnssec_status` are partial-update\
|
|
22484
|
+
\ fields:\n\n| Value | Meaning |\n| --- | --- |\n| omitted (in both template and\
|
|
22485
|
+
\ instance) | leave that field unchanged on the zone |\n| `[]` (rrsets only) |\
|
|
22486
|
+
\ delete all records |\n| `[...]` / a status value | replace |\n\nAn instance\
|
|
22487
|
+
\ with neither `rrsets` nor `dnssec_status` (after the template is merged in)\
|
|
22488
|
+
\ is rejected as a no-op.\n\nPayload: `template` (shared `rrsets` and `dnssec_status`)\
|
|
22478
22489
|
\ + `instances[]` (per-zone overrides).\n\n```json\n{\n \"command\": \"dns_zone_update_bulk\"\
|
|
22479
22490
|
,\n \"payload\": {\n \"template\": {\n \"rrsets\": [\n {\"name\"\
|
|
22480
22491
|
: \"@\", \"type\": \"A\", \"ttl\": 300, \"records\": [{\"rdata\": \"203.0.113.10\"\
|
|
@@ -22482,35 +22493,39 @@ tags:
|
|
|
22482
22493
|
: [\n { \"name\": \"example.com\" },\n {\n \"name\": \"example.net\"\
|
|
22483
22494
|
,\n \"rrsets\": [\n {\"name\": \"@\", \"type\": \"A\", \"ttl\"\
|
|
22484
22495
|
: 300, \"records\": [{\"rdata\": \"203.0.113.20\"}]}\n ]\n }\n \
|
|
22485
|
-
\ ]\n }\n}\n```\n\
|
|
22486
|
-
\
|
|
22487
|
-
\
|
|
22488
|
-
\
|
|
22489
|
-
\
|
|
22490
|
-
\
|
|
22491
|
-
|
|
22492
|
-
|
|
22493
|
-
|
|
22494
|
-
|
|
22495
|
-
|
|
22496
|
-
\
|
|
22497
|
-
|
|
22498
|
-
\ \"
|
|
22499
|
-
\
|
|
22500
|
-
\
|
|
22501
|
-
\
|
|
22502
|
-
\
|
|
22503
|
-
\
|
|
22504
|
-
|
|
22505
|
-
\ rrset
|
|
22506
|
-
|
|
22507
|
-
|
|
22508
|
-
|
|
22509
|
-
|
|
22510
|
-
\
|
|
22511
|
-
|
|
22512
|
-
|
|
22513
|
-
\
|
|
22496
|
+
\ ]\n }\n}\n```\n\nBulk-toggle DNSSEC across many zones without touching their\
|
|
22497
|
+
\ records \u2014 omit `rrsets` everywhere:\n\n```json\n{\n \"command\": \"dns_zone_update_bulk\"\
|
|
22498
|
+
,\n \"payload\": {\n \"template\": { \"dnssec_status\": \"enabled\" },\n \
|
|
22499
|
+
\ \"instances\": [\n { \"name\": \"example.com\" },\n { \"name\":\
|
|
22500
|
+
\ \"example.net\" },\n { \"name\": \"example.org\" }\n ]\n }\n}\n```\n\
|
|
22501
|
+
\n#### `dns_zone_patch_rrsets_bulk`\n\nBulk equivalent of `PATCH /v1/dns/{zone_name}/rrsets`.\
|
|
22502
|
+
\ Each instance is `{ zone_name, ops[] }`, where each op targets an rrset by `(name,\
|
|
22503
|
+
\ type)`:\n\n- `op: \"upsert\"` \u2014 create or **replace** the rrset with the\
|
|
22504
|
+
\ records you provide. Any prior records for that `(name, type)` are discarded.\n\
|
|
22505
|
+
- `op: \"remove\"` \u2014 delete the entire rrset (pass `records: []`).\n\n```json\n\
|
|
22506
|
+
{\n \"command\": \"dns_zone_patch_rrsets_bulk\",\n \"payload\": {\n \"instances\"\
|
|
22507
|
+
: [\n {\n \"zone_name\": \"example.com\",\n \"ops\": [\n \
|
|
22508
|
+
\ {\n \"op\": \"upsert\",\n \"rrset\": {\n \
|
|
22509
|
+
\ \"name\": \"www\", \"type\": \"A\", \"ttl\": 300,\n \"records\"\
|
|
22510
|
+
: [\n {\"rdata\": \"203.0.113.10\"},\n {\"rdata\"\
|
|
22511
|
+
: \"203.0.113.11\"}\n ]\n }\n },\n {\n\
|
|
22512
|
+
\ \"op\": \"remove\",\n \"rrset\": {\"name\": \"old\", \"\
|
|
22513
|
+
type\": \"CNAME\", \"ttl\": 300, \"records\": []}\n }\n ]\n \
|
|
22514
|
+
\ }\n ]\n }\n}\n```\n\n#### `dns_zone_patch_records_bulk`\n\nBulk equivalent\
|
|
22515
|
+
\ of `PATCH /v1/dns/{zone_name}/records`. Each instance is `{ zone_name, ops[]\
|
|
22516
|
+
\ }`, where each op targets a single `rdata` value inside an rrset. Note the op\
|
|
22517
|
+
\ payload uses a single `rdata` field, not `records[]`.\n\n- `op: \"upsert\"`\
|
|
22518
|
+
\ \u2014 add or update that one rdata value (creates the rrset if it doesn't exist).\
|
|
22519
|
+
\ Sibling records in the rrset are untouched.\n- `op: \"remove\"` \u2014 remove\
|
|
22520
|
+
\ just that one rdata value. Other records in the rrset remain.\n\n```json\n{\n\
|
|
22521
|
+
\ \"command\": \"dns_zone_patch_records_bulk\",\n \"payload\": {\n \"instances\"\
|
|
22522
|
+
: [\n {\n \"zone_name\": \"example.com\",\n \"ops\": [\n \
|
|
22523
|
+
\ {\n \"op\": \"upsert\",\n \"record\": {\n \
|
|
22524
|
+
\ \"name\": \"@\", \"type\": \"MX\", \"ttl\": 300,\n \"rdata\"\
|
|
22525
|
+
: \"5 new-mail.example.com.\"\n }\n },\n {\n \
|
|
22526
|
+
\ \"op\": \"remove\",\n \"record\": {\n \"name\"\
|
|
22527
|
+
: \"@\", \"type\": \"MX\", \"ttl\": 300,\n \"rdata\": \"10 old-mail.example.com.\"\
|
|
22528
|
+
\n }\n }\n ]\n }\n ]\n }\n}\n```\n"
|
|
22514
22529
|
name: jobs
|
|
22515
22530
|
x-displayName: Jobs
|
|
22516
22531
|
- description: 'Endpoints for creating and managing contacts.
|
package/src/schema.d.ts
CHANGED
|
@@ -3849,7 +3849,7 @@ export interface components {
|
|
|
3849
3849
|
name: string;
|
|
3850
3850
|
/**
|
|
3851
3851
|
* Rrsets
|
|
3852
|
-
* @description Override RRsets for this zone
|
|
3852
|
+
* @description Override RRsets for this zone. Omit to inherit the template (or leave records unchanged if the template also omits rrsets). Provide an empty list to delete all records.
|
|
3853
3853
|
*/
|
|
3854
3854
|
rrsets?: components["schemas"]["DnsRrsetCreate"][] | null;
|
|
3855
3855
|
};
|
|
@@ -3869,9 +3869,9 @@ export interface components {
|
|
|
3869
3869
|
dnssec_status?: components["schemas"]["DnssecStatus"] | null;
|
|
3870
3870
|
/**
|
|
3871
3871
|
* Rrsets
|
|
3872
|
-
* @description DNS record sets to
|
|
3872
|
+
* @description DNS record sets to apply to every zone. Omit to leave each zone's RRsets unchanged (useful for bulk DNSSEC toggles). Provide an empty list to delete all records.
|
|
3873
3873
|
*/
|
|
3874
|
-
rrsets?: components["schemas"]["DnsRrsetCreate"][];
|
|
3874
|
+
rrsets?: components["schemas"]["DnsRrsetCreate"][] | null;
|
|
3875
3875
|
};
|
|
3876
3876
|
/** DnsZoneUpdateCommand */
|
|
3877
3877
|
DnsZoneUpdateCommand: {
|