Update Batch Rule

Updates a specified batch rule.

Required Permissions

Requires the ADMIN role or higher.

HTTP Request

cURL Example

curl -H "Authorization: Bearer <API_KEY>" \
     -d priority="LOW" \
     -d name="Scan web vulnerabilities" \
     -d schedule="*/10 * * * *"
     -d msg="Scan web vulnerabilities: $dst_ip" \
     -d query="table duration=30m weblog | search status >= 400 | stats count as error_count, dc(path) as page_count, values(concat(method, " ", path)) as request by src_ip | eval request = strjoin("\n", request) | lof eps=0.1 error_count, page_count | search _lof > 1.5 | sort -_lof" \
     -X PUT \
     https://HOSTNAME/api/sonar/batch-rules/410fe6af-b2f8-4674-af70-8d5b12ddc3fe

Request Parameters

Success Response

{}

Error Responses

Required argument is missing

HTTP status code 400

{
    "error_code": "null-argument",
    "error_msg": "schedule should be not null"
}

Invalid argument length

HTTP status code 400

{
    "error_code": "invalid-argument",
    "error_msg": "'address_field' must be shorter than or equal to 50 characters."
}

Invalid priority value

HTTP status code 400

{
    "error_code": "invalid-argument",
    "error_msg": "priority should be one of 'LOW', 'MEDIUM', 'HIGH'."
}

Identifier is not in valid GUID format

HTTP status code 400

{
    "error_code": "invalid-param-type",
    "error_msg": "category_guid should be guid type."
}

CRON expression is not valid

HTTP status code 400

{
    "error_code": "invalid-argument",
    "error_msg": "schedule has wrong cron expression format: * * * * * *"
}

Both dataset and query are not specified

HTTP status code 400

{
    "error_code": "null-argument",
    "error_msg": "query should be not null"
}

Invalid value for datetrunc

HTTP status code 400

{
    "error_code": "invalid-argument",
    "error_msg": "datetrunc should be one of 1 (1 second), 60 (1 minute), 3600 (1 hour), 86400 (1 day)."
}

Batch rule is not found

HTTP status code 500

{
    "error_code": "illegal-state",
    "error_msg": "batch rule not found: 9071a6fe-6b91-4448-9761-7123381cb026"
}

No privilege to create a batch rule

HTTP status code 500

{
    "error_code": "illegal-state",
    "error_msg": "no-permission"
}