Skip to content

Commit

Permalink
docs(readme): document how to block content PE-4186
Browse files Browse the repository at this point in the history
Adds an example curl command that can be used to block specific
transaction/data item IDs.
  • Loading branch information
djwhitt committed Jul 25, 2023
1 parent f5c6307 commit b05ae8d
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,24 @@ the admin key is read from the `ADMIN_API_KEY` environment variable. If no key i
set, a random key is generated and logged. To make a request to an admin endpoint
add an `Authorization: Bearer <ADMIN_API_KEY>` header to your request.

### Content Moderation

Block a specific TX/data item ID on your gateway:

```
curl -X PUT -H "Authorization: Bearer <ADMIN_KEY>" \
-H "Content-Type: application/json" \
"http://<HOST>:<PORT>/ar-io/admin/block-data" \
-d '{ "id": "<ID>", "notes": "Example notes", "source": "Example source" }'
```

`notes` and `source` are for documentation only. `source` is intended to be an
identifier of a particular source of IDs to block (e.g. the name of a
blocklist). `notes` is a text field that can be used to further describe why a
particular ID is blocked.


## Principles and Practices

### Architecture
Expand Down

0 comments on commit b05ae8d

Please sign in to comment.