Skip to content

tools.ozone.safelink.updateRule

Lexicon Version: 1

Type: procedure

Update an existing URL safety rule

Parameters: (None defined)

Input:

  • Encoding: application/json
  • Schema:

Schema Type: object

NameTypeReq’dDescriptionConstraints
urlstringThe URL or domain to update the rule for
patterntools.ozone.safelink.defs#patternType
actiontools.ozone.safelink.defs#actionType
reasontools.ozone.safelink.defs#reasonType
commentstringOptional comment about the update
createdBystringOptional DID to credit as the creator. Only respected for admin_token authentication.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.updateRule",
"defs": {
"main": {
"type": "procedure",
"description": "Update an existing URL safety rule",
"input": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": [
"url",
"pattern",
"action",
"reason"
],
"properties": {
"url": {
"type": "string",
"description": "The URL or domain to update the rule for"
},
"pattern": {
"type": "ref",
"ref": "tools.ozone.safelink.defs#patternType"
},
"action": {
"type": "ref",
"ref": "tools.ozone.safelink.defs#actionType"
},
"reason": {
"type": "ref",
"ref": "tools.ozone.safelink.defs#reasonType"
},
"comment": {
"type": "string",
"description": "Optional comment about the update"
},
"createdBy": {
"type": "string",
"format": "did",
"description": "Optional DID to credit as the creator. Only respected for admin_token authentication."
}
}
}
},
"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"
}
]
}
}
}