Local API V2 – Profile Groups Interface

List Profile Groups

Endpoint

GET /openapi/v2/profile-groups

Returns a list of Profile Groups.

Query Parameters

Name	Type	Required	Description
request	string	Yes	Parameters for listing Profile Groups.

Response Parameters

data.list contains the list of Profile Groups:

Name	Type	Description
id	string	Profile Group ID.
name	string	Profile Group name.
remark	string	Notes.

Create a Profile Group

Endpoint

POST /openapi/v2/profile-groups

Creates a Profile Group.

Request Parameters

Name	Type	Required	Description
name	string	No	Profile Group name.
remark	string	No	Notes.

Request Example

{
  "name": "automation group",
  "remark": "created by Local API V2"
}

Get Profile Group Details

Endpoint

GET /openapi/v2/profile-groups/{groupId}

Returns the details of a Profile Group.

Path Parameters

Name	Type	Required	Description
groupId	string	Yes	Profile Group ID.

Update a Profile Group

Endpoint

PATCH /openapi/v2/profile-groups/{groupId}

Updates a Profile Group.

Path Parameters

Name	Type	Required	Description
groupId	string	Yes	Profile Group ID.

Request Parameters

Name	Type	Required	Description
name	string	No	Profile Group name.
remark	string	No	Notes.

Delete a Profile Group

Endpoint

DELETE /openapi/v2/profile-groups/{groupId}

Deletes a Profile Group. Before deleting it, confirm that the Profile Group is no longer needed.

Path Parameters

Name	Type	Required	Description
groupId	string	Yes	Profile Group ID.