Documentation
In Veltrix, every security tool you manage is delivered as an app. An app packages the manifest, validators, deployment handlers and canvas templates for one product, and adds its own pages and configuration types to your portal. The Marketplace is the catalog of apps you can switch on; the Apps page is the roster of apps already present in your organization.
The marketplace catalog lists around 96 community apps. Catalog does not mean live: only a small number of integrations are generally available in the hosted product today, and an entry that has no downloadable package shows Coming Soon instead of an install action. Check an app's card before planning around it.
Two separate steps put an app to work, and they are performed by different people:
| Destination | Route | What it is |
|---|---|---|
| Apps (sidebar, Apps group) | /apps | Installed Apps page: every app that is installed for your organization, enabled or not. The old /installed-apps address redirects here. |
| Marketplace (sidebar, Apps group) | /marketplace | The full catalog, including apps you have not enabled yet. |
| An app's own area | /apps/<appId> | When the app is enabled, opens its first page. Otherwise (or if the app has no pages) it shows an overview of the app's configuration types and settings. |
| A configuration type | /apps/<appId>/config/<typeId> | The list and editor for one kind of configuration the app manages. |
| App pipeline | /apps/<appId>/pipeline | Every configuration of that app across all of its types, with its pipeline status. |
The sidebar groups navigation as Operate, Apps and Govern. While you are inside an app, the Apps item stays highlighted.
?status= (for example /marketplace?status=installed), so a filtered view can be bookmarked and the browser back button works.| Filter | Shows |
|---|---|
| All | Everything you can see. |
| Installed | Apps that have an installation record for your organization (enabled or disabled). |
| Enabled | Apps currently switched on for your organization. |
| Available | Anything not enabled for you: catalog entries, installed-but-disabled apps and not-yet-enabled apps. |
Apps that the platform operator has unpublished or deprecated are hidden from other organizations; an organization that already has such an app installed still sees it.
| Element | Meaning |
|---|---|
Name, vX.Y.Z, vendor | The app and the version registered on the platform. |
| Enabled (green) | The app is on for your organization. Click the card body to open it. |
| Update available | The catalog carries a newer version than the one installed. See Upgrades. |
| Category chip | The app's category, for example SIEM or EDR. |
| Built-in / Custom / Marketplace | Where the app came from: shipped with the platform, uploaded as a package, or installed from the catalog. |
| Install | Shown only to platform administrators, on catalog entries that have a downloadable package. |
| Platform administrator required | What non-administrators see where an Install button would be: ask your platform administrator to install it. |
| Coming Soon | The catalog entry has no downloadable package yet. |
| Gear icon (Settings) | Opens app settings. Appears on enabled apps that declare settings. |
| Trash icon (Uninstall) | Shown to platform administrators only, and never on built-in apps. See the warning below. |
| Enable / Disable | Turns the app on or off for your organization. |
Enabling needs the apps write permission on your role. If the action is refused, the reason is shown in a red banner at the top of the page: a missing permission, the enabled-app limit for your plan, an unpaid trial, or an app that is no longer published for new installations. An app that was deprecated can still be re-enabled by an organization that already had it installed.
Disable switches the app off for your organization. Its data is preserved, the app's own disable hook runs if it has one, and you can enable it again later. Disabling frees one slot against your plan's limit.
Be careful with Uninstall. It is restricted to platform administrators; organization administrators see only Enable and Disable. It is offered on non-built-in apps after a confirmation (“This cannot be undone”), and it removes the app registration from the platform itself, including every organization's installation of it — not just yours. Built-in apps cannot be uninstalled. If you only want an app out of your way, use Disable.
Apps in the sidebar opens /apps, titled Installed Apps. The subtitle shows how many apps are installed and how many are enabled for your organization.
An enabled app opens in its own shell with a sidebar (or a compact rail) that you can collapse; the choice is remembered in your browser. The sidebar is built from the app's manifest and has up to three groups:
If an app's code cannot be loaded you will see a “Failed to load app” panel with Retry; a page that crashes shows “This tab crashed” with Retry; an out-of-date package may report that a tab is unavailable and suggest reinstalling the app.
Selecting a configuration type opens its page: the title, a short description, a New configuration button, and a table of configurations of that type. Some types add companion tabs next to Configurations, declared by the app. Each configuration is created and edited on the Configuration Canvas, which is documented separately.
The configuration list supports search, status and environment filters and sorting by name, status, version or last update. Row actions include Validate, Edit, Change / issue tickets, Submit for approval, Reviews & comments, Deploy, Duplicate and Delete. Only drafts can be deleted. Deploy is available once the configuration is approved (or in a retryable failed or rolled-back state) and an environment is assigned; editing a configuration resets it to draft and requires re-approval. See Pipelines & Environments for the lifecycle, and Ticketing Integrations for the ticket action.
| Status label | Meaning |
|---|---|
| Draft | Editable; not yet submitted. |
| Validating / Validation failed | The app's validator is running, or it rejected the configuration. |
| Pending approval / Changes requested / Approved | Approval workflow states. |
| Queued / Deploying / Paused / Deployed | Deployment progress. |
| Deploy failed / Rolled back | Retryable states. |
| Archived | No longer active. |
Apps can declare organization-level settings. To change them, open the Marketplace, find the enabled app and click the gear icon (<App> settings). The dialog loads the app's settings merged with the app's defaults.
| Field type | Control |
|---|---|
| Text | Single-line input. |
| Number | Numeric input. |
| Boolean | On/off switch. |
| Select | Dropdown of the options the app declares. |
apps write permission; viewing does not.Connections to the tool itself (hosts, credentials, access servers) are defined by each app, usually on a page in its Settings group, not in this dialog.
When the catalog has a newer version of an app than the one your organization runs, two things happen:
apps write permission.The upgrade moves only your organization's installed version and runs the app's upgrade hook for your tenant; it is recorded in your audit trail. If the newer package has not yet been downloaded to the platform, only a platform administrator can pull it, and the banner instead says A platform administrator must install this release on the server first.
Platform administrators see an extra Upload App button on the Marketplace, and an Install button on catalog entries with a package. Install App Package offers two tabs:
.zip, .tar, .tar.gz or .tgz package, up to 50 MB, containing a valid manifest.yaml.On success the dialog confirms “App installed successfully” with the app name and version. Organizations then enable the app from the Marketplace. Organization users cannot install or upload packages.
| Action | Requirement |
|---|---|
| Browse Marketplace and Installed Apps, view app settings | Any signed-in user. |
| Enable, disable, save settings, upgrade your tenant | apps write permission. |
| Uninstall | Platform administrator only. |
| Install from catalog, upload a package, install from URL, pull a new version to the server | Platform administrator. |
The limit counts enabled apps for your organization. Disabled apps do not count.
| Plan | Enabled apps |
|---|---|
| Free | 10 |
| Starter | 15 |
| Professional | 20 |
| Enterprise | 100 |
Past the limit, Enable fails with Enabled app limit reached (N for <tier> tier). A per-organization override set by a platform administrator can raise it. A tenant whose trial has ended without a payment method may also be blocked from changes with a prompt to add a payment method; reads stay open. See Plans & Trial.
veltrix_list_apps) but cannot enable, disable or install them.