v2

latestOpenAPI 3.0.0AGPLv32026-07-26125148364.7 KB
Server Information

Edit Server

Edit a server by its id.

patch/servers/{target}

Path parameters

targetstring required

Headers

X-Audit-Log-Reasonstring

Reason for action which is stored in the audit log.

Request body

namestring nullable

Server name

descriptionstring nullable

Server description

iconstring nullable

Attachment Id for icon

bannerstring nullable

Attachment Id for banner

flagsinteger nullable

Bitfield of server flags

discoverableboolean nullable

Whether this server is public and should show up on Revolt Discover

analyticsboolean nullable

Whether analytics should be collected for this server

Must be enabled in order to show up on Revolt Discover.

ownerstring nullable

User id of the new owner

removeFieldsServer[]

Fields to remove from server object

Response

_idstring required

Unique Id

ownerstring required

User id of the owner

namestring required

Name of the server

descriptionstring nullable

Description for the server

channelsstring[] required

Channels within this server

rolesobject

Roles for this server

default_permissionsinteger required

Default set of server and channel permissions

flagsinteger

Bitfield of server flags

nsfwboolean

Whether this server is flagged as not safe for work

analyticsboolean

Whether to enable analytics

discoverableboolean

Whether this server should be publicly discoverable