Execute Streaming Checklist

POST

Triggers a checklist to run continuously against assets. Returns a ChecklistAlreadyRunning error if the checklist is already running for the given asset.

Request

This endpoint expects an object.

checkliststringRequired

assetsset of stringsRequired

notificationConfigurationslist of objectsRequired

Checklist violations will be sent to the specified integrations. At least one integration must be specified.

evaluationDelayobjectRequired

Delays the evaluation of the streaming checklist. This is useful for when data is delayed.

recoveryDelayobjectRequired

Specifies the minimum amount of time that must pass before a check can recover from a failure. Minimum value is 15 seconds.

List Streaming Checklist

Up Next

Built with

1	curl -X POST https://api.gov.nominal.io/api/scout/v2/checklist-execution/execute-streaming-checklist \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"checklist": "checklist",
6	"assets": [
7	"assets"
8	],
9	"notificationConfigurations": [
10	{
11	"integrationRid": "integrationRid"
12	},
13	{
14	"integrationRid": "integrationRid"
15	}
16	],
17	"evaluationDelay": {
18	"seconds": 1000000,
19	"nanos": 1000000
20	},
21	"recoveryDelay": {
22	"seconds": 1000000,
23	"nanos": 1000000
24	}
25	}'