Skip to content

tools.ozone.safelink.queryRules

Lexicon Version: 1

Type: procedure

Query URL safety rules

Parameters: (None defined)

Input:

  • Encoding: application/json
  • Schema:

Schema Type: object

NameTypeReq’dDescriptionConstraints
cursorstringCursor for pagination
limitintegerMaximum number of results to returnMin: 1
Max: 100
Default: 50
urlsArray of stringFilter by specific URLs or domains
patternTypestringFilter by pattern type
actionsArray of stringFilter by action types
reasonstringFilter by reason type
createdBystringFilter by rule creatorFormat: did
sortDirectionstringSort directionKnown Values: asc, desc
Default: desc
Output:
  • Encoding: application/json
  • Schema:

Schema Type: object

NameTypeReq’dDescriptionConstraints
cursorstringNext cursor for pagination. Only present if there are more results.
rulesArray of tools.ozone.safelink.defs#urlRule

{
"lexicon": 1,
"id": "tools.ozone.safelink.queryRules",
"defs": {
"main": {
"type": "procedure",
"description": "Query URL safety rules",
"input": {
"encoding": "application/json",
"schema": {
"type": "object",
"properties": {
"cursor": {
"type": "string",
"description": "Cursor for pagination"
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"default": 50,
"description": "Maximum number of results to return"
},
"urls": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter by specific URLs or domains"
},
"patternType": {
"type": "string",
"description": "Filter by pattern type"
},
"actions": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter by action types"
},
"reason": {
"type": "string",
"description": "Filter by reason type"
},
"createdBy": {
"type": "string",
"format": "did",
"description": "Filter by rule creator"
},
"sortDirection": {
"type": "string",
"knownValues": [
"asc",
"desc"
],
"default": "desc",
"description": "Sort direction"
}
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": [
"rules"
],
"properties": {
"cursor": {
"type": "string",
"description": "Next cursor for pagination. Only present if there are more results."
},
"rules": {
"type": "array",
"items": {
"type": "ref",
"ref": "tools.ozone.safelink.defs#urlRule"
}
}
}
}
}
}
}
}