Skip to main content
PATCH
Allocate Concurrency to a Ringg Space
Allocations across all Ringg Spaces cannot exceed the capacity bought on the primary. The same call rebalances capacity between clients or teams later.

Notes

  • concurrency is absolute, not a delta. Lowering an allocation always succeeds; raising it must fit family.concurrency_available from Get Ringg Spaces.
  • limit_concurrency in the response is the persisted ceiling. In an individual-billing family it equals the allocation. In a common-billing family it is the family total, because idle capacity is shared, so it can be larger than concurrency.
  • This is the only allocation endpoint that applies to common-billing families; money is pooled on the primary there.
  • When family.concurrency_available reaches 0, buy more capacity on the primary, then allocate the new slots here.

Errors

  • 400: Only 30 concurrent calls are available to allocate from the parent workspace (capacity 50, 20 already allocated to other sub-workspaces). — the allocation does not fit.
  • 400: Sub-workspaces cannot have their own sub-workspaces. — the key belongs to a Ringg Space that has Ringg Spaces enabled.
  • 401: Invalid or missing API key.
  • 403: Sub-workspaces are not enabled for this workspace. — Ringg Spaces are not enabled on the primary, or the key belongs to a Ringg Space.
  • 404: Sub-workspace not found — no active Ringg Space with this ID under your primary.
  • 422: sub_workspace_id is not a UUID, or concurrency is negative or missing.

Authorizations

X-API-KEY
string
header
required

Headers

X-API-KEY
string
required

(Required) The API key of the PRIMARY workspace. A Ringg Space's own key is refused (403, or 400 if Ringg Spaces are enabled on it).

Example:

"rg_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Path Parameters

sub_workspace_id
string<uuid>
required

(Required) ID of the Ringg Space.

Example:

"00000000-0000-4000-8000-000000000101"

Body

application/json
concurrency
integer
required

(Required) Concurrent calls to allocate to this Ringg Space. 0 stops it from calling.

Required range: x >= 0
Example:

20

Response

Successful Response: The new allocation and the family totals.

message
string
Example:

"Mumbai Collections now has 20 concurrent calls"

sub_workspace_id
string
Example:

"00000000-0000-4000-8000-000000000101"

concurrency
integer
Example:

20

limit_concurrency
integer

The persisted ceiling: equals concurrency in an individual-billing family, the family total in a common-billing family.

Example:

20

primary
object
family
object