Skip to content
Yagra

create_event_rule

POST
/api/v1/event-rules
curl --request POST \
  --url https://example.com/api/v1/event-rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "clear_pattern": "example", "enabled": true, "match_kind": "example", "min_count": 1, "name": "example", "node_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "pattern": "example", "severity": "example", "source_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "source_kind": "example", "ttl_secs": 1, "window_secs": 1 }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
clear_pattern
string | null
enabled
boolean
match_kind
required
string
min_count
integer | null format: int32
name
required
string
node_id
string | null format: uuid
pattern
required
string
severity
required
string
source_id
string | null format: uuid
source_kind
string | null
ttl_secs
integer | null format: int32
window_secs
integer | null format: int32
Examplegenerated
{
  "clear_pattern": "example",
  "enabled": true,
  "match_kind": "example",
  "min_count": 1,
  "name": "example",
  "node_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "pattern": "example",
  "severity": "example",
  "source_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "source_kind": "example",
  "ttl_secs": 1,
  "window_secs": 1
}

Responses

Section titled “Responses”

201

Section titled “201”

Rule created

Media typeapplication/json

The id of a freshly created resource — the whole body of a 201.

Deliberately one shape for every creator. The json!({"id": …}) literal it replaces was written out per handler, which is how {"id": …} and {"node_id": …} both ended up in this API for the same idea; a client then needs to know which creator it called to read the id back.

object
id
required
string format: uuid
Examplegenerated
{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

400

Section titled “400”

A pattern does not compile, or a field is outside its accepted range

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object
error
required
object
code
required

Stable machine-readable code. Clients branch on this, never on the message.

string
message
required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

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

401

Section titled “401”

No valid bearer token

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object
error
required
object
code
required

Stable machine-readable code. Clients branch on this, never on the message.

string
message
required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

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

403

Section titled “403”

Role below Admin

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object
error
required
object
code
required

Stable machine-readable code. Clients branch on this, never on the message.

string
message
required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

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

503

Section titled “503”

This core has no write side (skeleton mode)

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object
error
required
object
code
required

Stable machine-readable code. Clients branch on this, never on the message.

string
message
required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

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