Entity Group: update

Description

Updates fields and tags of the specified entity group.

Unlike the replace method, fields and tags that are not specified in the request are left unchanged.

Similarly, fields that are set to null are ignored and are left unchanged.

Request

Method Path Content-Type Header
PATCH /api/v1/entity-groups/{group} application/json

Path Parameters

Name Type Description
group string Entity group name.

Fields

Refer to Fields specified in the Entity Group List method.

The name field specified in the payload is ignored by the server since the entity name is already specified in the path.

Response

Fields

None.

Example

Request

URI

PATCH /api/v1/entity-groups/nmon-aix

Payload

{
    "tags": {
        "os_type": "AIX"
    }
}

curl

curl https://atsd_hostname:8443/api/v1/entity-groups/nmon-aix \
  --insecure --include --user {username}:{password} \
  --header "Content-Type: application/json" \
  --request PATCH \
  --data '{"tags": {"os_type": "AIX"}}

Response

None.

Additional examples