Connection Summary

Websocket HTTP
Port number 5182 (ws) 5184 (wss) 5183 (http) 5185 (https)
URL redirect /websocket /api
Format JSON only HTTP+JSON
Event Support Yes No

Reference Guide

    Basic Formatting

    Standard connection information and syntax

    cluster

    This namespace is for API interactions that cross the boundaries of individual NAS systems. Some examples would be to issue a change request to an entire group of systems instead of performing the change individually, or to have one system send data over to another system with TrueCommand setting up the entire operation. Reference Guide cluster/db_backup Fetch and backup a configuration database cluster/db_delete Delete a NAS database backup

    Event Formatting

    Description of the events subsystem for websocket connections

    Time Formatting

    Formatting for using time-based access for API calls

    Reporting Formats

    Basic information about reports and the types of widgets available.

    rpc

    Remote Protocol Communications

    email

    Email management

    reports

    System reports

    users

    User management

    alertplugins

    Alert Notification Plugins

    alerts

    Alert management

    data

    Data Retrieval

    freenas

    FreeNAS management

    license

    License management

    logs

    Logs

    notices

    Notice management

    uilogs

    UI Logging

    servers

    Server management

    external

    External

    ssl

    SSL Certificate Management

    sys

    System management

    teams

    Team management