Relay Backend API: Specification summary

Create, delete, rename, and configure channels.

Operation	HTTP Request	Description
post	POST /api/channels/{channelID}/create	Create a channel
post	POST /api/channels/{channelID}/delete	Delete a channel
get	GET /api/channels/{channelID}/permissions	Get channel permission overwrites
post	POST /api/channels/{channelID}/rename	Rename a channel
post	POST /api/channels/{channelID}/permissions	Set or remove a channel permission overwrite

Discover permissions and configure server-wide defaults.

Operation	HTTP Request	Description
get	GET /api/users/{userID}/permissions	Get a user's base permissions
get	GET /api/channels/{channelID}/permissions	Get channel permission overwrites
get	GET /api/permissions/global	Get global permissions
get	GET /api/roles/{roleID}/permissions	Get role permissions
get	GET /api/permissions	List available permissions
put	PUT /api/permissions/global	Replace global permissions
put	PUT /api/roles/{roleID}/permissions	Replace role permissions
post	POST /api/channels/{channelID}/permissions	Set or remove a channel permission overwrite

Create, delete, rename, and configure roles.

Operation	HTTP Request	Description
post	POST /api/roles/{roleID}/create	Create a role
post	POST /api/roles/{roleID}/delete	Delete a role
get	GET /api/roles/{roleID}/permissions	Get role permissions
get	GET /api/roles	List roles
post	POST /api/roles/{roleID}/rename	Rename a role
put	PUT /api/roles/{roleID}/permissions	Replace role permissions

Inspect effective permissions and manage role assignments.

Operation	HTTP Request	Description
post	POST /api/users/{userID}/roles/{roleID}	Assign a role to a user
get	GET /api/users/{userID}/permissions	Get a user's base permissions
get	GET /api/users/{userID}/roles	Get a user's roles
delete	DELETE /api/users/{userID}/roles/{roleID}	Remove a role from a user

Legacy role-management aliases retained for existing clients.

Operation	HTTP Request	Description
post	POST /api/roles/{roleID}/add_perm	Add permissions to a role (legacy)
post	POST /api/roles/{roleID}/add_user	Assign a role to a user (legacy)
post	POST /api/roles/{roleID}/remove_user	Remove a role from a user (legacy)
post	POST /api/roles/{roleID}/remove_perm	Remove permissions from a role (legacy)