---
updatedAt: 2026-04-29T00:49:36.000Z
agentTools:
  projectIndex: https://synaccess.readme.io/llms.txt
---

# Update An Outlet

Update outlet configuration settings and control outlet relay states (ON or OFF).

# 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": "Outlets",
      "description": "Outlet listing and control endpoints."
    }
  ],
  "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": {
    "/v1/outlets/{outlet_id}": {
      "put": {
        "summary": "Update An Outlet",
        "description": "Update outlet configuration settings and control outlet relay states (ON or OFF).",
        "operationId": "update-an-outlet",
        "parameters": [
          {
            "name": "outlet_id",
            "in": "path",
            "description": "Unique outlet ID to modify",
            "schema": {
              "type": "string"
            },
            "required": true
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "outletName": {
                    "type": "string",
                    "description": "Name string up to 100 characters"
                  },
                  "pwrOnState": {
                    "type": "string",
                    "description": "Power on State is the state of the relay for the specific outlet when the PDU powers on from an off/powerless state. Acceptable strings are `\"ON\"`, `\"OFF\"`, `\"PREV\"`.  `\"PREV\"` will set the relay to the state of the PDU when last lost power."
                  },
                  "state": {
                    "type": "string",
                    "description": "State represents the relay status.  Acceptable strings are `\"ON\"`, `\"OFF\"`, and `\"REBOOT\"`."
                  },
                  "customRebootTimeEnabled": {
                    "type": "boolean",
                    "description": "Setting to true will configure PDU to use `customRebootTime` when rebooting outlet."
                  },
                  "customRebootTime": {
                    "type": "integer",
                    "description": "Number of seconds outlet will be off when rebooting and `customRebootTimeEnabled` is `true`",
                    "format": "int32"
                  }
                }
              },
              "examples": {
                "Request Example": {
                  "value": {
                    "pwrOnState": "OFF",
                    "outletName": "Example Outlet Name",
                    "state": "ON",
                    "customRebootTimeEnabled": true,
                    "customRebootTime": 10
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"data\": {\n    \"id\": \"1-286331153\",\n    \"outletName\": \"Nas Server 1\",\n    \"pwrOnState\": \"OFF\",\n    \"outletIndex\": 1,\n    \"receptacle\": \"IEC 60320 C19\",\n    \"currentRms\": 1.1,\n    \"state\": \"ON\",\n    \"bankId\": \"286331153\",\n    \"customRebootTimeEnabled\": false,\n    \"customRebootTime\": 12,\n    \"voltageDetection\": true,\n    \"relayHealth\": \"OK\",\n    \"connectionState\": \"Connected\",\n    \"enclosureSerialNumber\": 01740824,\n    \"pduLabeledOutletNum\": 1\n  }\n}"
                  }
                }
              }
            }
          }
        },
        "deprecated": false,
        "tags": [
          "Outlets"
        ]
      }
    }
  }
}
```