Replace an overlay group definition, live immediately (limits rebuilt)

Changed on
put/api/v1/admin/groups/{name}

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header x-admin-token
    • HTTP bearer

Path parameters

namestring required

Headers

If-Matchstring

Optimistic concurrency: the resource's ETag from a prior read (or the ETag returned by the previous mutation). Stale = 409 version_conflict (re-read and retry), nothing changes; absent or * = unconditional.

Request body

configobject required

A groups: entry, as JSON. The accepted shape is the config file's own, documented in the configuration reference; it is not restated here because several of its types parse a wire shape that does not match their field layout.

Response

The replaced group

enabledboolean required

false FREEZES the group (every request charging through it is rejected; history kept).

namestring required
parentstring nullable

The parent group whose limits this one is ANDed under (the enforcement chain). None = a root group. Skipped from the body when absent.

Changes