Delete a Device group
Http Method: DELETE
URL Path: /v1/a/{groupPath}
Response Type: no response body
Required Permissions: DeleteDeviceGroups
Remove a Device Group from the service. The Device Group must belong to the account authenticated by the API key.
Note
A Device Group can not be deleted if any devices are currently registered to it. In this case, it would be recommended to first disable device auto registreation, then remove all devices, before finally deleting the device group.
Important
Standard beta accounts on the beta service do not have the DeleteDeviceGroups permission and so can not call this method. To remove an existing device group please contact Star.
Request
Path Parameters
groupPath
The {groupPath} parameter provides the path identifier of the Device Group to be deleted. This Device Group must be owned by the account authenticated by the calling API Key.
Response
Return Codes
| Code | Description |
|---|---|
| 200 | Success, check the returned body data for the device list. |
| 400 | BadRequest, unable to process the request, check calling path. |
| 403 | Forbidden, the authenticated API key does not have permission to access this resource. Check that the Key is correct and has suitable permissions. |
| 404 | Not Found, no device group owned by the authenticated account can be found. |
| 409 | Conflict, unable to complete the request due to resource conflict. Usually because devices are still registered for this Device Group. |
| 500 | Server side error, such as inaccessible database. Please contact Star if this occurs frequently. |
Usage Example
Using curl to remove a Device Group with a path name of examplegroup.
curl -X DELETE --header "Star-Api-Key: 6800ffd6-2367-4c8d-b067-d6a28151276a" https://beta.starprinter.online/v1/a/examplegroup