NEnextcloud
ban

Ban an actor or IP address

Required capability: ban-v1

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

Request

  • The document declares no server URL.
  • Auth
    • none
    • or HTTP bearer
    • or HTTP basic

Path parameters

apiVersion'v1' required
tokenstring required

Headers

OCS-APIRequestboolean required

Required to be true for the API request to pass

Request body

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)

Response

Ban successfully

Changes

No recorded changes to this operation across all 99 revisions of this API.