Skip to main content
API Explorer|API Explorer
Platform Operations/Platform Self-Monitor
PUTPlatformSince 1.0SynchronousAuth Required

UpdateSelfMonRule

Update the threshold of an existing self-monitoring alert rule.

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • ruleIdStringRequired

    ID of the rule to update

Body Fields

  • nameStringRequired

    New name for the alert rule

    Example: Updated CPU Alert

  • descriptionStringRequired

    New description for the rule

    Example: Updated alert description

  • operatorStringRequired

    New comparison operator

    Example: >

  • thresholdLongRequired

    New threshold value

    Example: 85

  • durationIntegerRequired

    New duration in seconds

    Example: 300

Responses

200 OK

On success, this API returns the following response structure.

  • idString

    Unique identifier of the alert rule

    Example: rule-selfmon-001

  • nameString

    Human-readable name of the alert rule

    Example: High Error Rate

  • descriptionString

    Description of what this self-monitoring rule detects

    Example: Fires when API error rate exceeds threshold

  • severityString

    Severity level of alerts fired by this rule

    Example: warning

  • thresholdLong

    Threshold value that triggers this rule

    Example: 0.05

  • builtinBoolean

    Whether this rule is a built-in system rule (not user-modifiable)

    Example: true

Endpoint

PUT/api/v1/self-monitor/rules/{ruleId}

/api/v1/self-monitor/rules/{ruleId}

Operation ID

UpdateSelfMonRule

Permalink

Request Example

curl -X PUT '{host}/api/v1/self-monitor/rules/{ruleId}' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"name":"Updated CPU Alert","description":"Updated alert description","operator":">","threshold":85.0,"duration":300,"severity":"warning","state":"disabled","notifyUrl":"https://example.com/callback","actions":"(nested array)","updateActions":true,"labelSelectors":"(nested object)","updateLabelSelectors":true}'

Response Example

200
{
  "id": "rule-selfmon-001",
  "name": "High Error Rate",
  "description": "Fires when API error rate exceeds threshold",
  "severity": "warning",
  "threshold": 0.05,
  "builtin": true
}

Change History

This API has no change history records yet.

View all change history