Manage Kapacitor Flux task runs
Use the kapacitor CLI or the Kapacitor HTTP API to manage Kapacitor Flux task runs.
Each Flux task execution is considered a “run.”
List Kapacitor Flux task runs
Use the following request method and endpoint to list Kapacitor Flux task runs.
GET /kapacitor/v1/api/v2/tasks/{taskID}/runs
Provide the following with your request (* Required):
Headers
- * Content-type: application/json
Path parameters
- * taskID: Task ID
Query parameters
- after: List task runs after a specific run ID
- afterTime: Return task runs that occurred after this time (RFC3339 timestamp)
- beforeTime: Return task runs that occurred before this time (RFC3339 timestamp)
- limit: Limit the number of task runs returned (default is 100)
API examples
The following examples use the task ID 000x00xX0xXXx00.
- List all runs for a Flux task
- List a limited number of runs for a Flux task
- List Flux task runs after a specific run ID
- List Flux task runs that occurred in a time range
List all runs for a Flux task
curl --GET 'http://localhost:9092/kapacitor/v1/api/v2/tasks/000x00xX0xXXx00/runs' \
--header 'Content-Type: application/json'
List a limited number of runs for a Flux task
curl --GET 'http://localhost:9092/kapacitor/v1/api/v2/tasks/000x00xX0xXXx00/runs' \
--header 'Content-Type: application/json' \
--data-urlencode "limit=10"
List Flux task runs after a specific run ID
curl --GET 'http://localhost:9092/kapacitor/v1/api/v2/tasks/000x00xX0xXXx00/runs' \
--header 'Content-Type: application/json' \
--data-urlencode "after=XXX0xx0xX00Xx0X"
List Flux task runs that occurred in a time range
curl --GET 'http://localhost:9092/kapacitor/v1/api/v2/tasks/000x00xX0xXXx00/runs' \
--header 'Content-Type: application/json' \
--data-urlencode 'afterTime=2021-01-01T00:00:00Z' \
--data-urlencode 'beforeTime=2021-01-31T00:00:00Z'
Retry a Kapacitor Flux task run
Use the following request method and endpoint to retry a Kapacitor Flux task run.
POST /kapacitor/v1/api/v2/tasks/{taskID}/runs/{runID}/retry
Provide the following with your request (* Required):
Path parameters
- * taskID: Task ID
- * runID: Run ID to retry
# Retry run ID XXX0xx0xX00Xx0X for task ID 000x00xX0xXXx00
curl --request POST \
'http://localhost:9092/kapacitor/v1/api/v2/tasks/000x00xX0xXXx00/runs/XXX0xx0xX00Xx0X'
For an easy way to retry all failed task runs, see Retry failed Kapacitor tasks.
Was this page helpful?
Thank you for your feedback!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for Kapacitor and this documentation. To find support, use the following resources: