Entity Group: get entities

Description

Retrieves a list of entities that are members of the specified entity group and are matching the specified filter conditions.

Request

Method Path
GET /api/v1/entity-groups/{group}/entities

Path Parameters

Name Description
group [Required] Entity group name.

Query Parameters

Name Type Description
expression string Expression to include entities by name or by entity tags. Use the name field for entity name. The wildcard * is supported.
minInsertDate string Include entities with last insert date at or greater than specified time.
minInsertDate can be specified in ISO format or using calendar keywords.
maxInsertDate string Include entities with last insert date less than specified time.
maxInsertDate can be specified in ISO format or using calendar keywords.
limit integer Maximum number of entities to retrieve, ordered by name.
tags string Comma-separated list of entity tag names to include in the response, for example, tags=OS,location.
Specify tags=* to include all entity tags.
Specify tags=env.* to include all metric tags starting with env..
addInsertTime boolean Controls whether lastInsertDate field is included in the response.
The default value is inherited from the default.addInsertTime setting on the Settings > Server Properties page which is set to true by default.

Response

Fields

Refer to fields specified in Entity List method.

Example

Request

URI

GET /api/v1/entity-groups/nur-entities-name/entities?tags=*&limit=3

Payload

None.

curl

curl "https://atsd_hostname:8443/api/v1/entity-groups/nur-entities-name/entities?tags=*&limit=3" \
  --insecure --include --user {username}:{password}

Response

[
    {
        "name": "atsd_hostname",
        "enabled": true,
        "tags": {}
    },
    {
        "name": "nurswgvml003",
        "enabled": true,
        "lastInsertDate": "2015-09-04T15:43:36.000Z",
        "tags": {
            "app": "Shared NFS/CIFS disk, ntp server",
            "ip": "192.0.2.2",
            "os": "Linux"
        }
    },
    {
        "name": "nurswgvml004",
        "enabled": true,
        "tags": {}
    }
]

Additional examples