Skip to content

Getting Started with SOLIDserver REST APIs

Leveraging the EfficientIP SOLIDserver REST APIs, organizations can streamline network management, enabling seamless end-to-end IT automation, easy ecosystem integration, and scalability in modern infrastructure operations.

February 19, 2024 | Written by: Myriam Herbron | , ,

Get the latest news, invites to events, and much more

Getting Started with Solidserver Rest Apis

In today’s rapidly evolving digital landscape, APIs have become the backbone of seamless integration and automation within the IT infrastructure. EfficientIP SOLIDserver, a scalable, flexible, reliable, and secure solution for DNS, DHCP and IPAM management, provides powerful open APIs. Designed as an API-first platform, SOLIDserver offers developers rich secure REST APIs and tools to integrate, automate, and extend the functionality of their network infrastructure for greater efficiency and control while improving collaboration between DevOps, NetOps, and SecOps teams. Let’s see how you can get started quickly with concrete examples.

Exploring the API Package

The API package offers a streamlined method for executing SOLIDserver services through the REST mechanism. Leveraging a graphical user interface like Swagger, users can easily explore API specifications and execute commands seamlessly, accelerating the development and testing process. By simplifying object calls through modules, objects, and actions, the API package introduces a more structured approach, utilizing the <module>/<object>/<action> format. This structured approach enhances usability and makes it easier for developers to interact with SOLIDserver services. It is worth noting that any data exchanged will be in JSON format. 

Using Swagger, developers can get explanations of how to use a REST API, including detailed descriptions of each mandatory or optional parameter called in that REST API, and enter values for testing purposes. Once executed, the API response is returned, the request is displayed via cURL, and the detailed server response is returned in JSON.

Practical Examples for Simplifying Network Management with REST APIs

To illustrate what can be done with the SOLIDserver REST APIs, let’s delve into a series of potential usages:

  1. Connection to the SOLIDserver API: Utilizing Swagger or similar tools, users can authenticate and establish connections to the SOLIDserver API, enabling seamless interaction with network services.
  1. Listing IPAM Spaces: It is possible to retrieve a list of IPAM spaces, providing network teams with valuable insight into network segmentation and allocation. 
  1. Retrieving Specific Space Information: Exploring how to obtain detailed information and properties about a specific IPAM space, facilitating targeted management and configuration.
  1. Counting Total Networks: Showcasing the ability to count the total number of networks managed by SOLIDserver, aiding in capacity planning and resource allocation.
  1. Filtering Networks by Space: Filtering network information based on specific IPAM spaces, allowing the network teams to focus on relevant data sets and streamline operations.
  1. Ordering Network Listings: Ordering based on specific criteria such as network names, providing network teams with flexibility and control over data presentation.
  1. Finding a free subnet or a free IP address in a space, subnet or pool
  1. Adding an IP address with name, meta-data, and aliases
  1. Adding a DNS record in a zone or DNS resource record creation 
  1. Searching for an established Network Active Directory session using Identity Manager
  1. Additional usages include network creation, filtering using metadata, network editing and deletion, as well as IP address management by provisioning a free IP Address for a service or device deployment including DNS naming. 

Advanced Ecosystem Integration Capability for End-to-end Automation

One of the key strengths of SOLIDserver APIs lies in their integration capabilities. By leveraging APIs, organizations can seamlessly integrate SOLIDserver with existing infrastructure and also third-party solutions, enabling full-stack end-to-end network automation, network source of truth and interoperability. Whether it’s triggering actions based on events or scheduled tasks, the versatility of SOLIDserver APIs opens up a world of possibilities for DevOps, NetOps, and SecOps alike. 

Example Use Cases: Network Automation Hub Leveraging SOLIDserver APIs

As outlined in the Gorilla Guide to Network Automation, SOLIDserver APIs empower developers to accelerate their network automation initiatives as well as increase their success and efficiency. As part of the EfficientIP Network Automation Hub, they play a key role in delivering fundamental use cases such as: 1) Discovering multi-cloud assets to help build an accurate Network Source of Truth (NSoT) for comprehensive visibility and control  2) Automating the deployment of infrastructure, applications, or services from provisioning to decommissioning 3) Alerting on DNS security events  4) Enforcing firewall policies to ensure compliance and rule configurations are always up-to-date and accurate.

Getting Started and REST APIs Best Practices

To start leveraging SOLIDserver APIs, users can download the API package from the EfficientIP website by logging in and clicking on Documentation and Downloads. Proper configuration is required, including activating Cross-Origin Resource Sharing (CORS) and enabling JavaScript calls on management devices. Additionally, users can explore open-source repositories for additional libraries and tools, enhancing the extensibility of SOLIDserver.

In conclusion, EfficientIP SOLIDserver REST APIs empower organizations to streamline network management, automate tasks, and integrate seamlessly with existing infrastructure and ecosystem. By exploring practical API examples, IT developers can unlock the full potential of their EfficientIP SOLIDserver™ DDI for enhanced efficiency, security, and scalability in network operations.

View SOLIDserver REST APIs webinar

Want to see how it works so you can try it out? Watch our SOLIDserver REST APIs webinar.