Skip to content

Set the egress cap

Set, remove or reset the monthly egress spending cap. At the cap, internet egress is limited to 5 Mbit/s per pool until the month ends or the cap increases.

Parameters

#
amountstring
Monthly egress spending cap in dollars, zero or more.
offboolean
Turn off the monthly egress cap.
defaultboolean
Use the total monthly cost of your plans as the egress cap.
organizationstring
Organization name or ID. A credential, named resource or sole membership can select the organization for you.

Returns

#
dataobjectAlways present
The account's monthly internet egress and egress cap.
Show 12 attributesHide attributes
allowance_bytesintegerAlways present
Internet egress included for the month, in bytes.
capstringAlways present
Egress cap setting: default, amount or off.
cap_microsinteger
Monthly cap in millionths of a dollar. Absent when the cap is off. May be omitted.
charged_microsintegerAlways present
Egress charged so far this month, in millionths of a dollar.
chargingbooleanAlways present
Whether egress overage is currently billed.
monthstring (date-time)Always present
Month being measured.
not_charged_bytesinteger
Overage bytes not charged while the wallet was past its grace period. May be omitted.
over_bytesintegerAlways present
Usage above the included allowance, in bytes.
projected_bytesintegerAlways present
Estimated monthly egress based on use so far, in bytes.
slowedbooleanAlways present
Whether the account's internet egress is currently slowed because of its egress cap, its spending cap or its wallet state.
used_bytesintegerAlways present
Internet egress used this month, in bytes.
would_charge_microsinteger
What overage would cost if charging were enabled, in millionths of a dollar. May be omitted.

Errors

#
CodeStatusWhat happened
invalid400An input is missing or invalid.
unauthenticated401The credential is missing, invalid, expired or revoked.
denied403The caller lacks permission for this action.
not_found404The resource is absent or inaccessible to this caller.
conflict409The request conflicts with the current resource state or an earlier request.
over_capacity409The request exceeds a resource or credential allowance.
access_list_full409The change would exceed the access-list allowance.
payment_required402Payment or credit is required.
rate_limited429The caller's request rate exceeds its limit.
busy429Too much work is in progress to accept this request.
unknown503The outcome is unconfirmed; a change may have happened.
unavailable503The service or requested feature is unavailable.

Notes

#
  • CLI: heaven login with HEAVEN_API_KEY unset. MCP: Heaven sign-in. cURL: HEAVEN_SIGN_IN_KEY from approved device sign-in (POST /v1/auth/create).
  • A key limited to a command list cannot run this command.
  • Amount: Limit monthly egress charges to the chosen amount. Required: amount. Optional: organization.
  • Off: Remove the limit on monthly egress charges. Required: off. Optional: organization.
  • Default: Set the egress cap to the cost of the month's plans. Required: default. Optional: organization.