Rule Groups Service
Events2Metrics Service
Enrichments Service
Contextual data integration service
Custom Enrichments Service
Dashboard service
Dashboard folders service
Incidents service
- POSTList incidents with filters
- GETGet incident by ID
- GETGet incident events
- POSTAcknowledge incidents
- POSTAssign incidents to a user
- POSTGet multiple incidents by IDs
- POSTClose incidents
- POSTGet available filter values
- POSTList incident events with filters
- POSTGet available incident event filter values
- POSTGet total count of incident events
- POSTGet incident aggregations
- POSTResolve incidents
- POSTRemove incident user assignments
Integration service
- GETGet all integrations
- GETGet integration definition
- GETGet deployed integration
- DELDelete integration
- GETList managed integration keys
- GETGet managed integration status
- PUTUpdate integration
- POSTSave integration registration metadata
- POSTTest integration
- GETGet RUM integration versions data
- POSTTrigger sync of RUM integration data
- GETGet integration template
- GETGet integration details
Outgoing webhooks service
- GETList outgoing webhooks
- PUTUpdate an outgoing webhook
- POSTCreate an outgoing webhook
- GETList all outgoing webhooks
- GETList IBM event notification instances
- GETList outbound webhooks summary
- POSTTest an outgoing webhook
- POSTTest an existing outgoing webhook
- GETGet outgoing webhook types
- GETGet outgoing webhook type details
- GETGet outgoing webhook
- DELDelete an outgoing webhook
Policies Service
Retentions Service
Scopes Service
SLO Service
SAML Configuration Service
Team Permissions Management Service
- GETGet Team Group By Name
- PUTUpdate Team Group
- POSTCreate Team Group
- GETGet Team Groups
- POSTAdd Users To Team Groups
- DELRemove Users From Team Groups
- GETGet Team Group
- DELDelete Team Group
- GETGet Team Group Scope
- POSTSet Team Group Scope
- GETGet Group Users
- POSTAdd Users To Team Group
- DELRemove Users From Team Group
Folders for views
Actions Service
Target Service
Alert definitions service
Alert events service
API Keys Service
Rule Groups Service
Update Rule Group
PUT
/
api
/
v1
/
rulegroups
/
{groupId}
Copy
const fetch = require('node-fetch');
let url = 'https://api.coralogix.com/mgmt/openapi/api/v1/rulegroups/%7BgroupId%7D';
let options = {
method: 'PUT',
headers: {Authorization: 'Bearer <API_KEY>', 'content-type': 'application/json'},
body: '{"name":"string","description":"string","enabled":true,"hidden":true,"creator":"string","ruleMatchers":[{"applicationName":{"value":"string"},"subsystemName":{"value":"string"},"severity":{"value":"VALUE_DEBUG_OR_UNSPECIFIED"}}],"ruleSubgroups":[{"rules":[{"name":"string","description":"string","sourceField":"string","parameters":{"extractParameters":{"rule":"string"},"jsonExtractParameters":{"destinationFieldType":"DESTINATION_FIELD_CATEGORY_OR_UNSPECIFIED","rule":"string","destinationFieldText":"string"},"replaceParameters":{"destinationField":"string","replaceNewVal":"string","rule":"string"},"parseParameters":{"destinationField":"string","rule":"string"},"allowParameters":{"keepBlockedLogs":true,"rule":"string"},"blockParameters":{"keepBlockedLogs":true,"rule":"string"},"extractTimestampParameters":{"standard":"FORMAT_STANDARD_STRFTIME_OR_UNSPECIFIED","format":"string"},"removeFieldsParameters":{"fields":["string"]},"jsonStringifyParameters":{"destinationField":"string","deleteSource":true},"jsonParseParameters":{"destinationField":"string","deleteSource":true,"escapedValue":true,"overrideDest":true}},"enabled":true,"order":0}],"enabled":true,"order":0}],"order":0,"teamId":{"id":0}}'
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error('error:' + err));
Copy
{
"ruleGroup": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"creator": "<string>",
"enabled": true,
"hidden": true,
"ruleMatchers": [
{
"applicationName": {
"value": "<string>"
},
"subsystemName": {
"value": "<string>"
},
"severity": {
"value": "VALUE_DEBUG_OR_UNSPECIFIED"
}
}
],
"ruleSubgroups": [
{
"id": "<string>",
"rules": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"sourceField": "<string>",
"parameters": {
"extractParameters": {
"rule": "<string>"
},
"jsonExtractParameters": {
"destinationFieldType": "DESTINATION_FIELD_CATEGORY_OR_UNSPECIFIED",
"rule": "<string>",
"destinationFieldText": "<string>"
},
"replaceParameters": {
"destinationField": "<string>",
"replaceNewVal": "<string>",
"rule": "<string>"
},
"parseParameters": {
"destinationField": "<string>",
"rule": "<string>"
},
"allowParameters": {
"keepBlockedLogs": true,
"rule": "<string>"
},
"blockParameters": {
"keepBlockedLogs": true,
"rule": "<string>"
},
"extractTimestampParameters": {
"standard": "FORMAT_STANDARD_STRFTIME_OR_UNSPECIFIED",
"format": "<string>"
},
"removeFieldsParameters": {
"fields": [
"<string>"
]
},
"jsonStringifyParameters": {
"destinationField": "<string>",
"deleteSource": true
},
"jsonParseParameters": {
"destinationField": "<string>",
"deleteSource": true,
"escapedValue": true,
"overrideDest": true
}
},
"enabled": true,
"order": 123
}
],
"enabled": true,
"order": 123
}
],
"order": 123
}
}
Authorizations
API key authentication
Path Parameters
Body
application/json
Response
200
application/json
A successful response.
The response is of type object
.
Copy
const fetch = require('node-fetch');
let url = 'https://api.coralogix.com/mgmt/openapi/api/v1/rulegroups/%7BgroupId%7D';
let options = {
method: 'PUT',
headers: {Authorization: 'Bearer <API_KEY>', 'content-type': 'application/json'},
body: '{"name":"string","description":"string","enabled":true,"hidden":true,"creator":"string","ruleMatchers":[{"applicationName":{"value":"string"},"subsystemName":{"value":"string"},"severity":{"value":"VALUE_DEBUG_OR_UNSPECIFIED"}}],"ruleSubgroups":[{"rules":[{"name":"string","description":"string","sourceField":"string","parameters":{"extractParameters":{"rule":"string"},"jsonExtractParameters":{"destinationFieldType":"DESTINATION_FIELD_CATEGORY_OR_UNSPECIFIED","rule":"string","destinationFieldText":"string"},"replaceParameters":{"destinationField":"string","replaceNewVal":"string","rule":"string"},"parseParameters":{"destinationField":"string","rule":"string"},"allowParameters":{"keepBlockedLogs":true,"rule":"string"},"blockParameters":{"keepBlockedLogs":true,"rule":"string"},"extractTimestampParameters":{"standard":"FORMAT_STANDARD_STRFTIME_OR_UNSPECIFIED","format":"string"},"removeFieldsParameters":{"fields":["string"]},"jsonStringifyParameters":{"destinationField":"string","deleteSource":true},"jsonParseParameters":{"destinationField":"string","deleteSource":true,"escapedValue":true,"overrideDest":true}},"enabled":true,"order":0}],"enabled":true,"order":0}],"order":0,"teamId":{"id":0}}'
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error('error:' + err));
Copy
{
"ruleGroup": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"creator": "<string>",
"enabled": true,
"hidden": true,
"ruleMatchers": [
{
"applicationName": {
"value": "<string>"
},
"subsystemName": {
"value": "<string>"
},
"severity": {
"value": "VALUE_DEBUG_OR_UNSPECIFIED"
}
}
],
"ruleSubgroups": [
{
"id": "<string>",
"rules": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"sourceField": "<string>",
"parameters": {
"extractParameters": {
"rule": "<string>"
},
"jsonExtractParameters": {
"destinationFieldType": "DESTINATION_FIELD_CATEGORY_OR_UNSPECIFIED",
"rule": "<string>",
"destinationFieldText": "<string>"
},
"replaceParameters": {
"destinationField": "<string>",
"replaceNewVal": "<string>",
"rule": "<string>"
},
"parseParameters": {
"destinationField": "<string>",
"rule": "<string>"
},
"allowParameters": {
"keepBlockedLogs": true,
"rule": "<string>"
},
"blockParameters": {
"keepBlockedLogs": true,
"rule": "<string>"
},
"extractTimestampParameters": {
"standard": "FORMAT_STANDARD_STRFTIME_OR_UNSPECIFIED",
"format": "<string>"
},
"removeFieldsParameters": {
"fields": [
"<string>"
]
},
"jsonStringifyParameters": {
"destinationField": "<string>",
"deleteSource": true
},
"jsonParseParameters": {
"destinationField": "<string>",
"deleteSource": true,
"escapedValue": true,
"overrideDest": true
}
},
"enabled": true,
"order": 123
}
],
"enabled": true,
"order": 123
}
],
"order": 123
}
}
Assistant
Responses are generated using AI and may contain mistakes.