xhr.md

XHR Endpoints

Documentation for all requests available on /xhr (used by the frontend).

Open Endpoints

Authentication

In order to authenticate you need to post a request to one of the following endpoints. All session data that is associated with an ID is stored server-side.

• Authenticate local user : POST /xhr/login
• Authenticate LDAP user : POST /xhr/login/ldap
• Authenticate TOTP : POST /xhr/totp
• Remote Authentication : POST /xhr/login/remote

Frontend

• Site settings : GET /xhr/site/_name/:name
• Frontend options : GET /xhr/frontend/options

Endpoints with authentication required

Domain related

• Get domains : GET /xhr/domain
• Get domain by ID : GET /xhr/domain/_id/:id
• Get domain by FQDN : GET /xhr/domain/:fqdn
• Add domain : POST /xhr/domain
• Update domain : PATCH /xhr/domain/_id/:id
• Delete domain : DELETE /xhr/domain/_id/:id

User related

• Get users : GET /xhr/user
• Get user by ID : GET /xhr/user/_id/:id
• Add user : POST /xhr/user
• Update user : PATCH /xhr/user/_id/:id
• Delete user : DELETE /xhr/user/_id/:id
• Get user relation by ID : GET /xhr/user/relation/_id/:id
• Add user relation : POST /xhr/user/_id/:id/relation
• Delete user relation : DELETE /xhr/user/relation/_id/:id

Settings related

• Get settings by domain ID : GET /xhr/settings/domain/_id/:id
• Get settings by user ID : GET /xhr/settings/user/_id/:id
• Get settings by default ID : GET /xhr/settings/default/_id/:id
• Get setting by ID : GET /xhr/schema/settings/_id/:id
• Add setting : POST /xhr/schema/_id/:id/settings
• Update setting : PATCH /xhr/schema/settings/_id/:id
• Delete setting : DELETE /xhr/schema/settings/_id/:id

Schema settings

• Get schemas : GET /xhr/schema
• Get schema by ID : GET /xhr/schema/_id/:id
• Add schema : POST /xhr/schema
• Update schema : PATCH /xhr/schema/_id/:id
• Delete schema : DELETE /xhr/schema/_id/:id
• Get schema groups : GET /xhr/schemagroup
• Get schema group by ID : GET /xhr/schemagroup/_id/:id
• Add schema group : POST /xhr/schemagroup
• Update schema group : PATCH /xhr/schemagroup/_id/:id
• Delete schema group : DELETE /xhr/schemagroup/_id/:id

Roles

• Get roles : GET /xhr/role
• Get role by ID : GET /xhr/role/_id/:id
• Add role : POST /xhr/role
• Update role : PATCH /xhr/role/_id/:id
• Delete role : DELETE /xhr/role/_id/:id
• Add permission to role : POST /xhr/role/_id/:id/permission
• Update permission : PATCH /xhr/role/permission/_id/:id
• Delete permission : DELETE /xhr/role/permission/_id/:id

Tags

• Get tags : GET /xhr/tags
• Get tag by ID : GET /xhr/tags/_id/:id
• Add tag : POST /xhr/tags
• Update tag : PATCH /xhr/tags/_id/:id
• Delete tag : DELETE /xhr/tags/_id/:id

Tag domain

• Tag domain : POST /xhr/tags/_id/:tag_id/domain/_id/:id
• Remove tag : DELETE /xhr/tags/_id/:tag_id/domain/_id/:id

Tag user

• Tag domain : POST /xhr/tags/_id/:tag_id/user/_id/:id
• Remove tag : DELETE /xhr/tags/_id/:tag_id/user/_id/:id

Audit log

• Get audit log : GET /xhr/audit

Session

• Logout user : GET /xhr/logout
• Session information : GET /xhr/session
• Generate TOTP secret : GET /xhr/session/totp/generate
• Add TOTP : POST /xhr/session/totp
• Delete TOTP : DELETE /xhr/session/totp

Site settings

• Get site options : GET /xhr/site
• Get site option by ID : GET /xhr/site/_id/:id
• Get options names : GET /xhr/site/options
• Add site soption : POST /xhr/site
• Update option : UPDATE /xhr/site/_id/:id
• Delete option : DELETE /xhr/site/_id/:id

Other

• Web-logui : GET /xhr/enduser
• Transfer session to Web-logui : GET /xhr/enduser/transfer