Sign in
WorkerGroups

Update a worker group

Requires a role with the INFRASTRUCTURE permission (Superadmin-only).

put/api/v1/instance/workergroups/{id}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/instance/workergroups/{id}
  • Auth: one of:
    • HTTP bearer
    • HTTP basic

Path parameters

idstring required

Request body

keystring required

The key of the worker group.

descriptionstring

The description of the worker group.

allowedTenantsstring[]

Response

updateWorkerGroupById 200 response

idstring

The ID of worker group.

keystring

The key of the worker group.

descriptionstring

The description of the worker group.

allowedTenantsstring[]

Changes

No recorded changes to this operation across all 7 revisions of this API.