0.9.5
vinyldns-js offers an NPM module for interacting with the VinylDNS API. The VinylDNS class represents the VinylDNS API.
Fetch zones.
(object)
The zone query parameters.
Name | Description |
---|---|
queryOpts.nameFilter string
|
One or more characters contained in the name of a zone to search for. |
queryOpts.startFrom number
|
In order to advance through pages of results, the startFrom is set to the nextId that is returned on the previous response. |
queryOpts.maxItems number
|
The number of items to return in the page. Valid values are 1 - 100. |
Fetch zone changes.
(string)
The zone ID.
(object)
The zone changes query parameters.
Name | Description |
---|---|
queryOpts.startFrom number
|
In order to advance through pages of results, the startFrom is set to the nextId that is returned on the previous response. |
queryOpts.maxItems number
|
The number of items to return in the page. Valid values are 1 - 100. |
Create zone.
(object)
The VinylDNS zone to create. See the
[VinylDNS zone docs]
https://www.vinyldns.io/api/create-zone.html
to learn more.
Update zone.
(object)
The VinylDNS zone to update. See the
[VinylDNS zone docs]
https://www.vinyldns.io/api/update-zone.html
to learn more.
Fetch record sets.
(string)
The ID of the zone in which to query.
(object)
The record sets query parameters.
Name | Description |
---|---|
queryOpts.nameFilter string
|
One or more characters contained in the name of a record set to search for. |
queryOpts.startFrom number
|
In order to advance through pages of results, the startFrom is set to the nextId that is returned on the previous response. |
queryOpts.maxItems number
|
The number of items to return in the page. Valid values are 1 - 100. |
Create record set.
(object)
The VinylDNS record set to create. See the
[VinylDNS record set docs]
https://www.vinyldns.io/api/recordset-model.html
to learn more.
Update record set.
(object)
The VinylDNS record set to update. See the
[VinylDNS record set docs]
https://www.vinyldns.io/api/recordset-model.html
to learn more.
Get record set change.
(string)
The zone ID.
(object)
The request query parameters.
Name | Description |
---|---|
queryOpts.startFrom number
|
In order to advance through pages of results, the startFrom is set to the nextId that is returned on the previous response. |
queryOpts.maxItems number
|
The number of items to return in the page. Valid values are 1 - 100. |
Get batch changes.
(any)
Create batch change.
(object)
The VinylDNS batch change to create. See the
[VinylDNS batch change docs]
https://www.vinyldns.io/api/batchchange-model.html
to learn more.
Get groups.
(any)
Create group.
(object)
The VinylDNS group to create. See the
[VinylDNS group docs]
https://www.vinyldns.io/api/group-model.html
to learn more.
Update group.
(object)
The VinylDNS group to update. See the
[VinylDNS group docs]
https://www.vinyldns.io/api/group-model.html
to learn more.