---
title: "Update Rig"
method: PATCH
path: "/api/v1/rigs/{rig_id}"
tags: ["testing rigs"]
---

# Update Rig

`PATCH /api/v1/rigs/{rig_id}`

## Request

- Base URL: `https://api.brumby.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.brumby.com/api/v1/rigs/{rig_id}`
- Auth: HTTP bearer

## Path parameters

- `rig_id` string, uuid, required

## Request body

- RigUpdate: A partial edit. `revision` is the revision the edit was made against: an edit of a rig that changed since is refused rather than merged.
  - `revision` integer, required
  - `name` string, nullable
  - `dock_id` string, nullable
  - `aircraft` union
    - CompanionAircraft: A Jetson aircraft device. With a simulated flight controller or gimbal it flies BrumbySim's from `host_id` (for now the rig's dock); with both real, no host.
      - `kind` 'companion', required
      - `companion_id` string, required
      - `host_id` string
      - `components` AircraftComponents, required
        - `flight_controller` 'sim' | 'real', required
        - `gimbal` 'sim' | 'real', required
    - BrumbySimAircraft
      - `kind` 'bsim', required
      - `host_id` string, required
      - `components` SimComponents, required: BrumbySim's aircraft is the game's: both its components are simulated.
        - `flight_controller` 'sim', required
        - `gimbal` 'sim', required
  - `farm_id` string, nullable
  - `boxes` RigBoxes
    - `mcu` 'sim' | 'real', required
    - `gnss` 'sim' | 'real', required
    - `weather` 'sim' | 'real', required
    - `power` 'sim' | 'real', required
    - `radio` 'sim' | 'real', required
  - `dock_pin` DockPin
    - `lat` number, required
    - `lon` number, required
    - `heading_deg` number, required
  - `preset` boolean, nullable

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/brumby/apis/brumby-platform-api.md) - [All operations](https://skmtc.dev/brumby/apis/brumby-platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/brumby/apis/brumby-platform-api/revisions/fe185e20813e?raw)