Update a security group

Renames the group or changes its comment.

Authorization

bearerAuth

AuthorizationBearer <token>

API key created in the portal (Settings → API Keys). Send as Authorization: Bearer <key>.

In: header

Path Parameters

project_uuid*string

Project UUID.

uuid*string

Security group UUID.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Rename a security group or change its comment. Send at least one field.

display_name?string

New name. Latin letters, digits, hyphens and underscores, starting with a letter, at most 15 characters. Stored in lower case; spaces become underscores. Renaming changes pve_group_name, and VM rules that use the group follow automatically.

comment?string

Free-text comment.

Response Body

`application/json`

curl -X PATCH "https://example.com/cloud/project/string/firewall/groups/string/" \  -H "Content-Type: application/json" \  -d '{}'

{  "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",  "display_name": "string",  "pve_group_name": "string",  "comment": "string"}