REST Entities

All Exhibitor entities are received/returned as JSON.

Result

Many Exhibitor APIs return a Result to indicate success or failure.

{
    "succeeded": boolean,
    "message": string,  // Any error message if succeeded is false
}

NameAndModifiedDate

Used by the Index APIs.

{
    "name": string,      // the file/index name
    "modifiedDate": long // an epoch
}

State

{
    "version": string,           // Exhibitor version
    "running": boolean,          // is the ZooKeeper instance running
    "config": Config             // Shared Configuration (see the Config entity)
    
    // ... other values as needed ...
}

Config

{
    "rollInProgress": boolean,            // is a rolling config change in progress
    "rollStatus": string,                 // The status of the rolling config change
    "rollPercentDone": int,
    "hostname": string,                   // The hostname of this machine (not really a shared value but still returned here)
    "serverId": int,                      // The ZooKeeper Server Id configured for this instance or -1
    "logIndexDirectory": string,          // Path to store indexed logs
    "zookeeperInstallDirectory": string,
    "zookeeperDataDirectory": string,
    "serversSpec": string,                // List of servers in the ensemble (see below for syntax)
    "backupExtra": string,                // URL encoded values used for backing-up
    "zooCfgExtra": string                 // URL encoded values to add to zoo.cfg file
}