Table of Contents
Introduction
Typographic Conventions
Changes since version 1.06x
API Notes
NicTool Objects
General Functions
Functions for Users
Functions for Groups
Functions for Nameservers
Functions for Zones
Functions for Zone Records
Functions for Permissions
Functions for Delegation
API
Index

Introduction

This document describes the public API for interaction with NicTool Server via the SOAP or XML-RPC protocols. NicTool version 1.06 was created by Dajoba, LLC. with development done primarily by Joseph Ingersoll. Changes to NicTool for version 2.00b were made by Greg Schueler.
  • NicTool: The website for the NicTool project.

  • RFC 1034: DOMAIN NAMES - CONCEPTS AND FACILITIES

  • RFC 1035: DOMAIN NAMES - IMPLEMENTATION AND SPECIFICATION

  • SOAP: Protocol and specification

  • XML-RPC: XML-RPC homepage



Why would I use this API? Nearly all of the functionality of this API is accessible via NicToolClient, the web-based client to NicTool Server, and is presented with an easy and intuitive interface. However the full power of NicTool Server is hard to take advantage of with point-and-click. The public API allows any client-developed program with SOAP or XML-RPC capability to interact with a NicTool Server. This allows you to write scripts for batch updates, mass zone imports, and other provisioning specific to your system. Your scripts could be usable via a command line or a custom CGI or any other SOAP/XML-RPC enabled system. You could even present your customers with a limited functionality control panel built right in to your pre-existing web site.

The API is provided mostly for increased economy of scale. With just 10 zones the NicToolClient interface is sufficient for everything you might want to do. However, it would be quite hard to do the necessary maintainance for >10000 zones and 14 DNS server clusters scattered across the globe with just a mouse and a web browser.