tools.ozone.safelink.queryRules Documentation (EN)

main procedure

Query URL safety rules

Input

Encodingapplication/json

actions array Optional

Filter by action types

createdBy stringdid Optional

Filter by rule creator

cursor string Optional

Cursor for pagination

limit integer Optional

Maximum number of results to return

minimum: 1maximum: 100

patternType string Optional

Filter by pattern type

reason string Optional

Filter by reason type

sortDirection string Optional

Sort direction

urls array Optional

Filter by specific URLs or domains

Output

Encodingapplication/json

cursor string Optional

Next cursor for pagination. Only present if there are more results.

rules array Required

No description available.

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://bsky.social)

Request Body (JSON) Enter valid JSON for the request body

View raw schema

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