tools.ozone.setting.list Options

GET {{baseUrl}}/xrpc/tools.ozone.setting.listOptions?limit=50&cursor=<string>&scope=instance&prefix=<string>&keys=<nsid>&keys=<nsid>

This endpoint is part of the Ozone moderation service APIs. Requests usually require authentication, are directed to the user's PDS intance, and proxied to the Ozone instance indicated by the DID in the service proxying header. Admin authenentication may also be possible, with request sent directly to the Ozone instance.

To learn more about calling atproto API endpoints like this one, see the API Hosts and Auth guide.

List settings with optional filtering

Request Params

KeyDatatypeRequiredDescription
limitnumber
cursorstring
scopestring
prefixstringFilter keys by prefix
keysstringFilter for only the specified keys. Ignored if prefix is provided
keysstringFilter for only the specified keys. Ignored if prefix is provided

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;options&quot;:[{&quot;key&quot;:&quot;\u003cnsid\u003e&quot;,&quot;value&quot;:{},&quot;did&quot;:&quot;\u003cdid\u003e&quot;,&quot;scope&quot;:&quot;\u003cstring\u003e&quot;,&quot;createdBy&quot;:&quot;\u003cdid\u003e&quot;,&quot;lastUpdatedBy&quot;:&quot;\u003cdid\u003e&quot;,&quot;description&quot;:&quot;\u003cstring\u003e&quot;,&quot;createdAt&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;updatedAt&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;managerRole&quot;:&quot;\u003cstring\u003e&quot;},{&quot;key&quot;:&quot;\u003cnsid\u003e&quot;,&quot;value&quot;:{},&quot;did&quot;:&quot;\u003cdid\u003e&quot;,&quot;scope&quot;:&quot;\u003cstring\u003e&quot;,&quot;createdBy&quot;:&quot;\u003cdid\u003e&quot;,&quot;lastUpdatedBy&quot;:&quot;\u003cdid\u003e&quot;,&quot;description&quot;:&quot;\u003cstring\u003e&quot;,&quot;createdAt&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;updatedAt&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;managerRole&quot;:&quot;\u003cstring\u003e&quot;}],&quot;cursor&quot;:&quot;\u003cstring\u003e&quot;}