tools.ozone.safelink.addRule

ozone-lexicons.bsky.social

Documentation

Add a new URL safety rule

main procedure

Add a new URL safety rule

Input

Encodingapplication/json
comment string Optional

Optional comment about the decision

createdBy stringdid Optional

Author DID. Only respected when using admin auth

url string Required

The URL or domain to apply the rule to

Output

Encodingapplication/json
Schematools.ozone.safelink.defs#event

Errors

InvalidUrl The provided URL is invalid
RuleAlreadyExists A rule for this URL/domain already exists
Try It

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

Base URL for XRPC calls (e.g., https://bsky.social)
Enter valid JSON for the request body
View raw schema 
{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "url",
        "pattern",
        "action",
        "reason"
      ],
      "properties": {
        "url": {
          "type": "string",
          "description": "The URL or domain to apply the rule to"
        },
        "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 decision"
        },
        "pattern": {
          "ref": "tools.ozone.safelink.defs#patternType",
          "type": "ref"
        },
        "createdBy": {
          "type": "string",
          "format": "did",
          "description": "Author DID. Only respected when using admin auth"
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "InvalidUrl",
      "description": "The provided URL is invalid"
    },
    {
      "name": "RuleAlreadyExists",
      "description": "A rule for this URL/domain already exists"
    }
  ],
  "output": {
    "schema": {
      "ref": "tools.ozone.safelink.defs#event",
      "type": "ref"
    },
    "encoding": "application/json"
  },
  "description": "Add a new URL safety rule"
}

Lexicon Garden

@