List Device Groups

Http Method: GET
URL Path: /v1/a/
Response Type: application/json
Required Permissions: ViewDeviceGroups

Returns an array of Device Groups available to the caller.

---

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 API key is invalid, or does not have permission to access this resource. Check that the Key is correct and has suitable permissions.
500	Server side error, such as inaccessible database. Please contact Star if this occurs frequently.

Response Body

In case of a successful call, a JSON body will be returned by the service, containing an array of Device Group information.

Example

[{
    "Name": "Device Group 1",
    "MatchPath": "dgrp1",
    "AutoCreateDeviceQueue": true,
    "Enabled": true,
    "RequireDeviceKey": false,
    "Created": "2020-12-18T13:11:27.2112355"
}, {
    "Name": "Device Group 2",
    "MatchPath": "dgrp2",
    "AutoCreateDeviceQueue": true,
    "Enabled": true,
    "RequireDeviceKey": false,
    "Created": "2021-03-19T11:48:36.1617301"
}]

Returns an array of device information objects, each object providing the following fields:

Field	Info
Name	String: Assigned full name of the Device Group
MatchPath	String: path element used for identifying th Device Group ins API calls
AutoCreateDeviceQueue	Boolean: Indicate that new devices connecting to this devices CloudPRNT endpoint URL will be automatically registered.
Enabled	Boolean: Global setting to show that the whole Device Group is enabled for use
RequireDeviceKey	Boolean: Indicate if a per-device key is required to connect a device to this group
Created	String: UTC Date/Time of the groups creation

---

Usage Example

An example, using curl to retrieve the list of the callers Device Groups`.

curl --header "Star-Api-Key: 6800ffd6-2367-4c8d-b067-d6a28151276a" https://beta.starprinter.online/v1/a