Batch Change Model

Table of Contents

• Batch Change Information
• Batch Change Attributes
• Single Change Attributes
• Batch Change Example

BATCH CHANGE INFORMATION

Batch change is an alternative to submitting individual RecordSet changes and provides the following:

• The ability to accept multiple changes in a single API call.
• The ability to include records of multiple record types across multiple zones.
• Input names are entered as fully-qualified domain names (or IP addresses for PTR records), so users don’t have to think in record/zone context.
• All record validations are processed simultaneously. Fatal errors for any change in the batch will result in a 400 response and none will be applied.
• Support for manual review if enabled in your VinylDNS instance. Batch change will remain in limbo until a system administrator (ie. support or super user) either rejects it resulting in an immediate failure or approves it resulting in revalidation and submission for processing.
• Support for notifications when a batch change is rejected or implemented.

A batch change consists of multiple single changes which can be a combination of SingleAddChanges and SingleDeleteRRSetChanges.

Note: In the portal batch change is referred to as DNS Change.

To update an existing record, you must delete the record first and add the record again with the updated changes.

Batch changes are also susceptible to the following restrictions:

• Current supported record types for batch change are: A, AAAA, CNAME, and PTR.
• Batch change requests must contain at least one change.
• The maximum number of single changes within a batch change depends on the instance of VinylDNS. Contact your VinylDNS administrators to find the batch change limit for your instance.
• Access permissions will follow existing rules (admin group or ACL access). Note that an update (delete and add of the same record name, zone and record type combination) requires Write access.

BATCH CHANGE ATTRIBUTES

SINGLE CHANGE ATTRIBUTES

A successful batch change response consists of a corresponding SingleAddChange or SingleDeleteRRSetChange for each batch change input. See the batch change create page for details on constructing a batch change request.

SingleAddChange

SingleDeleteRRSetChange

ChangeType Values

There are two valid changeTypes for a SingleChange: Add and DeleteRecordSet

changeTypes can be used independently or combined to achieve the desired behavior described below.

• Create a new DNS record: Add with record data
• Delete an entire record set: 1. DeleteRecordSet without specifying existing record data or 2. DeleteRecordSet for each entry of the DNS record
• Delete a single entry from DNS record with multiple entries: DeleteRecordSet specifying existing record data
• Update an existing record set: 1. DeleteRecordSet specifying existing record data (single entry delete) or not specifying record data (full delete) and 2. Add with record data

BATCH CHANGE EXAMPLE

Successful batch change response example with a SingleAddChange and a SingleDeleteRRSetChange.

{
    "userId": "vinyl", 
    "userName": "vinyl201", 
    "comments": "this is optional", 
    "createdTimestamp": "2018-05-08T18:46:34Z", 
    "ownerGroupId": "f42385e4-5675-38c0-b42f-64105e743bfe"
    "changes": [
        {
            "changeType": "Add",
            "inputName": "recordName.zoneName.", 
            "type": "A", 
            "ttl": 3600,  
            "record": {
                "address": "1.1.1.1"
            },
            "status": "Complete", 
            "recordName": "recordName", 
            "zoneName": "zoneName.", 
            "zoneId": "8f8f649f-998e-4428-a029-b4ba5f5bd4ca",
            "recordChangeId": "4754ac4c-5f81-11e8-9c2d-fa7ae01bbebc",
            "recordSetId": "4754b084-5f81-11e8-9c2d-fa7ae01bbebc",
            "validationErrors": [],
            "id": "17350028-b2b8-428d-9f10-dbb518a0364d"
        }, 
        {
            "changeType": "DeleteRecordSet",
            "inputName": "recordName.zoneName.", 
            "type": "AAAA", 
            "status": "Complete", 
            "recordName": "recordName", 
            "zoneName": "zoneName.", 
            "zoneId": "9cbdd3ac-9752-4d56-9ca0-6a1a14fc5562",
            "recordChangeId": "4754b322-5f81-11e8-9c2d-fa7ae01bbebc",
            "recordSetId": "4754b084-5f81-11e8-9c2d-fa7ae01bbebc",
            "validationErrors": [],
            "id": "c29d33e4-9bee-4417-a99b-6e815fdeb748"
        },
        {
            "changeType": "DeleteRecordSet",
            "inputName": "anotherRecordName.zoneName.",
            "type": "A",
            "record": {
                "address": "1.1.1.1"
            },
            "status": "Complete",
            "recordName": "recordName",
            "zoneName": "zoneName.",
            "zoneId": "9cbdd3ac-9752-4d56-9ca0-6a1a14fc5562",
            "recordChangeId": "9c449026-cffe-4379-beb7-217b8a31aadd",
            "recordSetId": "e68776ab-f56f-41bf-a03e-c288b9469b53",
            "validationErrors": [],
            "id": "e68776ab-f56f-41bf-a03e-c288b9469b53"
        }
    ], 
    "status": "Complete", 
    "id": "937191c4-b1fd-4ab5-abb4-9553a65b44ab",
    "approvalStatus": "AutoApproved"
}