---
updatedAt: 2026-08-31T20:25:42.000Z
agentTools:
  projectIndex: https://synaccess.readme.io/llms.txt
---

# Get Device Configuration

Fetches the configuration for one authorized device.

# 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/devices/{enclosure_sn}/configuration": {
      "get": {
        "summary": "Get Device Configuration",
        "description": "Fetches the configuration for one authorized device.",
        "operationId": "get-device-configuration",
        "parameters": [
          {
            "name": "enclosure_sn",
            "in": "path",
            "description": "Unique enclosure serial number for the device.",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int64",
              "minimum": 1
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The live or eligible cached device configuration.",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": {
                      "data": {
                        "connectionState": "Connected",
                        "cached": false,
                        "enclosureSerialNumber": 1024122712,
                        "hostName": "SynLink",
                        "deviceName": "SynLink PDU"
                      }
                    }
                  }
                },
                "schema": {
                  "type": "object",
                  "required": [
                    "data"
                  ],
                  "properties": {
                    "data": {
                      "type": "object",
                      "description": "Configuration reported by the device, including connection, cache, and enclosure metadata. Available settings can vary by device model and firmware.",
                      "additionalProperties": true
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "The enclosure serial number is invalid."
          },
          "401": {
            "description": "Authentication credentials are missing or invalid.",
            "content": {
              "application/json": {
                "examples": {
                  "InvalidToken": {
                    "value": {
                      "error": "INVALID_TOKEN",
                      "message": "Token is invalid",
                      "statusCode": 401
                    }
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "error": {
                      "type": "string",
                      "example": "INVALID_TOKEN"
                    },
                    "message": {
                      "type": "string",
                      "example": "Token is invalid"
                    },
                    "statusCode": {
                      "type": "integer",
                      "format": "int32",
                      "example": 401
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "The requested device does not exist or is not accessible to the authenticated user.",
            "content": {
              "application/json": {
                "examples": {
                  "DeviceNotFound": {
                    "value": {
                      "code": "DEVICE_NOT_FOUND",
                      "message": "Device not found in User's Database."
                    }
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "code": {
                      "type": "string",
                      "example": "DEVICE_NOT_FOUND"
                    },
                    "message": {
                      "type": "string",
                      "example": "Device not found in User's Database."
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Unexpected error while retrieving the device configuration.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "code": {
                      "type": "string",
                      "example": "UNEXPECTED_ERROR_DEVICE_CONFIGURATION_OPERATION"
                    },
                    "message": {
                      "type": "string",
                      "example": "Unexpected error while retrieving configuration."
                    }
                  }
                }
              }
            }
          },
          "503": {
            "description": "No live or eligible cached configuration is available for the device.",
            "content": {
              "application/json": {
                "examples": {
                  "DeviceOffline": {
                    "value": {
                      "code": "DEVICE_OFFLINE",
                      "message": "Device configuration is unavailable because the device is offline."
                    }
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "code": {
                      "type": "string",
                      "example": "DEVICE_OFFLINE"
                    },
                    "message": {
                      "type": "string",
                      "example": "Device configuration is unavailable because the device is offline."
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false,
        "tags": [
          "Configuration"
        ]
      }
    }
  }
}
```