API Reference

Introduction

Welcome to the API and CLI documentation for Synaccess intelligent Power Distribution Units (PDUs). This documentation is designed to help system integrators, developers, and IT professionals automate and manage power control in data centers, remote locations, and enterprise infrastructure.

Synaccess PDUs offer remote access, real-time monitoring, and scriptable control over connected equipment through:

  • A web based API (ideal for integration and automation)
  • A Command Line Interface (CLI) (ideal for quick, direct configuration)

This documentation supports two platform families, each covering multiple PDU series:

  • SynLink SP and netBooter DX series PDUs
  • netBooter B and DU series PDUs

Though sold under different product names and form factors, the SP/DX series share the same underlying platform and software base, while the B/DU series share a different platform. This shared platform architecture is the reason each pair is documented together — API endpoints and CLI commands are identical or highly similar within each group.


📘

If you're looking for documentation for the Synaccess Central Management Portal (self hosted or cloud), please refer to our support hub for the CMP here.



What You’ll Find in This Documentation

This documentation is organized by platform, with each section providing:

  • Setup instructions for API/CLI access
  • Common command usage
  • Authentication details
  • Feature-specific walkthroughs
  • Examples
  • ... and more

📘

Not sure which PDU you have? Refer to the PDU Product Series article for images and identification tips.

📘

New to PDU terminology? See the Terminology & Concepts article to learn key terms before diving in.