Homarr
Invites

Delete a user invitation

DELETE/api/invites/{id}

Revoke an invitation by ID. Requires admin permission and credentials authentication to be enabled. Returns not found if the invitation does not exist.

Authorization

apikey
ApiKey<token>

API key which can be obtained in the Homarr administration dashboard

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/api/invites/string"
null

Create a user invitation

Create a single-use invitation with the supplied expiration date and return its ID and registration token. Requires admin permission and credentials authentication to be enabled.

Get global board settings

Return instance desktop and mobile home board IDs and default status behavior. Requires admin permission.