vinyldns-js 0.9.5 | Documentation

VinylDNS

vinyldns-js offers an NPM module for interacting with the VinylDNS API. The VinylDNS class represents the VinylDNS API.

new VinylDNS(config: object)

Parameters

config (object) The configuration object.

Name	Description
config.apiURL `string`	The VinylDNS API URL. Example: `https://my-vinyldns-api-instance.com` .
config.accessKeyId `string`	The VinylDNS API access key ID.
config.secretAccessKey `string`	The VinylDNS API secret access key.

Instance Members

▸ getZones(queryOpts)

Fetch zones.

getZones(queryOpts: object)

Parameters

queryOpts (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.

▸ getZone(id)

Fetch zone.

getZone(id: string)

Parameters

id (string) The zone ID.

▸ getZoneByName(name)

Fetch zone.

getZoneByName(name: string)

Parameters

name (string) The zone Name.

▸ getZoneChanges(id, queryOpts)

Fetch zone changes.

getZoneChanges(id: string, queryOpts: object)

Parameters

id (string) The zone ID.

queryOpts (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.

▸ syncZone(id)

Sync zone.

syncZone(id: string)

Parameters

id (string) The zone ID.

▸ createZone(zone)

Create zone.

createZone(zone: object)

Parameters

zone (object) The VinylDNS zone to create. See the [VinylDNS zone docs] https://www.vinyldns.io/api/create-zone.html to learn more.

▸ updateZone(zone)

Update zone.

updateZone(zone: object)

Parameters

zone (object) The VinylDNS zone to update. See the [VinylDNS zone docs] https://www.vinyldns.io/api/update-zone.html to learn more.

▸ deleteZone(id)

Delete zone.

deleteZone(id: string)

Parameters

id (string) The zone ID.

▸ getRecordSets(zoneId, queryOpts)

Fetch record sets.

getRecordSets(zoneId: string, queryOpts: object)

Parameters

zoneId (string) The ID of the zone in which to query.

queryOpts (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.

▸ getRecordSet(details)

Fetch record set.

getRecordSet(details: object)

Parameters

details (object) The record set details.

▸ createRecordSet(recordSet)

Create record set.

createRecordSet(recordSet: object)

Parameters

recordSet (object) The VinylDNS record set to create. See the [VinylDNS record set docs] https://www.vinyldns.io/api/recordset-model.html to learn more.

▸ updateRecordSet(recordSet)

Update record set.

updateRecordSet(recordSet: object)

Parameters

recordSet (object) The VinylDNS record set to update. See the [VinylDNS record set docs] https://www.vinyldns.io/api/recordset-model.html to learn more.

▸ deleteRecordSet(details)

Delete record set.

deleteRecordSet(details: object)

Parameters

details (object) The record set details.

Name	Description
details.id `string`	The record set ID.
details.zoneId `string`	The record set zone ID.

▸ getRecordSetChange(details)

Get record set change.

getRecordSetChange(details: object)

Parameters

details (object) The record set details.

Name	Description
details.changeId `string`	The record set change ID.
details.recordSetId `string`	The record set ID.
details.zoneId `string`	The record set change zone ID.

▸ getRecordSetChanges(zoneId, queryOpts)

Get record set change.

getRecordSetChanges(zoneId: string, queryOpts: object)

Parameters

zoneId (string) The zone ID.

queryOpts (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.

▸ getBatchChanges(queryOpts)

Get batch changes.

getBatchChanges(queryOpts: any)

Parameters

queryOpts (any)

▸ getBatchChange(id)

Get batch change.

getBatchChange(id: string)

Parameters

id (string) The batch change ID.

▸ createBatchChange(batchChange)

Create batch change.

createBatchChange(batchChange: object)

Parameters

batchChange (object) The VinylDNS batch change to create. See the [VinylDNS batch change docs] https://www.vinyldns.io/api/batchchange-model.html to learn more.

▸ getGroups(queryOpts)

Get groups.

getGroups(queryOpts: any)

Parameters

queryOpts (any)

▸ getGroup(id)

Get a group.

getGroup(id: string)

Parameters

id (string) The group ID.

▸ getGroupActivity(id, queryOpts)

Get group activity.

getGroupActivity(id: string, queryOpts: any)

Parameters

id (string) The group ID.

queryOpts (any)

▸ getGroupAdmins(id)

Get group admins.

getGroupAdmins(id: string)

Parameters

id (string) The group ID.

▸ getGroupMembers(id, queryOpts)

Get group members.

getGroupMembers(id: string, queryOpts: any)

Parameters

id (string) The group ID.

queryOpts (any)

▸ createGroup(group)

Create group.

createGroup(group: object)

Parameters

group (object) The VinylDNS group to create. See the [VinylDNS group docs] https://www.vinyldns.io/api/group-model.html to learn more.

▸ updateGroup(group)

Update group.

updateGroup(group: object)

Parameters

group (object) The VinylDNS group to update. See the [VinylDNS group docs] https://www.vinyldns.io/api/group-model.html to learn more.

▸ deleteGroup(id)

Delete a group.

deleteGroup(id: string)

Parameters

id (string) The ID of the group to delete.