Download OpenAPI specification:Download
Rules APIs provided by Detection and Response services are used to CRUD rules
Creates a new recommendation rule. Returns the rule_id
used to reference the rule in subsequent requests.
Rule created successfully
Bad request
Invalid authorization
Unique field collision
Internal error
{- "name": "Block risky countries",
- "priority": 10,
- "matcher": {
- "ip_cidrs": [
- "string"
]
}, - "recommendation": "CHALLENGE",
- "enabled": true,
- "mode": "PREVIEW",
- "type": "risk"
}
{- "message": "string",
- "rule_id": "string"
}
Retrieves a list of all recommendation rules
Rules retrieved successfully
Bad request
Invalid authorization
Internal error
{- "data": [
- {
- "id": "string",
- "name": "Block risky countries",
- "priority": 10,
- "matcher": {
- "ip_cidrs": [
- "string"
]
}, - "recommendation": "CHALLENGE",
- "enabled": true,
- "mode": "PREVIEW"
}
]
}
Retrieves a specific recommendation rule by its ID
Rule retrieved successfully
Bad request
Invalid authorization
Not found
Internal error
{- "id": "string",
- "data": {
- "name": "Block risky countries",
- "priority": 10,
- "matcher": {
- "ip_cidrs": [
- "string"
]
}, - "recommendation": "CHALLENGE",
- "enabled": true,
- "mode": "PREVIEW",
- "type": "risk"
}
}
Updates a specific recommendation rule
Rule updated successfully
Bad request
Invalid authorization
Not found
Internal error
{- "name": "Block risky countries",
- "priority": 10,
- "matcher": {
- "ip_cidrs": [
- "string"
]
}, - "recommendation": "CHALLENGE",
- "enabled": true,
- "mode": "PREVIEW",
- "type": "risk"
}
{- "message": "string"
}
Deletes a specific recommendation rule. Note that you can also disable rules if needed using the enabled rule attribute.
Rule updated successfully
Bad request
Invalid authorization
Not found
Internal error
{- "message": "string"
}