Skip to content

tools.ozone.safelink.removeRule

Lexicon Version: 1

Type: procedure

Remove an existing URL safety rule

Parameters: (None defined)

Input:

  • Encoding: application/json
  • Schema:

Schema Type: object

NameTypeReq’dDescriptionConstraints
urlstringThe URL or domain to remove the rule for
patterntools.ozone.safelink.defs#patternType
commentstringOptional comment about why the rule is being removed
createdBystringOptional DID of the user. Only respected when using admin auth.Format: did
Output:
  • Encoding: application/json
  • Schema:

Schema Type: tools.ozone.safelink.defs#event

Possible Errors:

  • RuleNotFound: No active rule found for this URL/domain

{
"lexicon": 1,
"id": "tools.ozone.safelink.removeRule",
"defs": {
"main": {
"type": "procedure",
"description": "Remove an existing URL safety rule",
"input": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": [
"url",
"pattern"
],
"properties": {
"url": {
"type": "string",
"description": "The URL or domain to remove the rule for"
},
"pattern": {
"type": "ref",
"ref": "tools.ozone.safelink.defs#patternType"
},
"comment": {
"type": "string",
"description": "Optional comment about why the rule is being removed"
},
"createdBy": {
"type": "string",
"format": "did",
"description": "Optional DID of the user. Only respected when using admin auth."
}
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "ref",
"ref": "tools.ozone.safelink.defs#event"
}
},
"errors": [
{
"name": "RuleNotFound",
"description": "No active rule found for this URL/domain"
}
]
}
}
}