Flow service alert rule APIs

Alert rules are used to monitor and notify users about specific events or issues during flow service processing. You can create and manage alert rules by using these APIs.

GET - List alert rules

Retrieves the list of all alert rules that are created for flow services.

URL
../apis/v1/rest/configurations/alert-rules
Parameters
None
Request headers
Content-Type: application/json
X-INSTANCE-API-KEY: <generated API key>
Request body
None
Response
{
    "output": [
        {
            "name": "togglealert",
            "type": "FlowAlertRule",
            "description": "",
            "enabled": false,
            "events": {
                "success": true,
                "failed": true
            },
            "users": [
                "abc@ibm.com"
            ],
            "integrations": [
                {
                    "name": "add",
                    "type": "FlowService",
                    "project": "proj"
                }
            ]
        }
    ]
}

GET - Get alert rules

Retrieves the details about a specific alert rule.

URL
../apis/v1/rest/configurations/alert-rules/{flowAlertRuleName}?type=FlowAlertRule
Parameters
  • {flowAlertRuleName} - Name of the alert rule.
Request headers
Content-Type: application/json
X-INSTANCE-API-KEY: <generated API key>
Request body
None
Response
{
    "output": {
        "name": "togglealert",
        "type": "FlowAlertRule",
        "description": "",
        "enabled": false,
        "events": {
            "success": true,
            "failed": true
        },
        "users": [
            "abc@ibm.com"
        ],
        "integrations": [
            {
                "name": "add",
                "type": "FlowService",
                "project": "fl8e01070721c04186210365"
            }
        ]
    }
}

PUT - Update alert rules

Update the details about a specific alert rule.

URL
../apis/v1/rest/configurations/alert-rules/togglealert?type=FlowAlertRule
Parameters
None
Request headers
Content-Type: application/json
X-INSTANCE-API-KEY: <generated API key>
Request body
{
    "name": "togglealert",
    "type": "FlowAlertRule",
    "description": "my description",
    "enabled": false,
    "events": {
        "success": false,
        "failed": true
    },
    "users": [
        "abc@ibm.com"
    ],
    "integrations": [
        {
            "name": "add",
            "type": "FlowService",
            "project": "fl8e01070721c04186210365"
        }
    ]
}
Response
{
    "output": {
        "code": 0,
        "description": "Success"
    }
}

POST - Create alert rules

Create an alert rule.

URL
../apis/v1/rest/configurations/alert-rules?type=FlowAlertRule
Parameters
None
Request headers
Content-Type: application/json
X-INSTANCE-API-KEY: <generated API key>
Request body
{
    "name": "togglealert",
    "type": "FlowAlertRule",
    "description": "hello description",
    "enabled": false,
    "events": {
        "success": false,
        "failed": true
    },
    "users": [
        "abc@ibm.com"
    ],
    "integrations": [
        {
            "name": "add",
            "type": "FlowService",
            "project": "fl8e01070721c04186210365"
        }
    ]
}
Response
  • If the request is successful:
    {
    "output": {
        "code": 0,
        "description": "Success"
    }
}
  • If an error occurs:
    {
    "error": {
        "message": "AlertRule with name togglealert already exists.",
        "code": 400,
        "errorSource": {
            "errorCode": "IC_1118",
            "statusCode": 400,
            "requestID": "API-d5dc2963-a2d5-46a2-a1fb-67d1a31f0b20"
        }
    }
}

DELETE - Delete alert rules

Deletes an alert rule.

URL
../apis/v1/rest/configurations/alert-rules/testfsalert?type=FlowAlertRule
Parameters
None
Request headers
Content-Type: application/json
X-INSTANCE-API-KEY: <generated API key>
Request body
None
Response
  • If the request is successful, the HTTP Status Code 204 Not Content is displayed.
  • If an error occurs:
    {
    "error": {
        "message": "Alert name testfsalert does not exist",
        "code": 400,
        "errorSource": {
            "errorCode": "IC_1119",
            "statusCode": 400,
            "requestID": "API-4398c5e3-3ee6-40b7-8fa0-8ef1b2e5c2b8"
        }
    }
}

POST - Enable alert rules

Enable an alert rule.

URL
../apis/v1/rest/configurations/alert-rules/togglealert/activate?type=FlowAlertRule
Parameters
None
Request headers
Content-Type: application/json
X-INSTANCE-API-KEY: <generated API key>
Request body
None
Response
{
    "output": {
        "message": "togglealert's state is updated to activate"
    }
}

POST - Disable alert rules

Disable an alert rule.

URL
../apis/v1/rest/configurations/alert-rules/togglealert/deactivate?type=FlowAlertRule
Parameters
None
Request headers
Content-Type: application/json
X-INSTANCE-API-KEY: <generated API key>
Request body
None
Response
{
    "output": {
        "message": "togglealert's state is updated to deactivate"
    }
}

GET - Validate alert rule names

Validates an alert rule.

URL
../apis/v1/rest/configurations/alert-rules/{flowAlertRuleName}/validate
Parameters
  • {flowAlertRuleName} - Name of the flow service.
Request headers
Content-Type: application/json
X-INSTANCE-API-KEY: <generated API key>
Request body
None
Response
  • If response is successful:
    {
    "output": {
        "code": 0,
        "description": "Success"
    }
}
  • If response fails:
    {
    "error": {
        "message": "AlertRule with name togglealert already exists.",
        "code": 400,
        "errorSource": {
            "errorCode": "IC_1120",
            "statusCode": 400,
            "requestID": "API-5ea23287-c33e-47e7-8929-97541232418a"
        }
    }
}

GET - Get alert frequency

Retrieves the frequency details of the alerts.

URL
../apis/v1/rest/configurations/alert-rules/frequency?type=FlowAlertRule
Parameters
None
Request headers
Content-Type: application/json
X-INSTANCE-API-KEY: <generated API key>
Request body
None
Response
{
    "output": 15
}

PUT - Import alert rules

Retrieves the frequency details of the alerts.

URL
../apis/v1/rest/configurations/alert-rules
Parameters
None
Request headers
Content-Type: application/json
X-INSTANCE-API-KEY: <generated API key>
Request body
[
    {
        "name": "fsalert",
        "type": "FlowAlertRule",
        "description": "hello desc",
        "enabled": true,
        "events": {
            "success": true,
            "failed": true
        },
        "users": [
            "abc@ibm.com"
        ],
        "integrations": [
            {
                "name": "hellofs",
                "type": "FlowService",
                "project": "proj"
            }
        ]
    }
]
Response
{
    "output": [
        {
            "name": "fsalert",
            "status": "success"
        }
    ]
}