# 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/)
- [API spec & tooling](https://developers.yurbi.com/spec/)

## Guides
- [Single Sign-On](https://developers.yurbi.com/guides/single-sign-on/)
- [Multi-tenant provisioning](https://developers.yurbi.com/guides/multi-tenant-provisioning/)
- [Run reports from your app](https://developers.yurbi.com/guides/running-reports/)
- [Row-level data security](https://developers.yurbi.com/guides/data-security/)
- [Building apps & reports](https://developers.yurbi.com/guides/building-apps-and-reports/)
- [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)
- [Get a user — POST /api/Contact/GetContactById](https://developers.yurbi.com/reference/#get-contact-by-id)
- [Delete a user — POST /api/Contact/DeleteContact](https://developers.yurbi.com/reference/#delete-contact)
- [Unlock a user — POST /api/Contact/UnlockContact](https://developers.yurbi.com/reference/#unlock-contact)

### Groups & Roles
- [List security groups — POST /api/Group/GetAllSecurityGroups](https://developers.yurbi.com/reference/#get-all-security-groups)
- [Get a security group — POST /api/Group/GetSecurityGroupById](https://developers.yurbi.com/reference/#get-security-group-by-id)
- [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)
- [Delete a security group — POST /api/Group/DeleteSecurityGroup](https://developers.yurbi.com/reference/#delete-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)

### Data Security
- [New data tag template — POST /api/DataTag/NewDataTag](https://developers.yurbi.com/reference/#new-data-tag)
- [Create or update a data tag — POST /api/DataTag/SaveDataTag](https://developers.yurbi.com/reference/#save-data-tag)
- [List data tags — POST /api/DataTag/GetAllDataTags](https://developers.yurbi.com/reference/#get-all-data-tags)
- [Delete a data tag — POST /api/DataTag/DeleteDataTag](https://developers.yurbi.com/reference/#delete-data-tag)
- [New policy template — POST /api/AppShield/NewPolicy](https://developers.yurbi.com/reference/#new-policy)
- [List policies — POST /api/AppShield/GetAllAppshieldPolicies](https://developers.yurbi.com/reference/#get-all-appshield-policies)
- [Create or update a policy — POST /api/AppShield/SaveAppShieldPolicy](https://developers.yurbi.com/reference/#save-appshield-policy)
- [Delete a policy — POST /api/AppShield/DeletePolicy](https://developers.yurbi.com/reference/#delete-policy)
- [Add group to policy — POST /api/AppShield/AddGroup](https://developers.yurbi.com/reference/#appshield-add-group)
- [Remove group from policy — POST /api/AppShield/RemoveGroup](https://developers.yurbi.com/reference/#appshield-remove-group)

### Apps & Servers
- [List applications — 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)
- [List time zones — POST /api/RegServers/GetTimeZones](https://developers.yurbi.com/reference/#get-timezones)
- [Register an AnyDB app — POST /api/RegServers/InsertAnyDbModule](https://developers.yurbi.com/reference/#insert-anydb-module)
- [Save a registered server — POST /api/RegServers/SaveRegSrv](https://developers.yurbi.com/reference/#save-regsrv)
- [Test connection — POST /api/RegServers/TestConnection](https://developers.yurbi.com/reference/#test-connection)

### Library
- [List a folder's contents — POST /api/library/GetListByFolderID](https://developers.yurbi.com/reference/#get-list-by-folder)
- [Get the library tree — POST /api/library/GetAllLibraryTree](https://developers.yurbi.com/reference/#get-all-library-tree)
- [New folder template — POST /api/library/NewLibraryFolder](https://developers.yurbi.com/reference/#new-library-folder)
- [Create or update a folder — POST /api/library/SaveLibraryFolder](https://developers.yurbi.com/reference/#save-library-folder)
- [Get a folder — POST /api/library/GetFolderById](https://developers.yurbi.com/reference/#get-folder-by-id)
- [Delete a folder — POST /api/library/DelFolder](https://developers.yurbi.com/reference/#del-folder)
- [Delete a report — POST /api/library/DelReport](https://developers.yurbi.com/reference/#del-report)
- [Search reports — 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)
- [Favourite a dashboard — POST /api/library/FavDash](https://developers.yurbi.com/reference/#fav-dashboard)
- [Un-favourite a dashboard — POST /api/library/UnFavDash](https://developers.yurbi.com/reference/#unfav-dashboard)
- [Favourite a report — POST /api/library/FavReport](https://developers.yurbi.com/reference/#fav-report)
- [Un-favourite a report — POST /api/library/UnFavReport](https://developers.yurbi.com/reference/#unfav-report)

### App Builder
- [List AnyDB apps — POST /api/AppBuilder/GetAnyDbModulesList](https://developers.yurbi.com/reference/#get-anydb-modules-list)
- [Get an AnyDB app — POST /api/AppBuilder/GetAnyDbModule](https://developers.yurbi.com/reference/#get-anydb-module)
- [Save an AnyDB app — POST /api/AppBuilder/SaveAnyDbModule](https://developers.yurbi.com/reference/#save-anydb-module)
- [Get a table definition — POST /api/AppBuilder/GetTableDef](https://developers.yurbi.com/reference/#get-table-def)
- [List field type codes — POST /api/AppBuilder/GetDataTypes](https://developers.yurbi.com/reference/#get-data-types)
- [List report types — POST /api/RegServers/GetReportTypes](https://developers.yurbi.com/reference/#get-report-types)
- [Get a report type's field tree — POST /api/RegServers/GetReportTree](https://developers.yurbi.com/reference/#get-report-tree)

### Reports
- [New report template — POST /api/Report/NewReport](https://developers.yurbi.com/reference/#new-report)
- [New report field — POST /api/Report/NewField](https://developers.yurbi.com/reference/#new-field)
- [New criteria template — POST /api/Report/NewCriteria](https://developers.yurbi.com/reference/#new-criteria)
- [New totals template — POST /api/Report/NewTotals](https://developers.yurbi.com/reference/#new-totals)
- [Create or update a report — POST /api/Report/SaveReport](https://developers.yurbi.com/reference/#save-report)
- [Update a report — POST /api/Report/UpdateReport](https://developers.yurbi.com/reference/#update-report)
- [Get a report definition — POST /api/Report/GetReport](https://developers.yurbi.com/reference/#get-report)
- [Get generated SQL — POST /api/Report/GetSQL](https://developers.yurbi.com/reference/#get-sql)
- [Compile criteria — POST /api/Report/ReportProcUI](https://developers.yurbi.com/reference/#report-proc-ui)
- [List SQL functions — POST /api/Report/GetSQLFunctions](https://developers.yurbi.com/reference/#get-sql-functions)
- [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)
- [Apply one prompt — POST /api/Report/ReplacePrompt](https://developers.yurbi.com/reference/#replace-prompt)
- [Apply all prompts — 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)
- [List output types — POST /api/Report/GetOutputTypes](https://developers.yurbi.com/reference/#get-output-types)

### Email (SMTP)
- [Get SMTP configuration — POST /api/SMTP/GetSMTP](https://developers.yurbi.com/reference/#get-smtp)
- [Save SMTP configuration — POST /api/SMTP/SaveSMTP](https://developers.yurbi.com/reference/#save-smtp)
- [Delete SMTP configuration — 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 settings — POST /api/Audit/GetAuditTypes](https://developers.yurbi.com/reference/#get-audit-types)
- [Save audit settings — POST /api/Audit/SaveAuditTypes](https://developers.yurbi.com/reference/#save-audit-types)

### Licensing
- [Refresh licences — 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/)