Skip to content
Retidal Docs

Start / stop a derived event rule

Requires ADMIN.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
projectId
required
string

Project (tenant) identifier. Row-level tenant isolation is enforced on every query.

id
required
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
enabled
required
boolean
Examplegenerated
json
{
  "enabled": true
}

Responses

Section titled “Responses”

200

Section titled “200”

Updated rule.

Media typeapplication/json
object
rule
object
key
additional properties
any

400

Section titled “400”

Missing/invalid path input (e.g. projectId) or invalid JSON body.

Media typeapplication/json
object
error
required

Human-readable error message.

string
message
string
Examplegenerated
json
{
  "error": "example",
  "message": "example"
}

403

Section titled “403”

Not authenticated (401 via requireAuthenticated) or insufficient project role (403).

Media typeapplication/json
object
error
required

Human-readable error message.

string
message
string
Examplegenerated
json
{
  "error": "example",
  "message": "example"
}

404

Section titled “404”

Resource not found (or cross-tenant — same 404).

Media typeapplication/json
object
error
required

Human-readable error message.

string
message
string
Examplegenerated
json
{
  "error": "example",
  "message": "example"
}

422

Section titled “422”

Zod validation failed (error=‘参数校验失败’ with issues[]).

Media typeapplication/json
object
error
required
string
issues
Array<object>
object
path
string
message
string
details
Array<object>
object
key
additional properties
any
key
additional properties
any
Example
json
{
  "error": "参数校验失败"
}