DDI Central REST API Guide : Use Cases, Features and Capabilities

DDI Central Overview

ManageEngine DDI Central is aspecialised network management solution designed to simplify and centralize the three core network services DNS, DHCP, and IP address management (IPAM). IP networks are the scaffolds around modern organizations, seamlessly connecting devices, applications, and users across multiple locations. Assigning a unique IP address to each device ensures smooth communication and collaboration across the network.

For distributed enterprises, effectively managing IP networks is critical to maintaining connectivity, driving efficiency, and staying agile in a fast-paced digital world. By unifying the core network services, DDI Central delivers programmable smart IP networks that power robust enterprise network operations, adapting to evolving business needs with ease.

What can DDI Central do for you?

• Centralizes the planning and administration of DNS, DHCP, and IPAM and narrows down your admins' focus to one unified window offering centralized visibility and control of your entire network
• Automates network provisioning with standardized, policy-driven configurations, reducing manual intervention and errors
• Streamlines the life cycle management of DNS and DHCP services and IP addresses within the managed network as devices and users join and leave
• Tracks managed DNS, DHCP, and IP address objects in real time to enhance performance and maximize resource utilization
• Manages multi-site core network services effortlessly with centralized visibility and control
• Imparts self-defending capabilities on your infrastructure with robust DNS security and reliable service control
• Ensures uninterrupted network operations with robust failover mechanisms for DNS and DHCP
• Delivers detailed audit trails for tracking changes, ensuring compliance, and enhancing accountability
• Functions as a pure software overlay that integrates with your existing infrastructure—no hardware required

DDI Central's REST APIs Overview

The REST APIs of DDI Central extend its capabilities, enabling programmatic access to all major functionalities. These APIs empower developers and IT admins to integrate DDI Central seamlessly into their workflows and automate complex network operations.

Capabilities include:

• Full CRUD (Create, Read, Update, Delete) operations for DNS zones, DHCP configurations, and IP address management.
• Advanced querying options for auditing, monitoring, and troubleshooting.
• Built-in support for bulk operations, making large-scale configurations and migrations effortless.

Target Audience

The REST APIs are ideal for:

• Network Engineers: Automating routine network tasks and scaling configurations across distributed infrastructures.
• IT Administrators:Centralizing control and enhancing visibility over DNS, DHCP, and IPAM data.
• Developers: Building custom integrations and applications using DDI Central as the backbone for network management.
• Enterprise IT Teams: Streamlining workflows for large-scale network deployments and upgrades.

Key Features and Capabilities of DDI Central APIs

Unlock the full potential of your network infrastructure with DDI Central's APIs, designed to simplify, secure, and automate the management of DNS, DHCP, and IPAM services. Whether you’re integrating with existing systems or building custom applications, these APIs provide the flexibility and power needed to drive efficient network operations at any scale. Explore how DDI Central's APIs empower administrators and developers to streamline processes, gain deeper insights, and ensure robust security across distributed networks.

Here’s a brief description of each API call grouped by its category:

1. OAuth2 Authorization API

   Token generation

   • Enables secure access to all API functionalities by providing a token after successful authentication. This ensures secure communication and role-based control of access.

2. Cluster API

   Get cluster details

   • Fetches an overview of all clusters configured in the system. It includes details like the number of servers, DNS zones, subnets, and their operational statuses, helping teams monitor and manage resources efficiently.

3. Zone API

   Retrieve zones

   • Provides a summary of configured clusters, including their operational status, resources (zones, subnets, servers), and role assignments. Ideal for gaining insights into how your network clusters are distributed and performing.

   Create a zone

   • Adds a new DNS zone to the cluster, enabling businesses to define and manage new domain spaces.

   Update a specific zone

   • Lets users modify existing DNS zones, such as updating TTL values or DNS server information, to ensure configurations stay current.

   Delete a zone

   • Simplifies cleanup by enabling the removal of unused or obsolete DNS zones.

4. DNS Record APIs

   A, AAAA, CNAME, MX, and Other Record APIs

   • Add, update, retrieve, or delete DNS records like A, AAAA, CNAME, MX, or TXT. These capabilities ensure precise control over DNS resolution and streamline domain configurations.

5. BIND Import and Export APIs

   Zone Import and Export

   • Enables seamless migration of zone configurations by importing or exporting DNS zone files in standard formats.

6. DHCP Subnet APIs

   Manage subnets

   • Supports adding, updating, or deleting DHCP subnets. Ideal for managing IP pools and ensuring efficient IP distribution within your network.

   Retrieve subnet data

   • Offers a snapshot of all configured subnets, enabling IT teams to analyze address allocation and availability at a glance.

7. Shared Network APIs

   Shared network management

   • Allows configuration and management of shared networks that span multiple subnets, simplifying the management of complex setups.

8. VLAN APIs

   Manage VLANs

   • Supports creating, updating, and deleting VLANs, ensuring a logical separation of networks and improving traffic management.

9. Host APIs

   Manage DHCP reservations

   • Simplifies the addition or management of devices within a network by associating them with IP addresses, subnets, or shared networks.

10. Failover Configurations APIs

    Failover management

    • Automates the setup and monitoring of failover configurations, ensuring high availability of DHCP services during server downtimes.

11. IPAM APIs

    IP usage insights

    • Provides detailed insights into IP address usage, showing availability, reserved, and active states. Useful for optimizing resource allocation.

    Lease data retrieval

    • Tracks DHCP lease activity, offering visibility into device connections and ensuring lease compliance.