Skip to content
/
Get compute settings
Last updated

Get compute settings

Returns your organization's Forge cloud compute settings: what happens to running Aitronos servers at the spending limit, after how many idle hours servers are parked automatically (Aitronos servers always are, after 1 hour unless you choose otherwise), and after how many idle hours the idle reminder shows. The defaults apply until an admin changes them.

Requires a bearer token (or API key) whose principal holds the use_forge capability in the acting organization. It works while Forge cloud compute is switched off.

GEThttps://api.aitronos.com/v1/forge/compute/settings

This endpoint takes no parameters.

Query Parameters

organization_id string optional

The organization to act in. Defaults to your current organization. You must be an active member of it, or the request is refused with 403 ORGANIZATION_ACCESS_DENIED.

Headers

X-Organization-Id string optional

The same as organization_id, as a header. When both are sent, the query parameter wins.

Returns

  • at_cap_behavior string — what happens to running Aitronos servers when the organization reaches its spending limit: park (default: the work is saved and compute charges stop) or keep_running. At 90% of the limit every running Aitronos server carries a notice either way. Servers in your own accounts are not affected: the provider bills them.
  • auto_park_idle_hours integer or null — your organization's choice: park any ready server automatically after this many hours without reported activity, 1 to 168. null (default) means no choice: bring-your-own servers are then never parked automatically, and Aitronos servers use the platform default. Servers whose offering cannot park are left running.
  • aitronos_auto_park_idle_hours integer — read-only: the hours without activity after which an Aitronos server is actually parked. auto_park_idle_hours when set, otherwise 1. Automatic parking cannot be switched off for Aitronos servers: they run on Aitronos' own account.
  • idle_reminder_hours integer — show the idle_reminder on a ready server after this many hours without activity, 1 to 168. Default 8.
{
  "at_cap_behavior": "park",
  "auto_park_idle_hours": null,
  "aitronos_auto_park_idle_hours": 1,
  "idle_reminder_hours": 8
}

Errors

StatusCodeWhen
401AUTHENTICATION_REQUIREDNo valid credential.
403ORGANIZATION_ACCESS_DENIEDorganization_id or X-Organization-Id names an organization you are not an active member of.
403INSUFFICIENT_PERMISSIONSThe caller does not hold use_forge in the acting organization.
cURL
curl "https://api.aitronos.com/v1/forge/compute/settings" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Response:

{
  "at_cap_behavior": "park",
  "auto_park_idle_hours": null,
  "aitronos_auto_park_idle_hours": 1,
  "idle_reminder_hours": 8
}
Previous page
Next page