---
title: "Update plugin settings"
method: PATCH
path: "/api/v1/plugins/{plugin_id}/settings"
tags: ["v1", "plugins"]
---

# Update plugin settings

`PATCH /api/v1/plugins/{plugin_id}/settings`

Update hardware and/or settings for a specific plugin

## Path parameters

- `plugin_id` string, required

## Request body

- UpdatePluginSettingsRequest — Request for updating plugin settings (hardware and/or settings).
  - `hardware` PowerSheaveHardwareUpdate — Updateable hardware configuration for Power Sheave plugin.
    - `plugin_type` 'power_sheave' — Plugin identifier for discriminated union
    - `ethernet` EthernetConfig — Ethernet hardware configuration.
      - `host` string, required — IP address of the motor controller
      - `port` integer, required — Port number
      - `timeout` number — Connection timeout in seconds
  - `settings` union — Plugin settings updates
    - PowerSheaveSettingsUpdate — Updateable settings for Power Sheave plugin.
      - `plugin_type` 'power_sheave' — Plugin identifier for discriminated union
      - `speed_differential_percentage` number, nullable — Speed differential percentage
      - `reverse_direction` boolean, nullable — Whether to reverse motor direction of the power sheave
      - `control_mode` 'open' | 'closed', nullable — Control mode for the motor
      - `ecd_gain` number, nullable — Encoder Counter to Distance (ECD) gain K_w for converting encoder pulses to distance (x10^-6 m/pulse)
    - DockingSettingsUpdate — Updateable settings for Docking Mechanism plugin.
      - `plugin_type` 'docking_mechanism' — Plugin identifier for discriminated union
      - `dock_timeout_seconds` integer, nullable — Timeout for docking operations in seconds
      - `undock_timeout_seconds` integer, nullable — Timeout for undocking operations in seconds
      - `motor_speed` integer, nullable — Motor speed percentage (0-100)
      - `docking_reversing_timeout_seconds` number, nullable — Timeout for reverse phase during docking (seconds)
      - `undock_wind_delay_seconds` number, nullable — Duration to continue winding after reed opens during undocking (seconds)
      - `undock_completion_delay_seconds` number, nullable — Delay after final reed open before stopping (seconds)

## Response `200`

Successful Response

- UpdatePluginSettingsResponse — Response schema for update plugin settings request.
  - `success` boolean, required
  - `message` string, required
  - `updated_config` PluginConfigSchema — Schema for plugin configuration data.
    - `name` string, required — Display name of the plugin
    - `version` string, required — Plugin version number
    - `description` string, required — Plugin description
    - `requirements` object — Hardware requirements
    - `hardware` object, nullable — Hardware configuration
    - `settings` object, nullable — Plugin settings

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/reach-systems-tech/apis/reelapi-v1.md) · [All operations](https://skmtc.net/reach-systems-tech/apis/reelapi-v1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/reach-systems-tech/reelapi-v1/revisions/1dd366a9c6a3/schema)