# Yurbi API

> Reference for the Yurbi API — authenticate, manage users, configure apps, and refresh licenses on your own Yurbi server. JSON over HTTPS.

Every endpoint is an HTTP `POST` that accepts and returns JSON and runs on your own self-hosted Yurbi server. Authenticate once to get a session token, then pass it on every other call. The base URL is your own instance (path is `/api` on Linux/Docker, `/yurbi/api` on Windows). For the complete machine-readable reference with parameters, example requests and responses, see [llms-full.txt](https://developers.yurbi.com/llms-full.txt).

## Getting Started
- [Introduction](https://developers.yurbi.com/)
- [Quickstart](https://developers.yurbi.com/quickstart/)
- [Authentication & sessions](https://developers.yurbi.com/authentication/)
- [Conventions & errors](https://developers.yurbi.com/conventions/)
- [Finding more endpoints](https://developers.yurbi.com/finding-endpoints/)

## Guides
- [Single Sign-On](https://developers.yurbi.com/guides/single-sign-on/)
- [Embed dashboards & reports](https://developers.yurbi.com/guides/embedding/)
- [Branding & white-labeling](https://developers.yurbi.com/guides/branding/)
- [Custom CSS](https://developers.yurbi.com/guides/custom-css/)
- [Header-based SSO (advanced)](https://developers.yurbi.com/guides/sso-header/)

## API Reference

### Authentication
- [Log in — POST /api/login/DoLogin](https://developers.yurbi.com/reference/#do-login)
- [Check session — POST /api/Session/CheckSession](https://developers.yurbi.com/reference/#check-session)
- [Refresh session — POST /api/Session/RefreshSession](https://developers.yurbi.com/reference/#refresh-session)
- [Reset session passport — POST /api/Session/ResetPassport](https://developers.yurbi.com/reference/#reset-passport)
- [Log out — POST /api/login/DoLogout](https://developers.yurbi.com/reference/#do-logout)

### Users
- [New user template — POST /api/Contact/NewContact](https://developers.yurbi.com/reference/#new-contact)
- [Create or update a user — POST /api/Contact/SaveContact](https://developers.yurbi.com/reference/#save-contact)
- [Update my profile — POST /api/Contact/SaveMYContact](https://developers.yurbi.com/reference/#save-my-contact)
- [List users — POST /api/Contact/GetContactList](https://developers.yurbi.com/reference/#get-contact-list)

### Groups & Roles
- [List groups — POST /api/Group/GetAllSecurityGroups](https://developers.yurbi.com/reference/#get-all-security-groups)
- [New group template — POST /api/Group/NewSecurityGroup](https://developers.yurbi.com/reference/#new-security-group)
- [Create or update a group — POST /api/Group/SaveSecurityGroup](https://developers.yurbi.com/reference/#save-security-group)
- [Add user to group — POST /api/Group/AddUser](https://developers.yurbi.com/reference/#add-user)
- [Remove user from group — POST /api/Group/RemoveUser](https://developers.yurbi.com/reference/#remove-user)
- [List roles — POST /api/Contact/GetRolesList](https://developers.yurbi.com/reference/#get-roles-list)

### AppShield
- [New policy template — POST /api/AppShield/NewPolicy](https://developers.yurbi.com/reference/#new-policy)
- [Create or update a policy — POST /api/AppShield/SaveAppShieldPolicy](https://developers.yurbi.com/reference/#save-appshield-policy)
- [Add group to policy — POST /api/AppShield/AddGroup](https://developers.yurbi.com/reference/#appshield-add-group)
- [Remove group from policy — POST /api/AppShield/RemoveGrp](https://developers.yurbi.com/reference/#appshield-remove-group)

### Apps & Servers
- [List apps — POST /api/App/GetApplicationList](https://developers.yurbi.com/reference/#get-app-list)
- [List registered servers — POST /api/RegServers/GetAdminRegisteredServers](https://developers.yurbi.com/reference/#get-registered-servers)
- [Create an AnyDB module — POST /api/RegServers/InsertAnyDbModule](https://developers.yurbi.com/reference/#insert-anydb-module)
- [Register a data source — POST /api/RegServers/SaveRegSrv](https://developers.yurbi.com/reference/#save-regsrv)
- [Test a connection — POST /api/RegServers/TestConnection](https://developers.yurbi.com/reference/#test-connection)

### Library
- [List items in a folder — POST /api/library/GetListByFolderID](https://developers.yurbi.com/reference/#get-list-by-folder)
- [Get library tree — POST /api/library/GetAllLibraryTree](https://developers.yurbi.com/reference/#get-all-library-tree)
- [Search reports & dashboards — POST /api/library/SearchReports](https://developers.yurbi.com/reference/#search-reports)
- [Search dashboards — POST /api/Dashboard/SearchDashboardList](https://developers.yurbi.com/reference/#search-dashboard-list)
- [Favorite a dashboard — POST /api/library/ContactFavLibraryDashboardItem](https://developers.yurbi.com/reference/#fav-dashboard)
- [Unfavorite a dashboard — POST /api/library/ContactUnFavLibraryDashboardItem](https://developers.yurbi.com/reference/#unfav-dashboard)
- [Favorite a report — POST /api/library/ContactFavLibraryReportItem](https://developers.yurbi.com/reference/#fav-report)
- [Unfavorite a report — POST /api/library/ContactUnFavLibraryReportItem](https://developers.yurbi.com/reference/#unfav-report)

### Reports
- [Get report metadata — POST /api/Report/GetReportMetadataById](https://developers.yurbi.com/reference/#get-report-metadata)
- [Get prompt values — POST /api/Report/GetFieldValues](https://developers.yurbi.com/reference/#get-field-values)
- [Set a report prompt — POST /api/Report/ReplacePrompt](https://developers.yurbi.com/reference/#replace-prompt)
- [Set prompts (batch) — POST /api/Report/ReplacePromptCollection](https://developers.yurbi.com/reference/#replace-prompt-collection)
- [Run a report — POST /api/Report/GetReportData](https://developers.yurbi.com/reference/#get-report-data)

### Email (SMTP)
- [Get SMTP settings — POST /api/SMTP/GetSMTP](https://developers.yurbi.com/reference/#get-smtp)
- [Save SMTP settings — POST /api/SMTP/SaveSMTP](https://developers.yurbi.com/reference/#save-smtp)
- [Delete SMTP settings — POST /api/SMTP/DeleteSMTP](https://developers.yurbi.com/reference/#delete-smtp)

### Instance Settings
- [Get instance settings — POST /api/AppSettings/GetAppSettings](https://developers.yurbi.com/reference/#get-app-settings)
- [Save instance settings — POST /api/AppSettings/SaveAppSettings](https://developers.yurbi.com/reference/#save-app-settings)
- [Get audit types — POST /api/Audit/GetAuditTypes](https://developers.yurbi.com/reference/#get-audit-types)
- [Save audit types — POST /api/Audit/SaveAuditTypes](https://developers.yurbi.com/reference/#save-audit-types)

### Licensing
- [Refresh licenses — POST /api/LicenseManager/RefreshInstalledLicenses](https://developers.yurbi.com/reference/#refresh-licenses)
- [Get installation ID — POST /api/LicenseManager/GetInstallationID](https://developers.yurbi.com/reference/#get-installation-id)

## Optional
- [Full reference (llms-full.txt)](https://developers.yurbi.com/llms-full.txt): every endpoint with parameters, example bodies and responses inlined
- [Marketing site](https://yurbi.com/)
- [Support / Help Hub](https://yurbi.com/support/)