v55

latestOpenAPI 3.0.3agplraw.githubusercontent.com2026-08-01155431.3 MB

ban

Ban an actor or IP address

Required capability: ban-v1

post/ocs/v2.php/apps/spreed/api/{apiVersion}/ban/{token}

apiVersion'v1' required

tokenstring required

OCS-APIRequestboolean required

Required to be true for the API request to pass

actorType'users' | 'guests' | 'emails' | 'ip' required

Type of actor to ban, or ip when banning a clients remote address

actorIdstring required

Actor ID or the IP address or range in case of type ip

internalNotestring

Optional internal note (max. 4000 characters)

Ban successfully