---
title: "Set Farm Sim Profile"
method: PATCH
path: "/api/v1/farms/{farm_id}/sim-profile"
tags: ["simulated worlds"]
---

# Set Farm Sim Profile

`PATCH /api/v1/farms/{farm_id}/sim-profile`

## 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/farms/{farm_id}/sim-profile`
- Auth: HTTP bearer

## Path parameters

- `farm_id` string, required

## Request body

- FarmSimProfileUpsert: Mark a farm as flying, or change how it flies. Fields not sent are left as they are, so `{"flyable": false}` switches a farm off and keeps its slug and default paddock. A new profile sent with no slug takes one from the farm's name (`sim_worlds.derive_world_slug`).
  - `world_slug` string, nullable
  - `flyable` boolean
  - `default_paddock` string, nullable
  - `generator_args` object, nullable
  - `notes` string, nullable

## Response `200`

Successful Response

- SimWorldResponse: A flyable farm, as the sim picker sees it. Everything but the profile's own fields is read from the farm each time: nothing here is a stored copy, so moving a fence changes this answer.
  - `farm_id` string, required
  - `farm_name` string, required
  - `world_slug` string, required
  - `default_paddock` string, nullable, required
  - `origin_latitude` number, nullable, required
  - `origin_longitude` number, nullable, required
  - `origin_elevation_m` number, nullable, required
  - `paddock_count` integer, required
  - `generator_args` object, nullable, required
  - `notes` string, nullable, required
  - `buildable` boolean, required

## 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)