Skip to main content

deleteCustomGroup

This method deletes a custom group.

Services

This method requires you to place the {service} name in the API URL. The allowed services are:

  • computers, for "Computers and Virtual Machines"

  • virtualmachines, for "Virtual Machines"

For example, the request URL for the virtual machines service is:

https://YOUR-HOSTNAME/api/v1.0/jsonrpc/network/virtualmachines

Parameters

Parameter

Type

Optional

Description

groupId

String

No

The ID of the custom group to be deleted

force

Boolean

Yes

Force delete when group is not empty. By default, the parameter is set to False.

Return value

This method does not return any value.

Example

Request:

  {
       "params": {
           "groupId": "559bd17ab1a43d241b7b23c6",
           "force": true
       },
       "jsonrpc": "2.0",
       "method": "deleteCustomGroup",
       "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f"
  }

Response:

  {
      "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
      "jsonrpc":"2.0",
      "result": null
  }
In this section: