La référence de l'API est publiée en anglais.

Create or update a budget policy

POST/api/companies/{companyId}/budgets/policies
Personal API keyConsole session
Veyra Docs TeamMis à jour le Version 3 · Historique

Create or update a budget policy.

Autorisation

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. Fonctionnement des clés.

Paramètres de chemin

companyIdstringObligatoireThe organization's id.

Corps de la requête

application/json · obligatoire

scopeTypestringObligatoireone of: "company", "agent", "project", "issue"
scopeIdstring (uuid)Obligatoire
metricstringFacultatifone of: "billed_cents"
windowKindstringFacultatifone of: "calendar_month_utc", "lifetime"
amountintegerFacultatif≥ 0≤ 2147483647
reservationCentsstring | numberFacultatif
warnPercentintegerFacultatif≥ 1≤ 99
hardStopEnabledbooleanFacultatif
unpricedUsagePolicystringFacultatifone of: "block", "allow"
notifyEnabledbooleanFacultatif
isActivebooleanFacultatif

Réponses

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.

Les erreurs renvoient {"error": "..."}, souvent avec un code et des details. Voir erreurs et limites.

Costs and budgets