Sign in

One group definition (parent, enabled, limits, child_default)

Changed on
get/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

Response

OK

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