Usage Limits

Update usage limit

Replace an existing usage limit config for a deployment.

post/update_usage_limit/{id}

Request

  • Base URL: https://happy-animal-123.convex.cloud/api/v1
  • URL: https://happy-animal-123.convex.cloud/api/v1/update_usage_limit/{id}
  • Auth: one of:
    • API key in header Authorization
    • API key in header Authorization
    • API key in header Authorization
    • API key in header Authorization

Path parameters

idstring required

id of the usage limit to update

Request body

metric'functionCalls' | 'databaseIoGb' | 'dataEgressGb' | 'searchQueryGb' | 'queryMutationComputeGbHours' | 'actionComputeConvexGbHours' | 'actionComputeNodeJsGbHours' | 'actionComputeCpuGbHours' required
window'day' | 'month' required

The calendar-aligned window a limit is measured over.

limitType'warning' | 'disable' required
limitinteger required
enabledboolean required

Response

Changes

No recorded changes to this operation across all 1 revision of this API.