mirror of
https://github.com/VinylDNS/vinyldns
synced 2025-08-24 11:07:11 +00:00
334 lines
38 KiB
HTML
334 lines
38 KiB
HTML
|
<!DOCTYPE html><html><head><title>VinylDNS: Create Batch Change</title><meta charset="utf-8" /><meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" /><meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="VinylDNS" /><meta name="description" content="DNS Automation and Governance" /><meta name="og:image" content="/img/poster.png" /><meta name="image" property="og:image" content="/img/poster.png" /><meta name="og:title" content="VinylDNS: Create Batch Change" /><meta name="title" property="og:title" content="VinylDNS: Create Batch Change" /><meta name="og:site_name" content="VinylDNS" /><meta name="og:url" content="https://vinyldns.io" /><meta name="og:type" content="website" /><meta name="og:description" content="DNS Automation and Governance" /><link rel="icon" type="image/png" href="/img/favicon.png" /><meta name="twitter:title" content="VinylDNS: Create Batch Change" /><meta name="twitter:image" content="/img/poster.png" /><meta name="twitter:description" content="DNS Automation and Governance" /><meta name="twitter:card" content="summary_large_image" /><meta name="twitter:site" content="@vinyldns_oss" /><meta name="twitter:creator" content="@vinyldns_oss" /><link rel="icon" type="image/png" sizes="16x16" href="/img/favicon16x16.png" /><link rel="icon" type="image/png" sizes="32x32" href="/img/favicon32x32.png" /><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css" /><link rel="stylesheet" href="/highlight/styles/hybrid.css" /><link rel="stylesheet" href="/css/light-style.css" /><link rel="stylesheet" href="/css/custom.css" /></head><body class="docs"><div id="wrapper"><div id="sidebar-wrapper"><div id="sidebar-brand"><a href="/" class="brand"><div class="brand-wrapper"></div><span>VinylDNS</span></a><button id="main-toggle" class="sidebar-toggle"><span class="close"></span></button></div><div class="sidebar-nav"> <div class="sidebar-nav-item "><a href="/api/index.html" title="API documentation" class="">API documentation</a></div> <div class="sidebar-nav-item "><a href="/api/auth-mechanism.html" title="Authentication" class="">Authentication</a></div> <div class="sidebar-nav-item "><a href="/api/zone-model.html" title="Zone" class="drop-nested">Zone</a><i class="fa fa-angle-right"></i><div class="sub-section"> <a href="/api/zone-model.html" title="Zone Model" class="">Zone Model</a> <a href="/api/create-zone.html" title="Create Zone" class="">Create Zone</a> <a href="/api/update-zone.html" title="Update Zone" class="">Update Zone</a> <a href="/api/delete-zone.html" title="Delete Zone" class="">Delete Zone</a> <a href="/api/get-zone-by-id.html" title="Get Zone by ID" class="">Get Zone by ID</a> <a href="/api/get-zone-by-name.html" title="Get Zone by Name" class="">Get Zone by Name</a> <a href="/api/list-zones.html" title="List / Search Zone" class="">List / Search Zone</a> <a href="/api/sync-zone.html" title="Sync Zone" class="">Sync Zone</a> <a href="/api/list-zone-changes.html" title="List Zone Changes" class="">List Zone Changes</a> <a href="/api/list-zone-change-failures.html" title="List Zone Change Failures" class="">List Zone Change Failures</a> <a href="/api/list-deleted-zones.html" title="Abandoned Zones" class="">Abandoned Zones</a></div></div> <div class="sidebar-nav-item "><a href="/api/recordset-model.html" title="RecordSet" class="drop-nested">RecordSet</a><i class="fa fa-angle-right"></i><div class="sub-section"> <a href="/api/recordset-model.html" title="RecordSet Model" class="">RecordSet Model</a> <a href="/api/create-recordset.html" title="Create RecordSet" class="">Create RecordSet</a> <a href="/api/update-recordset.html" title="Update RecordSet" class="">Update RecordSet</a> <a href="/api/delete-recordset.html" title="Delete RecordSet" class="">Delete RecordSet</a> <a href="/api/get-recordset.html" title="Get RecordSet" class="">Get RecordSet</a> <a href="/api/list-recordsets-by-zone.html" title="List / Search RecordSets by Zone" class="">List / Search RecordSets by Zo
|
||
|
|
|
||
|
|
<p>Creates a batch change with <a href="batchchange-model.html#singleaddchange-attributes">SingleAddChanges</a> and/or <a href="batchchange-model.html#singledeleterrsetchange-attributes">SingleDeleteRRSetChanges</a> across different zones. A delete and add of the same record will be treated as an update on that record set. Regardless of the input order in the batch change, all deletes for the same recordset will be logically applied before the adds.</p>
|
||
|
|
|
||
|
|
<p>Current supported record types for creating a batch change are: <code class="language-plaintext highlighter-rouge">A</code>, <code class="language-plaintext highlighter-rouge">AAAA</code>, <code class="language-plaintext highlighter-rouge">CNAME</code>, <code class="language-plaintext highlighter-rouge">MX</code>, <code class="language-plaintext highlighter-rouge">PTR</code>, <code class="language-plaintext highlighter-rouge">TXT</code>. A batch must contain at least one change and no more than 20 changes.
|
||
|
|
Supported record types for records in shared zones may vary. Contact your VinylDNS administrators to find the allowed record types.
|
||
|
|
This does not apply to zone administrators or users with specific ACL access rules.</p>
|
||
|
|
|
||
|
|
<h4 id="http-request">HTTP REQUEST</h4>
|
||
|
|
|
||
|
|
<blockquote>
|
||
|
|
<p>POST /zones/batchrecordchanges?allowManualReview={true | false}</p>
|
||
|
|
</blockquote>
|
||
|
|
|
||
|
|
<p>Note that the batch change request inputs are a subset of the full <a href="batchchange-model.html#batchchange-attributes">batch change model</a>.</p>
|
||
|
|
|
||
|
|
<h4 id="http-request-params">HTTP REQUEST PARAMS</h4>
|
||
|
|
|
||
|
|
<table>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>name</th>
|
||
|
|
<th style="text-align: left">type</th>
|
||
|
|
<th>required?</th>
|
||
|
|
<th style="text-align: left">description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td>comments</td>
|
||
|
|
<td style="text-align: left">string</td>
|
||
|
|
<td>no</td>
|
||
|
|
<td style="text-align: left">Optional comments about the batch change.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>changes</td>
|
||
|
|
<td style="text-align: left">Array of ChangeInput</td>
|
||
|
|
<td>yes</td>
|
||
|
|
<td style="text-align: left">Set of <em>ChangeInput</em>s in the batch change. A <em>ChangeInput</em> is an <a href="#addchangeinput-attributes">AddChangeInput</a> or <a href="#deletechangeinput-attributes">DeleteChangeInput</a>. Type is inferred from specified <em>changeType</em>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>ownerGroupId</td>
|
||
|
|
<td style="text-align: left">string</td>
|
||
|
|
<td>sometimes</td>
|
||
|
|
<td style="text-align: left">Record ownership assignment. Required if any records in the batch change are in <a href="zone-model.html#shared-zones">shared zones</a> and are new or unowned.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>scheduledTime</td>
|
||
|
|
<td style="text-align: left">date-time</td>
|
||
|
|
<td>no</td>
|
||
|
|
<td style="text-align: left">Optional datetime. Stored as UTC. Batch change will not be processed until after the scheduled time. Required format is an ISO 8601 date time string.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>allowManualReview</td>
|
||
|
|
<td style="text-align: left">boolean</td>
|
||
|
|
<td>no</td>
|
||
|
|
<td style="text-align: left">Optional override to control whether manual review is enabled for the batch change request. Default value is <code class="language-plaintext highlighter-rouge">true</code>. Must be passed in as a query parameter, not in the request body.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<h5 id="addchangeinput-">AddChangeInput <a id="addchangeinput-attributes"></a></h5>
|
||
|
|
|
||
|
|
<table>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>name</th>
|
||
|
|
<th style="text-align: left">type</th>
|
||
|
|
<th>required?</th>
|
||
|
|
<th style="text-align: left">description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td>changeType</td>
|
||
|
|
<td style="text-align: left">ChangeInputType</td>
|
||
|
|
<td>yes</td>
|
||
|
|
<td style="text-align: left">Type of change input. Must be set to <strong>Add</strong> for <em>AddChangeInput</em>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>inputName</td>
|
||
|
|
<td style="text-align: left">string</td>
|
||
|
|
<td>yes</td>
|
||
|
|
<td style="text-align: left">The fully qualified domain name of the record being added. For <code class="language-plaintext highlighter-rouge">PTR</code>, the input name is a valid IPv4 or IPv6 address.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>type</td>
|
||
|
|
<td style="text-align: left">RecordType</td>
|
||
|
|
<td>yes</td>
|
||
|
|
<td style="text-align: left">Type of DNS record. Supported records for batch changes are currently: <code class="language-plaintext highlighter-rouge">A</code>, <code class="language-plaintext highlighter-rouge">AAAA</code>, <code class="language-plaintext highlighter-rouge">CNAME</code>, and <code class="language-plaintext highlighter-rouge">PTR</code>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>ttl</td>
|
||
|
|
<td style="text-align: left">long</td>
|
||
|
|
<td>no</td>
|
||
|
|
<td style="text-align: left">The time-to-live in seconds. The minimum and maximum values are 30 and 2147483647, respectively. If excluded, this will be set to the system default for new adds, or the existing TTL for updates</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>record</td>
|
||
|
|
<td style="text-align: left"><a href="recordset-model.html#record-data">RecordData</a></td>
|
||
|
|
<td>yes</td>
|
||
|
|
<td style="text-align: left">The data for the record.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<h5 id="deletechangeinput-">DeleteChangeInput <a id="deletechangeinput-attributes"></a></h5>
|
||
|
|
|
||
|
|
<table>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>name</th>
|
||
|
|
<th style="text-align: left">type</th>
|
||
|
|
<th>required?</th>
|
||
|
|
<th style="text-align: left">description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td>changeType</td>
|
||
|
|
<td style="text-align: left">ChangeInputType</td>
|
||
|
|
<td>yes</td>
|
||
|
|
<td style="text-align: left">Type of change input. Must be <strong>DeleteRecordSet</strong> for <em>DeleteChangeInput</em>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>inputName</td>
|
||
|
|
<td style="text-align: left">string</td>
|
||
|
|
<td>yes</td>
|
||
|
|
<td style="text-align: left">The fully qualified domain name of the record being deleted.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>type</td>
|
||
|
|
<td style="text-align: left">RecordType</td>
|
||
|
|
<td>yes</td>
|
||
|
|
<td style="text-align: left">Type of DNS record. Supported records for batch changes are currently: <code class="language-plaintext highlighter-rouge">A</code>, <code class="language-plaintext highlighter-rouge">AAAA</code>, <code class="language-plaintext highlighter-rouge">CNAME</code>, and <code class="language-plaintext highlighter-rouge">PTR</code>.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>record</td>
|
||
|
|
<td style="text-align: left"><a href="recordset-model.html#record-data">RecordData</a></td>
|
||
|
|
<td>no</td>
|
||
|
|
<td style="text-align: left">The data for the record. If specified, only this DNS entry for the existing DNS recordset will be deleted; if unspecified, the entire DNS recordset will be deleted.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<h4 id="example-http-request">EXAMPLE HTTP REQUEST</h4>
|
||
|
|
<div class="language-json highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="p">{</span><span class="w">
|
||
|
|
</span><span class="nl">"comments"</span><span class="p">:</span><span class="w"> </span><span class="s2">"this is optional"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"ownerGroupId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"f42385e4-5675-38c0-b42f-64105e743bfe"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"changes"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||
|
|
</span><span class="p">{</span><span class="w">
|
||
|
|
</span><span class="nl">"inputName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"example.com."</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"changeType"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Add"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"A"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"ttl"</span><span class="p">:</span><span class="w"> </span><span class="mi">3600</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"record"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
|
|
</span><span class="nl">"address"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1.1.1.1"</span><span class="w">
|
||
|
|
</span><span class="p">}</span><span class="w">
|
||
|
|
</span><span class="p">},</span><span class="w">
|
||
|
|
</span><span class="p">{</span><span class="w">
|
||
|
|
</span><span class="nl">"inputName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"192.0.2.195"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"changeType"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Add"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"PTR"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"ttl"</span><span class="p">:</span><span class="w"> </span><span class="mi">3600</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"record"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
|
|
</span><span class="nl">"ptrdname"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ptrdata.data."</span><span class="w">
|
||
|
|
</span><span class="p">}</span><span class="w">
|
||
|
|
</span><span class="p">},</span><span class="w">
|
||
|
|
</span><span class="p">{</span><span class="w">
|
||
|
|
</span><span class="nl">"inputName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"cname.example.com."</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"changeType"</span><span class="p">:</span><span class="w"> </span><span class="s2">"DeleteRecordSet"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"CNAME"</span><span class="w">
|
||
|
|
</span><span class="p">},</span><span class="w">
|
||
|
|
</span><span class="p">{</span><span class="w">
|
||
|
|
</span><span class="nl">"inputName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"update.another.example.com."</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"changeType"</span><span class="p">:</span><span class="w"> </span><span class="s2">"DeleteRecordSet"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"AAAA"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"record"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
|
|
</span><span class="nl">"address"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2:3:4:5:6:7:8:9"</span><span class="w">
|
||
|
|
</span><span class="p">}</span><span class="w">
|
||
|
|
</span><span class="p">},</span><span class="w">
|
||
|
|
</span><span class="p">{</span><span class="w">
|
||
|
|
</span><span class="nl">"inputName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"update.another.example.com."</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"changeType"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Add"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"AAAA"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"ttl"</span><span class="p">:</span><span class="w"> </span><span class="mi">4000</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"record"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
|
|
</span><span class="nl">"address"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1:2:3:4:5:6:7:8"</span><span class="w">
|
||
|
|
</span><span class="p">}</span><span class="w">
|
||
|
|
</span><span class="p">}</span><span class="w">
|
||
|
|
</span><span class="p">]</span><span class="w">
|
||
|
|
</span><span class="p">}</span><span class="w">
|
||
|
|
</span></code></pre></div></div>
|
||
|
|
|
||
|
|
<p>The first two items in the changes list are SingleAddChanges of an <code class="language-plaintext highlighter-rouge">A</code> record and a <code class="language-plaintext highlighter-rouge">PTR</code> record. Note that for the <code class="language-plaintext highlighter-rouge">PTR</code> record, the <em>inputName</em> is a valid IP address. The third item is a delete of a <code class="language-plaintext highlighter-rouge">CNAME</code> record. The last two items represent an update (delete & add) of an <code class="language-plaintext highlighter-rouge">AAAA</code> record with the fully qualified domain name “update.another.example.com.”.</p>
|
||
|
|
|
||
|
|
<h4 id="http-response-types">HTTP RESPONSE TYPES</h4>
|
||
|
|
|
||
|
|
<table>
|
||
|
|
<thead>
|
||
|
|
<tr>
|
||
|
|
<th>Code</th>
|
||
|
|
<th style="text-align: left">description</th>
|
||
|
|
</tr>
|
||
|
|
</thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td>202</td>
|
||
|
|
<td style="text-align: left"><strong>Accepted</strong> - The batch change is validated and is returned in the response body. Based on <code class="language-plaintext highlighter-rouge">status</code>, the batch will either be sent for immediate backend processing (<code class="language-plaintext highlighter-rouge">PendingProcessing</code>) or pending manual review (<code class="language-plaintext highlighter-rouge">PendingReview</code>).</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>400</td>
|
||
|
|
<td style="text-align: left"><strong>Bad Request</strong> - Error in the batch change. See <a href="batchchange-errors.html">Batch Change Errors</a> page.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>403</td>
|
||
|
|
<td style="text-align: left"><strong>Forbidden</strong> - The user does not have the access required to perform the action.</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>413</td>
|
||
|
|
<td style="text-align: left"><strong>Request Entity Too Large</strong> - Cannot request more than <limit> changes in a single batch change request.</limit></td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>422</td>
|
||
|
|
<td style="text-align: left"><strong>Unprocessable Entity</strong> - the batch does not contain any changes, thus cannot be processed.</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<p>A batch change goes through numerous validations before it is processed. This results in corresponding BadRequest or error responses. View the full list of batch change errors <a href="batchchange-errors.html">here</a>.</p>
|
||
|
|
|
||
|
|
<h4 id="http-response-attributes">HTTP RESPONSE ATTRIBUTES</h4>
|
||
|
|
|
||
|
|
<p>On success, the response from create batch change includes the fields the user input, as well as some additional information provided by the system. This response is the same as that of <a href="get-batchchange.html#http-response-attributes">get batch change</a>.</p>
|
||
|
|
|
||
|
|
<h4 id="example-response">EXAMPLE RESPONSE</h4>
|
||
|
|
|
||
|
|
<div class="language-json highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="p">{</span><span class="w">
|
||
|
|
</span><span class="nl">"userId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"vinyl"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"userName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"vinyl201"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"comments"</span><span class="p">:</span><span class="w"> </span><span class="s2">"this is optional"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"createdTimestamp"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2018-05-09T14:19:34Z"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"ownerGroupId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"f42385e4-5675-38c0-b42f-64105e743bfe"</span><span class="w">
|
||
|
|
</span><span class="nl">"changes"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="w">
|
||
|
|
</span><span class="p">{</span><span class="w">
|
||
|
|
</span><span class="nl">"changeType"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Add"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"inputName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"example.com."</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"A"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"ttl"</span><span class="p">:</span><span class="w"> </span><span class="mi">3600</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"record"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
|
|
</span><span class="nl">"address"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1.1.1.1"</span><span class="w">
|
||
|
|
</span><span class="p">},</span><span class="w">
|
||
|
|
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Pending"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"recordName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"example.com."</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"zoneName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"example.com."</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"zoneId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"74e93bfc-7296-4b86-83d3-1ffcb0eb3d13"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"validationErrors"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
||
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"7573ca11-3e30-45a8-9ba5-791f7d6ae7a7"</span><span class="w">
|
||
|
|
</span><span class="p">},</span><span class="w">
|
||
|
|
</span><span class="p">{</span><span class="w">
|
||
|
|
</span><span class="nl">"changeType"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Add"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"inputName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"192.0.2.195"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"PTR"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"ttl"</span><span class="p">:</span><span class="w"> </span><span class="mi">3600</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"record"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
|
|
</span><span class="nl">"ptrdname"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ptrdata.data."</span><span class="w">
|
||
|
|
</span><span class="p">},</span><span class="w">
|
||
|
|
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Pending"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"recordName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"195"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"zoneName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2.0.192.in-addr.arpa."</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"zoneId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"7fd52634-5a0c-11e8-9c2d-fa7ae01bbebc"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"validationErrors"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
||
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"bece5338-5a0c-11e8-9c2d-fa7ae01bbebc"</span><span class="w">
|
||
|
|
</span><span class="p">},</span><span class="w">
|
||
|
|
</span><span class="p">{</span><span class="w">
|
||
|
|
</span><span class="nl">"changeType"</span><span class="p">:</span><span class="w"> </span><span class="s2">"DeleteRecordSet"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"inputName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"cname.example.com."</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"CNAME"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Pending"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"recordName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"cname"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"zoneName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"example.com."</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"zoneId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"74e93bfc-7296-4b86-83d3-1ffcb0eb3d13"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"validationErrors"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
||
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"02048500-5a0d-11e8-a10f-fa7ae01bbebc"</span><span class="w">
|
||
|
|
</span><span class="p">},</span><span class="w">
|
||
|
|
</span><span class="p">{</span><span class="w">
|
||
|
|
</span><span class="nl">"changeType"</span><span class="p">:</span><span class="w"> </span><span class="s2">"DeleteRecordSet"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"inputName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"update.example.com."</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"AAAA"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Pending"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"recordName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"update"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"zoneName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"example.com."</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"zoneId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"74e93bfc-7296-4b86-83d3-1ffcb0eb3d13"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"validationErrors"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
||
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1cee1c78-5a0d-11e8-9c2d-fa7ae01bbebc"</span><span class="w">
|
||
|
|
</span><span class="p">},</span><span class="w">
|
||
|
|
</span><span class="p">{</span><span class="w">
|
||
|
|
</span><span class="nl">"changeType"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Add"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"inputName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"update.another.example.com."</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"type"</span><span class="p">:</span><span class="w"> </span><span class="s2">"AAAA"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"ttl"</span><span class="p">:</span><span class="w"> </span><span class="mi">3600</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"record"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
|
||
|
|
</span><span class="nl">"address"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1:2:3:4:5:6:7:8"</span><span class="w">
|
||
|
|
</span><span class="p">},</span><span class="w">
|
||
|
|
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"Pending"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"recordName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"update"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"zoneName"</span><span class="p">:</span><span class="w"> </span><span class="s2">"another.example.com."</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"zoneId"</span><span class="p">:</span><span class="w"> </span><span class="s2">"7fd52634-5a0c-11e8-9c2d-fa7ae01bbebc"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"validationErrors"</span><span class="p">:</span><span class="w"> </span><span class="p">[],</span><span class="w">
|
||
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"43dd1226-5a0d-11e8-9c2d-fa7ae01bbebc"</span><span class="w">
|
||
|
|
</span><span class="p">}</span><span class="w">
|
||
|
|
</span><span class="p">],</span><span class="w">
|
||
|
|
</span><span class="nl">"status"</span><span class="p">:</span><span class="w"> </span><span class="s2">"PendingProcessing"</span><span class="p">,</span><span class="w">
|
||
|
|
</span><span class="nl">"id"</span><span class="p">:</span><span class="w"> </span><span class="s2">"02bd95f4-a32c-443b-82eb-54dbaa55b31a"</span><span class="w">
|
||
|
|
</span><span class="p">}</span><span class="w">
|
||
|
|
</span></code></pre></div></div>
|
||
|
|
</section><div class="edit-button"><a href="https://github.com/vinyldns/vinyldns/edit/master/modules/docs/src/main/mdoc/api/create-batchchange.md" target="_blank" rel="noopener noreferrer" class="btn-sm btn-info">Improve this page</a></div></div></div></div></div><script src="/highlight/highlight.pack.js"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.10/languages/json.min.js"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.10/languages/yaml.min.js"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.10/languages/bnf.min.js"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.10/languages/plaintext.min.js"></script><script src="/lunr/lunr.js"></script><script>
|
||
|
|
// For all code blocks, copy the language from the containing div
|
||
|
|
// to the inner code tag (where hljs expects it to be)
|
||
|
|
const langPrefix = 'language-';
|
||
|
|
document.querySelectorAll(`div[class^='${langPrefix}']`).forEach(function(div) {
|
||
|
|
div.classList.forEach(function(cssClass) {
|
||
|
|
if (cssClass.startsWith(langPrefix)) {
|
||
|
|
const lang = cssClass.substring(langPrefix.length);
|
||
|
|
div.querySelectorAll('pre code').forEach(function(code) {
|
||
|
|
code.classList.add(lang);
|
||
|
|
});
|
||
|
|
}
|
||
|
|
});
|
||
|
|
});
|
||
|
|
|
||
|
|
hljs.configure({languages:['scala','java','bash','json','yaml','bnf','plaintext']});
|
||
|
|
hljs.initHighlightingOnLoad();
|
||
|
|
</script><script>console.info('\x57\x65\x62\x73\x69\x74\x65\x20\x62\x75\x69\x6c\x74\x20\x77\x69\x74\x68\x3a\x0a\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5f\x5f\x20\x20\x20\x20\x5f\x5f\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5f\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5f\x20\x5f\x5f\x0a\x20\x20\x20\x5f\x5f\x5f\x5f\x5f\x2f\x20\x2f\x5f\x20\x20\x2f\x20\x2f\x5f\x20\x20\x20\x20\x20\x20\x5f\x5f\x5f\x5f\x20\x5f\x5f\x5f\x20\x20\x28\x5f\x29\x5f\x5f\x5f\x5f\x5f\x5f\x5f\x5f\x5f\x5f\x5f\x5f\x5f\x20\x20\x5f\x5f\x5f\x5f\x5f\x28\x5f\x29\x20\x2f\x5f\x5f\x5f\x5f\x20\x20\x5f\x5f\x5f\x5f\x5f\x0a\x20\x20\x2f\x20\x5f\x5f\x5f\x2f\x20\x5f\x5f\x20\x5c\x2f\x20\x5f\x5f\x2f\x5f\x5f\x5f\x5f\x5f\x2f\x20\x5f\x5f\x20\x60\x5f\x5f\x20\x5c\x2f\x20\x2f\x20\x5f\x5f\x5f\x2f\x20\x5f\x5f\x5f\x2f\x20\x5f\x5f\x20\x5c\x2f\x20\x5f\x5f\x5f\x2f\x20\x2f\x20\x5f\x5f\x2f\x20\x5f\x20\x5c\x2f\x20\x5f\x5f\x5f\x2f\x0a\x20\x28\x5f\x5f\x20\x20\x29\x20\x2f\x5f\x2f\x20\x2f\x20\x2f\x5f\x2f\x5f\x5f\x5f\x5f\x5f\x2f\x20\x2f\x20\x2f\x20\x2f\x20\x2f\x20\x2f\x20\x2f\x20\x2f\x5f\x5f\x2f\x20\x2f\x20\x20\x2f\x20\x2f\x5f\x2f\x20\x28\x5f\x5f\x20\x20\x29\x20\x2f\x20\x2f\x5f\x2f\x20\x20\x5f\x5f\x28\x5f\x5f\x20\x20\x29\x0a\x2f\x5f\x5f\x5f\x5f\x2f\x5f\x2e\x5f\x5f\x5f\x2f\x5c\x5f\x5f\x2f\x20\x20\x20\x20\x20\x2f\x5f\x2f\x20\x2f\x5f\x2f\x20\x2f\x5f\x2f\x5f\x2f\x5c\x5f\x5f\x5f\x2f\x5f\x2f\x20\x20\x20\x5c\x5f\x5f\x5f\x5f\x2f\x5f\x5f\x5f\x5f\x2f\x5f\x2f\x5c\x5f\x5f\x2f\x5c\x5f\x5f\x5f\x2f\x5f\x5f\x5f\x5f\x2f\x0a\x0a\x68\x74\x74\x70\x73\x3a\x2f\x2f\x34\x37\x64\x65\x67\x2e\x67\x69\x74\x68\x75\x62\x2e\x69\x6f\x2f\x73\x62\x74\x2d\x6d\x69\x63\x72\x6f\x73\x69\x74\x65\x73')</script><script src="/js/search.js"></script><script src="/js/docs.js"></script></body></html>
|