compute

GET `/v1/compute/spend-cap`

Read the organisation's monthly limit on metered compute.

Аутентификация

Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.

Идентификатор вашей организации

Этот эндпоинт принимает org_id в качестве параметра запроса. Оставьте его пустым, и вызов охватит все поддерево вашей аренды; передайте его, чтобы сузить область вызова до одной организации.

Идентификатор вашей организации находится на экране ключей API в вашей панели управления, рядом с самим ключом. Это один и тот же идентификатор для каждого вашего запроса.

Попробовать

Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.

curl -X GET https://api.zinndigital.com/v1/compute/spend-cap \
  -H "Authorization: Bearer zdk_live_…"

Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли

Параметры

Имя	Тип	Обязательно	Что это
`org_id (query)`	`string`	Нет	Required only when the caller belongs to more than one organisation.

Ответ

Имя	Тип	Обязательно	Что это
`monthly_cap_minor`	`object`	Да	The organisation's monthly limit on metered compute. `null` = no limit.
`currency`	`string`	Да	The organisation's billing currency.
`month_to_date_minor`	`integer`	Да	What metered machines have rated so far this month, in `currency`.

Ошибки, которые может возвращать этот эндпоинт

401 · 403 · 422 · 429