Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14126767600.8 KB

Creates a farm to allow space for queues and fleets. Farms are the space where the components of your renders gather and are pieced together in the cloud. Farms contain budgets and allow you to enforce permissions. Deadline Cloud farms are a useful container for large projects.

post/2023-10-12/farms

Headers

X-Amz-Client-Tokenstring

The unique token which the server uses to recognize retries of the same request.

Request body

displayNamestring required
<p>The display name of the farm.</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.</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>
kmsKeyArnstring

The ARN of the KMS key to use on the farm.

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. The default value is 1.

tagsobject

The tags to add to your farm. Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.

Response

Success

farmIdstring required

The farm ID.