v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14126767600.8 KB

Updates a farm.

patch/2023-10-12/farms/{farmId}

Path parameters

farmIdstring required

The farm ID to update.

Request body

displayNamestring
<p>The display name of the farm to update.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
descriptionstring password
<p>The description of the farm to update.</p> <important> <p>This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.</p> </important>
costScaleFactornumber float

A multiplier applied to the farm's calculated costs for usage data and budget tracking. A value less than 1 represents a discount, a value greater than 1 represents a premium, and a value of 1 represents no adjustment.

Response

Success

UpdateFarmResponse required