v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14126767600.8 KB

Get a farm.

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

Path parameters

farmIdstring required

The farm ID of the farm.

Response

Success

farmIdstring required

The farm ID of the farm to get.

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>
kmsKeyArnstring

The ARN of the KMS key used on the farm.

createdAtstring date-time required

The date and time the resource was created.

createdBystring required

The user or system that created this resource.

updatedAtstring date-time

The date and time the resource was updated.

updatedBystring

The user or system that updated this resource.

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>
costScaleFactornumber float required

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.