ESET PROTECT On-Prem

Offline | Go online

ESET PROTECT On-Prem – Table of Contents

# List all device groups

Copy current article URL Share via email

Relative path: /v1/device_groups

Hierarchy can be reconstructed from the returned `device_groups`.

### URL example

https://10.1.180.105:9443/v1/device_groups

### Query parameters

Name | Type | Description
--- | --- | ---
pageSize | integer | Limit for pagination purposes. If unspecified or 0, the default value is 100. The maximum value is 10000; values above 10000 will be coerced to 10000. 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+Headers instead of an Example or vice-versa

Code | Description and Example | Description, Schema and Headers
--- | --- | ---
200 | A successful response. Response example
    {
      "deviceGroups": [
        {
          "displayName": "string",
          "isSecurityGroup": true,
          "linkedEntityType": "DEVICE_GROUP_ENTITY_TYPE_UNSPECIFIED",
          "parentGroupUuid": "string",
          "uuid": "string",
          "etag": "string"
        }
      ],
      "nextPageToken": "string"
    }
| A successful response. Response schema
    {
      "$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'"
          },
          "etag": {
            "type": "string",
            "description": "The entity tag (or ETag) can be thought of as a snapshot of a resourceâ€™s state at a given revision and can used for optimistic concurrency control and validating entity freshness. It is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. An entity-tag consists of an opaque quoted string (hash or checksum), possibly prefixed by a weakness indicator as specified in RFC2616, Section 13.3.3 eTag value must follow RFC7232, Section 2.3 and google's specification. Info: eTag can be used as a complementary to mechanism to revisioning, where: - Revisions for tracking history and allowing access to previous versions google's AIP 162 - ETags for concurrency control and validating freshness google's AIP 154 The same resource may expose revision_id that clients can list or roll back to past snapshots and also eTag, which - serve as a practical implementation of revisions for managing resource versions in real-time operations. - ensure that clients operate on the expected version of a resource, preventing conflicts in concurrent scenarios (e.g., two clients trying to update the same resource simultaneously). In contrast to revisions ETags donâ€™t provide a full revision history (like a version control system). However, they enable safe updates and deletes by tying each operation to a specific resource stateâ€”effectively a revision."
          }
        }
      ],
      "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"
      }
    }
default | An unexpected error response. Response example
    {
      "code": 0,
      "message": "string",
      "details": [
        {
          "@type": "string"
        }
      ]
    }
| An unexpected error response. Response schema
    {
      "$ref": "rpcStatus",
      "description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.",
      "code": {
        "type": "integer",
        "description": "The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].",
        "format": "int32"
      },
      "message": {
        "type": "string",
        "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client."
      },
      "details": [
        {
          "$ref": "protobufAny",
          "description": "Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a message in C++. Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... } Example 2: Pack and unpack a message in Java. Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } Example 3: Pack and unpack a message in Python. foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ... The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example 'foo.bar.com/x/y.z' will yield type name 'y.z'. JSON The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example: package google.profile; message Person { string first_name = 1; string last_name = 2; } { '@type': 'type.googleapis.com/google.profile.Person', 'firstName': <string>, 'lastName': <string> } If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]): { '@type': 'type.googleapis.com/google.protobuf.Duration', 'value': '1.212s' }",
          "@type": {
            "type": "string",
            "description": "A URL/resource name whose content describes the type of the serialized protocol buffer message. For URLs which use the scheme http, https, or no scheme, the following restrictions and interpretations apply: If no scheme is provided, https is assumed. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading '.' is not accepted). An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics."
          }
        }
      ]
    }

˄˅