--- updatedAt: 2026-04-29T00:49:36.000Z agentTools: projectIndex: https://synaccess.readme.io/llms.txt --- # List All Device Configurations Returns a bounded page of matching authorized device configurations, ordered by enclosure serial number. Pagination is applied to authorized device candidates before live polling, so at most 20 devices are polled per request. Offline, timed-out, and unsuccessful devices are omitted from `data`; consequently, `data` may contain fewer entries than `limit`. Pagination metadata counts matching authorized device candidates, including candidates that did not return configuration. # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Cloud.Synaccess", "version": "1.3" }, "servers": [ { "url": "https://cloud.synaccess.com" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "name": "authorization", "in": "header", "x-default": "Bearer" } } }, "security": [ { "sec0": [] } ], "tags": [ { "name": "Configuration", "description": "Device configuration retrieval and updates." } ], "x-tagGroups": [ { "name": "Devices", "tags": [ "Device Inventory", "Device Live Telemetry", "Device Logs", "Configuration", "Firmware" ] }, { "name": "Power Control", "tags": [ "Outlets", "PDU Outlet Groups", "Inlets", "Banks", "Sensors" ] }, { "name": "Automation", "tags": [ "Events", "Actions" ] }, { "name": "Organization", "tags": [ "Groups" ] } ], "paths": { "/v2/conf": { "get": { "summary": "List All Device Configurations", "description": "Returns a bounded page of matching authorized device configurations, ordered by enclosure serial number. Pagination is applied to authorized device candidates before live polling, so at most 20 devices are polled per request. Offline, timed-out, and unsuccessful devices are omitted from `data`; consequently, `data` may contain fewer entries than `limit`. Pagination metadata counts matching authorized device candidates, including candidates that did not return configuration.", "operationId": "list-all-device-configurations", "parameters": [ { "name": "enclosure_serial_number", "in": "query", "description": "Unique enclosure serial number to retrieve. Multiple serial numbers may be separated with commas. When omitted, configurations are requested for all authorized devices.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "One-based page number over matching authorized devices.", "schema": { "type": "integer", "format": "int32", "minimum": 1, "default": 1 } }, { "name": "limit", "in": "query", "description": "Maximum number of authorized devices whose configurations may be requested on this page.", "schema": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 20, "default": 20 } } ], "responses": { "200": { "description": "A bounded page of configurations from successful live responses or eligible cached entries, with pagination metadata based on matching authorized devices.", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"data\": [\n {\n \"connectionState\": \"Connected\",\n \"cached\": false,\n \"enclosureSerialNumber\": 1024122712,\n \n \"hostName\": \"SynLink\",\n \"macAddr\": \"3A:D2:21:D3:82:45\",\n \"webPort\": 80,\n \"webSslPort\": 443,\n \"telnetPort\": 23,\n \"sshPort\": 22,\n \"ipAssign\": \"static\",\n \"globalRebootTime\": 5,\n \"webEnabled\": true,\n \"webSslEnabled\": true,\n \"webRedirectHttp\": false,\n \"customSslCertEnabled\": false,\n \"telnetEnabled\": true,\n \"sshEnabled\": true,\n \"subnetMask\": \"255.255.255.0\",\n \"gatewayIp\": \"192.168.1.1\",\n \"staticIp\": \"192.168.1.100\",\n \"primaryDns\": \"8.8.8.8\",\n \"secondaryDns\": \"8.8.4.4\",\n \"ntpEnabled\": true,\n \"ntpHost\": \"pool.ntp.org\",\n \"disableSshPassLogin\": false,\n \"disableSshKeyLogin\": false,\n \"usbFwupdateControlEnabled\":false,\n \"sshIdleTimeout\": 0,\n \"webIdleTimeout\": 0,\n \"webMaxUsers\": 0,\n \"deviceSequentialPowerUpDelay\": 3,\n \"webApiPasswordEnabled\": false,\n \"smtpServer\": \"\",\n \"smtpPort\": 0,\n \"smtpTlsEnabled\": 0,\n \"smtpAuthRequired\": 0,\n \"smtpUsername\": \"\",\n \"syslogServerIp\": \"\",\n \"enableRemoteUserLogging\":false,\n \"enableRemoteEventLogging\":false,\n \"smtpPassword\": \"\",\n \"snmpv12Enabled\": true,\n \"snmpv12ReadString\": \"public\",\n \"snmpv12WriteString\": \"private\",\n \"snmp3AuthPass\": \"examplepassword\",\n \"snmp3PrivacyPass\": \"exampleprivacypass\",\n \"snmp3TrapAuthProtocol\": \"SHA\",\n \"snmp3TrapPrivacyProtocol\": \"AES\",\n \"snmp3TrapSecurity\": \"authPriv\",\n \"deviceName\": \"SynLink PDU\",\n \"lcdOrientation\": 90,\n \"lcdScreensaverTimeout\": 60,\n \"lcdBacklightBrightness\": 2,\n \"lcdScreensaverType\": \"power_info\",\n \"lcdBackgroundColor\": \"black\",\n \"lcdOutletControlEnabled\": true,\n \"lcdNetworkControlEnabled\": true,\n \"lcdRebootControlEnabled\":false,\n \"lcdFlushControlEnabled\":false,\n \"portAMode\": \"sensor\",\n \"portAComBaud\": 115200,\n \"portAModemBaud\": 115200,\n \"usbComBaud\": 115200,\n \"usbModemBaud\":115200,\n \"usbFwupdateControlEnabled\":false,\n \"daylightsavings\": true,\n \"timezone\": \"GMT+8\",\n \"customSslCertExists\": false,\n \"customSslKeyExists\": false\n }\n ],\n \"meta\": {\n \"currentPage\": 1,\n \"limit\": 20,\n \"totalCount\": 37,\n \"totalPages\": 2\n }\n}" }, "PaginatedResult": { "summary": "Paginated response envelope", "value": { "data": [ { "connectionState": "Connected", "cached": false, "enclosureSerialNumber": 1024122712, "deviceName": "SynLink PDU" } ], "meta": { "currentPage": 1, "limit": 20, "totalCount": 37, "totalPages": 2 } } } }, "schema": { "type": "object", "required": [ "data", "meta" ], "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "connectionState": { "type": "string", "example": "Connected" }, "cached": { "type": "boolean", "description": "Whether this entry was served from the configuration cache.", "example": false }, "enclosureSerialNumber": { "type": "integer", "example": 1024122712, "default": 0 }, "hostName": { "type": "string", "example": "SynLink" }, "macAddr": { "type": "string", "example": "3A:D2:21:D3:82:45" }, "webPort": { "type": "integer", "example": 80, "default": 0 }, "webSslPort": { "type": "integer", "example": 443, "default": 0 }, "telnetPort": { "type": "integer", "example": 23, "default": 0 }, "sshPort": { "type": "integer", "example": 22, "default": 0 }, "ipAssign": { "type": "string", "example": "static" }, "globalRebootTime": { "type": "integer", "example": 5, "default": 0 }, "webEnabled": { "type": "boolean", "example": true, "default": true }, "webSslEnabled": { "type": "boolean", "example": true, "default": true }, "webRedirectHttp": { "type": "boolean", "example": false, "default": true }, "customSslCertEnabled": { "type": "boolean", "example": false, "default": true }, "telnetEnabled": { "type": "boolean", "example": true, "default": true }, "sshEnabled": { "type": "boolean", "example": true, "default": true }, "subnetMask": { "type": "string", "example": "255.255.255.0" }, "gatewayIp": { "type": "string", "example": "192.168.1.1" }, "staticIp": { "type": "string", "example": "192.168.1.100" }, "primaryDns": { "type": "string", "example": "8.8.8.8" }, "secondaryDns": { "type": "string", "example": "8.8.4.4" }, "ntpEnabled": { "type": "boolean", "example": true, "default": true }, "ntpHost": { "type": "string", "example": "pool.ntp.org" }, "disableSshPassLogin": { "type": "boolean", "example": false, "default": true }, "disableSshKeyLogin": { "type": "boolean", "example": false, "default": true }, "usbFwupdateControlEnabled": { "type": "boolean", "example": false, "default": true }, "sshIdleTimeout": { "type": "integer", "example": 0, "default": 0 }, "webIdleTimeout": { "type": "integer", "example": 0, "default": 0 }, "webMaxUsers": { "type": "integer", "example": 0, "default": 0 }, "deviceSequentialPowerUpDelay": { "type": "integer", "example": 3, "default": 0 }, "webApiPasswordEnabled": { "type": "boolean", "example": false, "default": true }, "smtpServer": { "type": "string", "example": "" }, "smtpPort": { "type": "integer", "example": 0, "default": 0 }, "smtpTlsEnabled": { "type": "integer", "example": 0, "default": 0 }, "smtpAuthRequired": { "type": "integer", "example": 0, "default": 0 }, "smtpUsername": { "type": "string", "example": "" }, "syslogServerIp": { "type": "string", "example": "" }, "enableRemoteUserLogging": { "type": "boolean", "example": false, "default": true }, "enableRemoteEventLogging": { "type": "boolean", "example": false, "default": true }, "smtpPassword": { "type": "string", "example": "" }, "snmpv12Enabled": { "type": "boolean", "example": true, "default": true }, "snmpv12ReadString": { "type": "string", "example": "public" }, "snmpv12WriteString": { "type": "string", "example": "private" }, "snmp3AuthPass": { "type": "string", "example": "examplepassword" }, "snmp3PrivacyPass": { "type": "string", "example": "exampleprivacypass" }, "snmp3TrapAuthProtocol": { "type": "string", "example": "SHA" }, "snmp3TrapPrivacyProtocol": { "type": "string", "example": "AES" }, "snmp3TrapSecurity": { "type": "string", "example": "authPriv" }, "deviceName": { "type": "string", "example": "SynLink PDU" }, "lcdOrientation": { "type": "integer", "example": 90, "default": 0 }, "lcdScreensaverTimeout": { "type": "integer", "example": 60, "default": 0 }, "lcdBacklightBrightness": { "type": "integer", "example": 2, "default": 0 }, "lcdScreensaverType": { "type": "string", "example": "power_info" }, "lcdBackgroundColor": { "type": "string", "example": "black" }, "lcdOutletControlEnabled": { "type": "boolean", "example": true, "default": true }, "lcdNetworkControlEnabled": { "type": "boolean", "example": true, "default": true }, "lcdRebootControlEnabled": { "type": "boolean", "example": false, "default": true }, "lcdFlushControlEnabled": { "type": "boolean", "example": false, "default": true }, "portAMode": { "type": "string", "example": "sensor" }, "portAComBaud": { "type": "integer", "example": 115200, "default": 0 }, "portAModemBaud": { "type": "integer", "example": 115200, "default": 0 }, "usbComBaud": { "type": "integer", "example": 115200, "default": 0 }, "usbModemBaud": { "type": "integer", "example": 115200, "default": 0 }, "daylightsavings": { "type": "boolean", "example": true, "default": true }, "timezone": { "type": "string", "example": "GMT+8" }, "customSslCertExists": { "type": "boolean", "example": false, "default": true }, "customSslKeyExists": { "type": "boolean", "example": false, "default": true } } } }, "meta": { "type": "object", "description": "Pagination over matching authorized devices before configuration polling. Because failed page entries are omitted, `data` may contain fewer entries than `limit`.", "required": [ "currentPage", "limit", "totalCount", "totalPages" ], "properties": { "currentPage": { "type": "integer", "format": "int32", "minimum": 1, "example": 1 }, "limit": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 20, "example": 20 }, "totalCount": { "type": "integer", "format": "int32", "minimum": 0, "description": "Number of matching authorized device candidates before live polling.", "example": 37 }, "totalPages": { "type": "integer", "format": "int32", "minimum": 0, "example": 2 } } } } } } } }, "400": { "description": "The page or limit query value is outside the supported range. The maximum limit is 20." }, "500": { "description": "Unexpected error while retrieving configurations.", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"code\": \"UNEXPECTED_ERROR_DEVICE_CONFIGURATION_OPERATION\",\n \"message\": \"Unexpected error while retrieving configuration.\"\n}" } }, "schema": { "type": "object", "properties": { "code": { "type": "string", "example": "UNEXPECTED_ERROR_DEVICE_CONFIGURATION_OPERATION" }, "message": { "type": "string", "example": "Unexpected error while retrieving configuration." } } } } } } }, "deprecated": false, "tags": [ "Configuration" ] } } } } ```