Set a vendor's share of the plan

Requires manage partner scan allocations for partner staff, or
partner:allocations:manage for a partner API key. Set it right after onboarding a
vendor: on a plan, a vendor with no allocation cannot run scans the partner pays for.

States the whole allocation: an omitted on_exhaustion is block, an omitted
overage_cap is none. Takes effect on the vendor's next scan; scans already
run keep how they were covered.

With no plan in effect yet, the allocation is checked against the next scheduled
plan's allowance, so it can be set before that plan starts; it covers nothing until
then. Refused (422 on scans_per_cycle) when the partner has neither a current nor
a scheduled plan, when the sum
of every vendor's allocation would exceed the plan's scans, or when the vendor
has already used more than the new amount this cycle.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
Body Params
integer
required
≥ 0
string
enum
Defaults to block
Allowed:
integer | null
≥ 0

Only kept with overage. Null means no cap.

Responses

403

Missing manage partner scan allocations, or a key without partner:allocations:manage.

404

Not one of this partner's vendors.

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json