TrueSight API Documentation
OverviewAccountActionsAdministration
Alarms v1Alarms v2BatchingDashboards
DatasetsEventsExtended Metrics
HostgroupsGroupsMetersMetricsProduct
PluginsRelaysSourcesSynchronize Data
Tenants
Terms

PUT/v1/groups/:id

Adds or updates a specific group by group name slug.

Request url parameters

id

The sluggified version of name. The name property must match this or the response will be 400.

Request body properties

name

The human readable name that will be used to refer to the group throughout the system. If the name property is not supplied a 400 response will be returned. This must match the sluggified version of the id url parameter or the response will be 400.

query

The query which will be used to pull sources for this group. If the query property is not supplied a 400 response will be returned.

Example request:

curl https://api.truesight.bmc.com/v1/groups/:id \
-X PUT \
-u <email>:<api-token> \
-H "Content-Type: application/json" \
-d '
{
   "name": "prod servers",
   "query": "*prod* && last: 2h"
}'

Response:

{
   "id": "prod-servers",
   "name": "prod servers",
   "tenantId": "78facb56-f21c-40bb-9cb5-ddae78fb47b8",
   "query": "*prod* && last: 2h"
}