Modify Auto Discovery Configuration¶

POST /api/v1/issue_auto_discovery/{cfg_uuid}/modify

Overview¶

Route Parameters¶

Parameter Name	Type	Required	Description
cfg_uuid	string	Y	Issue Auto Discovery Configuration UUID

Body Request Parameters¶

Parameter Name	Type	Required	Description
name	string	Y	Title Name Example: name Allow Empty: False Max Length: 256
description	string		Description Example: description Allow Empty: False Allow Empty String: True
dqlNamespace	string	Y	Data Scope Example: rum Allow Empty: False Optional Values: ['keyevent']
every	integer	Y	Check Frequency (Time Length in Seconds) Example: 300 Allow Empty: False $minValue: 300 $maxValue: 3600 Optional Values: [60, 300, 600, 900, 1800, 3600]
conditions	string		DQL Query Filter Condition (Content Inside Curly Braces) Example: `source` IN ['kube-controller'] Allow Empty: False Allow Empty String: True
dimensions	array		Dimension Field List Example: ['chan_xxx1', 'chan_xxx2'] Allow Empty: False $minLength: 1
config	json	Y	Issue Definition Configuration Example: {} Allow Empty: False
config.name	string	Y	Title Name Example: name Allow Empty: False Max Length: 256
config.level	string		Level Example: level Allow Empty: False Allow Empty String: True
config.channelUUIDs	array		Channel UUID List Example: ['chan_xxx1', 'chan_xxx2'] Allow Empty: False
config.description	string		Description Example: description Allow Empty: False
config.extend	json		Additional Extended Information, Refer to the extend Field in Issue Creation, Generally Not Recommended to Set via OpenAPI Example: {} Allow Empty: True

Parameter Supplementary Explanation¶

Request Example¶

curl 'https://openapi.truewatch.com/api/v1/issue_auto_discovery/iatdc_xxxxx/modify' \
-H 'Content-Type: application/json' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-raw '{"name":"test-core-worker","description":"This is a test example for creating an issue auto discovery rule","every":300,"dqlNamespace":"keyevent","conditions":"`source` = \"lwctest\"","dimensions":["name"],"config":{"name":"This is the title in the issue definition","description":"This is the description in the issue definition after modification","level":"system_level_0","extend":{"text":"This is the description in the issue definition after modification","manager":["acnt_xxx"]},"channelUUIDs":["chan_xxxxx"]}}' \
--insecure

Response¶

{
    "code": 200,
    "content": {
        "conditions": "`source` = \"lwctest\"",
        "config": {
            "channelUUIDs": [
                "chan_xxxxx"
            ],
            "description": "This is the description in the issue definition after modification",
            "extend": {
                "manager": [
                    "acnt_xxxx"
                ],
                "text": "This is the description in the issue definition after modification"
            },
            "level": "system_level_0",
            "name": "This is the title in the issue definition"
        },
        "createAt": 1735893393,
        "creator": "wsak_xxxx",
        "declaration": {
            "organization": "xxx"
        },
        "deleteAt": -1,
        "description": "This is a test example for creating an issue auto discovery rule",
        "dimensions": [
            "name"
        ],
        "dqlNamespace": "keyevent",
        "every": 300,
        "id": 47,
        "name": "test-core-worker",
        "status": 0,
        "updateAt": 1735893669.0875816,
        "updator": "wsak_xxxx",
        "uuid": "iatdc_xxxx",
        "workspaceUUID": "wksp_xxxxx"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "1634728700182310814"
}