Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14126767600.8 KB

Gets information about a specific limit.

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

Path parameters

farmIdstring required

The unique identifier of the farm that contains the limit.

limitIdstring required

The unique identifier of the limit to return.

Response

Success

farmIdstring required

The unique identifier of the farm that contains the limit.

limitIdstring required

The unique identifier of the limit.

currentCountinteger required

The number of resources from the limit that are being used by jobs. The result is delayed and may not be the count at the time that you called the operation.

createdAtstring date-time required

The Unix timestamp of the date and time that the limit was created.

createdBystring required

The user identifier of the person that created the limit.

updatedAtstring date-time

The Unix timestamp of the date and time that the limit was last updated.

updatedBystring

The user identifier of the person that last updated the limit.

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

The value that you specify as the <code>name</code> in the <code>amounts</code> field of the <code>hostRequirements</code> in a step of a job template to declare the limit requirement.

maxCountinteger required
<p>The maximum number of resources constrained by this limit. When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available.</p> <p>The <code>maxValue</code> must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.</p>
descriptionstring password
<p>The description of the limit that helps identify what the limit is used for.</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>