API referansı İngilizce yayımlanır.
Create or update a budget policy
POST
/api/companies/{companyId}/budgets/policiesPersonal API keyConsole session
Create or update a budget policy.
Yetkilendirme
Send a personal API key as Authorization: Bearer <key>. It acts as you, with your permissions in each organization. Agent API keys are refused with 403. Anahtarlar nasıl çalışır.
Yol parametreleri
companyIdstringZorunluThe organization's id.
İstek gövdesi
application/json · zorunlu
scopeTypestringZorunlu
one of: "company", "agent", "project", "issue"scopeIdstring (uuid)Zorunlu
metricstringİsteğe bağlı
one of: "billed_cents"windowKindstringİsteğe bağlı
one of: "calendar_month_utc", "lifetime"amountintegerİsteğe bağlı
≥ 0≤ 2147483647reservationCentsstring | numberİsteğe bağlı
warnPercentintegerİsteğe bağlı
≥ 1≤ 99hardStopEnabledbooleanİsteğe bağlı
unpricedUsagePolicystringİsteğe bağlı
one of: "block", "allow"notifyEnabledbooleanİsteğe bağlı
isActivebooleanİsteğe bağlı
Yanıtlar
200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation.
details names each field that failed.401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
Hatalar {"error": "..."} döndürür, çoğu zaman bir code ve details ile birlikte. Ayrıntılar için: hatalar ve limitler.