---
title: "Set command lockout status"
method: PUT
path: "/api/v1/reel/command-lockout"
tags: ["v1", "reel-movement"]
---

# Set command lockout status

`PUT /api/v1/reel/command-lockout`

Enables or disables the command lockout feature to prevent user-initiated movement operations.

When command lockout is enabled, all movement commands (wind, unwind, go-to-position, jog, and speed updates) are blocked and return error responses. Safety features including emergency stop and active braking continue to function normally.

Command lockout provides an additional safety layer during maintenance operations or when the system must remain stationary while other processes are active.

## Request body

- CommandLockoutRequest — Request data for setting command lockout state.
  - `lockout_enabled` boolean, required — Enable or disable movement command restrictions. When True, blocks all user movement commands (wind, unwind, go-to, jog, speed) while preserving safety features. When False, allows normal movement command processing.

## Response `200`

Successful Response

- CommandLockoutResponse — Response for command lockout operations. Manages movement command restrictions for enhanced safety control. Lockout system blocks user movement commands while preserving emergency stop and safety feature functionality.
  - `action` string, required — The action that was requested or performed by the endpoint
  - `error` boolean, required — Indicates whether the operation encountered an error
  - `error_msgs` string[] — List of error messages if the operation failed
  - `result` CommandLockoutResult, required — Result data for command lockout operations.
    - `lockout_enabled` boolean, required — Current state of the command lockout system. Indicates whether movement commands are currently blocked (True) or allowed (False). This status affects all user-initiated movement operations.

## Other responses

- `401` — Could not validate credentials
- `403` — Setup required before using this endpoint
- `422` — Validation Error
- `500` — Internal server 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)