TrueSight API Documentation
OverviewAccountActionsAdministration
Alarms v1Alarms v2BatchingDashboards
DatasetsEventsExtended Metrics
GroupsHostgroupsMetersMetricsProduct
PluginsRelaysSourcesSource-TagsSynchronize Data
Tenants
Terms

PUT/v1/groups/:id

Creates or updates a group for a given id.

URL parameters

id

The slugified version of name. The id property must match the slugified version of the name property in the request body or the response will be HTTP 400 Bad Request.

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 the response will be HTTP 400 Bad Request.

query

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

Example request:

curl https://api.truesight.bmc.com/v1/groups/prod-servers \
-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",
   "query": "*prod* && last: 2h",
   "tenantId": "78facb56-f21c-40bb-9cb5-ddae78fb47b8"
}