Update Rule Group

PUThttps://api.eu1.coralogix.com/mgmt/openapi/5/parsing-rules/rule-groups/v1/{group_id}

Replaces the specified parsing rule group with the request body. A field that the request omits takes its default, and the service sets new ids for every subgroup and rule.

Authorizations

Authorizationstringheaderrequired

API key authentication

The value is a Coralogix API key. Create a personal or team API key and assign its permissions.

Request

Path Parameters

group_id# stringrequired

The unique identifier of the parsing rule group to update.

Body

application/json

Request to create a new parsing rule group. Update takes the same body and replaces the whole group: a field that the request omits takes its default.

creator#string

Free-form name of the creator. The service stores it as sent. Defaults to an empty string.

description#string

Human-readable description. Defaults to an empty string.

enabled#boolean
Whether the group is enabled. Defaults to true.
Default value: true
hidden#boolean
A free-form flag for clients, for example to hide the group in a UI. The service stores and returns it and does not act on it. Defaults to false.
Default value: false
name#stringrequired

Display name. Must not be empty.

Possible values: non-empty

order#int64
Position of the group among the rule groups of the company. Defaults to 1. 0 places the group last. Groups can share an order: the service does not shift the other groups.
Possible values: >= 0
Default value: 1
ruleMatchers# object[]
The rule matchers.
ruleSubgroups# object[]required
The rule subgroups. At least one.
Possible values: >= 1
teamId# object
Ignored. The service takes the team from the credentials of the request.

Response

200400401500application/json

Response returned after successfully updating a parsing rule group.

ruleGroup# object
Rule group. Every scalar field except creator is always returned.