Deletes the rule. Incidents it already opened stay in the list. Destructive: it needs –force without a terminal.
Usage
overlane observe alerts remove [--rule-id ID] [--dry-run] [--force]Flags
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--rule-id |
string | no | The rule to remove (required) | |
--dry-run |
boolean | no | Print the requests and file changes this command would make, then stop. Needs no credentials. | |
--force |
boolean | no | Confirm a destructive action when there is no terminal to ask on. Without it, exit 2. |
Examples
overlane observe alerts remove --rule-id rule-1 --force
overlane observe alerts remove --rule-id rule-1 --dry-runBehavior
- Effect:
destructive(deletes or reverts; needs--forcewithout a terminal). - Needs credentials: yes. Uses the network: yes.
- Supports
--dry-run: yes. Accepts--force: yes. - Machine-readable description:
overlane schema observe alerts remove.
Result
With --json (the default when stdout is not a terminal) the command prints this JSON Schema’s shape on stdout.
{
"anyOf": [
{
"type": "object",
"properties": {
"tenantId": {
"type": "string"
},
"removed": {
"type": "boolean",
"const": true
}
},
"required": [
"tenantId",
"removed"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"dryRun": {
"type": "boolean",
"const": true
},
"service": {
"type": "string"
},
"requests": {
"type": "array",
"items": {
"type": "object",
"properties": {
"method": {
"type": "string"
},
"path": {
"type": "string"
},
"body": {},
"note": {
"type": "string"
}
},
"required": [
"method",
"path"
],
"additionalProperties": false
}
},
"commands": {
"type": "array",
"items": {
"type": "string"
}
},
"writes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string"
},
"action": {
"type": "string",
"enum": [
"write",
"append",
"delete"
]
},
"description": {
"type": "string"
}
},
"required": [
"path",
"action",
"description"
],
"additionalProperties": false
}
},
"notes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"dryRun",
"requests",
"commands",
"writes",
"notes"
],
"additionalProperties": false
}
]
}See exit codes for the status the process returns.