Select the tab
ESET Connect – Table of Contents

GET List all device groups

Relative path: /v1/device_groups

Hierarchy can be reconstructed from the returned device_groups.

Query parameters

Name

Type

Description

pageSize

integer

Limit for pagination purposes.

If unspecified or 0, the default value is 50. The maximum value is 1000; values above 1000 will be coerced to 1000.

Info: For more information, refer to Paginating Requests in APIs

or Design Patterns: Pagination

pageToken

string

Page token of the current page.

If not given or "", the first page is returned.

Info: For more information, refer to Paginating Requests in APIs

or Design Patterns: Pagination

Responses

Display Schema instead of an Example or vice-versa

Code

Description

Example

Schema

200

Successful response.

 
{
  "deviceGroups": [
    {
      "displayName": "string",
      "isSecurityGroup": true,
      "linkedEntityType": "DEVICE_GROUP_ENTITY_TYPE_UNSPECIFIED",
      "parentGroupUuid": "string",
      "uuid": "string"
    }
  ],
  "nextPageToken": "string"
}
 
{
  "$ref": "v1ListGroupsResponse",
  "deviceGroups": [
    {
      "$ref": "v1DeviceGroup",
      "description": "Migration from EPC: Static groups have is_security_group == true Dynamic groups have is_security_group == false All and Lost&Found are just ordinary groups.",
      "displayName": {
        "title": "Name given by the user to identify the group",
        "type": "string"
      },
      "isSecurityGroup": {
        "type": "boolean",
        "description": "If true, the group represents a security group - a resource group for controlling access rights. Info: Alternative names: - static group (ERA, ESMC, EPC) - access group (ESMC, EPC) - resource group (Azure)"
      },
      "linkedEntityType": {
        "$ref": "v1DeviceGroupEntityType",
        "type": "string",
        "description": "Possible entities that Device Group represents. DEVICE_GROUP_ENTITY_TYPE_UNSPECIFIED: fallback DEVICE_GROUP_ENTITY_TYPE_COMPANY: Group representing [company] DEVICE_GROUP_ENTITY_TYPE_MSP: Group representing [MSP] DEVICE_GROUP_ENTITY_TYPE_SITE: Group representing [site] DEVICE_GROUP_ENTITY_TYPE_HOUSEHOLD: Group representing [household]",
        "default": "DEVICE_GROUP_ENTITY_TYPE_UNSPECIFIED",
        "enum": [
          "DEVICE_GROUP_ENTITY_TYPE_UNSPECIFIED",
          "DEVICE_GROUP_ENTITY_TYPE_COMPANY",
          "DEVICE_GROUP_ENTITY_TYPE_MSP",
          "DEVICE_GROUP_ENTITY_TYPE_SITE",
          "DEVICE_GROUP_ENTITY_TYPE_HOUSEHOLD"
        ]
      },
      "parentGroupUuid": {
        "title": "Reference to parent [group]",
        "type": "string"
      },
      "uuid": {
        "type": "string",
        "description": "Unique identifier of the entity. Must be collision-free - two identifiers created anywhere in the world must not collide within the entity parent scope. Unless a member of aggregate, the entity scope is always global. Although most of the times compliant with RFC 4122: A Universally Unique IDentifier (UUID) URN Namespace, do not rely on it being a RFC UUID. Treat it as an opaque identifier. RFC UUID can be recognized by being formatted according to the template xxxxxxxx-xxxx-Mxxx-Nxxx-xxxxxxxxxxxx, as explained on Wikipedia. UUID is used for referencing an entity, even across domains. Example: '123e4567-e89b-12d3-a456-426614174000'"
      }
    }
  ],
  "nextPageToken": {
    "type": "string",
    "description": "Page token of the next page. Empty or '' for the last page. Info: For more information, refer to Paginating Requests in APIs or Design Patterns: Pagination"
  }
}

202

Response took too long; request cached. Response can be retrieved later using the response-id header.

 
null
 
[]

400

One of the errors: 1. Bad or missing authorization. 2. Validation error. Invalid argument provided.

 
null
 
[]

401

Token has expired or is invalid.

 
null
 
[]

403

Access denied. Check permissions.

 
null
 
[]

404

Requested resource not found.

 
null
 
[]

429

Rate limit reached. Try again later.

 
null
 
[]

500

Internal server failure. Try again later.

 
null
 
[]

502

Internal server failure. Try again later.

 
null
 
[]

503

Environment under maintenance. Try again later.

 
null
 
[]

504

Action took too long; timeout reached

 
null
 
[]