Update an existing URL safety rule
Input
Encoding
application/jsonaction
reftools.ozone.safelink.defs#actionType
Required
No description available.
comment
string
Optional
Optional comment about the update
createdBy
stringdid
Optional
Optional DID to credit as the creator. Only respected for admin_token authentication.
pattern
reftools.ozone.safelink.defs#patternType
Required
No description available.
reason
reftools.ozone.safelink.defs#reasonType
Required
No description available.
url
string
Required
The URL or domain to update the rule for
Output
Encoding
application/jsonErrors
RuleNotFound
No active rule found for this URL/domain Try It
Requests are sent directly from your browser. Some servers may block requests due to CORS.
View raw schema
{
"type": "procedure",
"input": {
"schema": {
"type": "object",
"required": [
"url",
"pattern",
"action",
"reason"
],
"properties": {
"url": {
"type": "string",
"description": "The URL or domain to update the rule for"
},
"action": {
"ref": "tools.ozone.safelink.defs#actionType",
"type": "ref"
},
"reason": {
"ref": "tools.ozone.safelink.defs#reasonType",
"type": "ref"
},
"comment": {
"type": "string",
"description": "Optional comment about the update"
},
"pattern": {
"ref": "tools.ozone.safelink.defs#patternType",
"type": "ref"
},
"createdBy": {
"type": "string",
"format": "did",
"description": "Optional DID to credit as the creator. Only respected for admin_token authentication."
}
}
},
"encoding": "application/json"
},
"errors": [
{
"name": "RuleNotFound",
"description": "No active rule found for this URL/domain"
}
],
"output": {
"schema": {
"ref": "tools.ozone.safelink.defs#event",
"type": "ref"
},
"encoding": "application/json"
},
"description": "Update an existing URL safety rule"
}