delete https://rule-engine-api.frisbii.com/v1/action/
Delete a scheduled action by its handle in the Rule Engine
Preview Status
All Rule Engine actions are currently in PREVIEW phase. When managing actions:
- Monitor action execution results
- Review scheduled actions regularly
- Report any issues encountered to our support team
This endpoint allows you to delete a specific scheduled action by its handle from the Rule Engine. Once deleted, the action will no longer be executed at its scheduled time. This operation is useful for canceling actions that are no longer needed or were scheduled incorrectly.
Key Features
- Delete a specific action by its unique handle
- Prevent execution of unwanted scheduled actions
- Clean up obsolete or incorrectly configured actions
Important Notes
- Irreversible Operation: Once an action is deleted, it cannot be recovered
- Pre-execution Only: You can only delete actions that haven't been executed yet (state is
new) - Immediate Effect: The deletion takes effect immediately and the action will be removed from the schedule
Parameters
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
handle | string | Yes | The unique handle/identifier of the action to delete |
Response
When an action is successfully deleted, the API returns HTTP status code 204 No Content with an empty response body. This indicates that the action has been permanently removed from the Rule Engine.
Success Response
- Status Code:
204 No Content - Response Body: Empty
Error Responses
The endpoint may return the following error responses:
| Status Code | Description |
|---|---|
400 | Invalid request - see error codes |
401 | Authentication required - no or invalid credentials provided |
403 | Not authorized to perform this operation |
404 | Action not found - the specified handle doesn't exist |
429 | Request rate limit exceeded |
500 | Internal server error - automatically reported to Frisbii |
Example Usage
Delete a Specific Action
curl -X DELETE "https://rule-engine-api.frisbii.com/v1/action/action-1234567890" \
-H "Authorization: Basic <base64-encoded-credentials>"
Response:
HTTP/1.1 204 No Content