Documentation

Apps & Marketplace

Overview

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:

  1. Install on the platform — registers the app package with the Veltrix server. This is done by a platform administrator, not by an organization user.
  2. Enable for your organization — makes the installed app available to your tenant. This is what you do from the Marketplace, and it is what counts against your plan's app limit.

Where to Find It

DestinationRouteWhat it is
Apps (sidebar, Apps group)/appsInstalled Apps page: every app that is installed for your organization, enabled or not. The old /installed-apps address redirects here.
Marketplace (sidebar, Apps group)/marketplaceThe 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>/pipelineEvery 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.

The Marketplace Page

Finding an app

  • Search matches name, vendor, category and description.
  • All Vendors and All Categories dropdowns narrow the list; choose the first option to clear them.
  • The All / Installed / Enabled / Available switch filters by state. The choice is stored in the address as ?status= (for example /marketplace?status=installed), so a filtered view can be bookmarked and the browser back button works.
  • The subtitle under the page title reflects the active filter, for example how many apps are enabled for your organization and how many more are available in the marketplace.
  • Refresh reloads apps, vendor integrations and the catalog.
FilterShows
AllEverything you can see.
InstalledApps that have an installation record for your organization (enabled or disabled).
EnabledApps currently switched on for your organization.
AvailableAnything 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.

Reading a card

ElementMeaning
Name, vX.Y.Z, vendorThe 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 availableThe catalog carries a newer version than the one installed. See Upgrades.
Category chipThe app's category, for example SIEM or EDR.
Built-in / Custom / MarketplaceWhere the app came from: shipped with the platform, uploaded as a package, or installed from the catalog.
InstallShown only to platform administrators, on catalog entries that have a downloadable package.
Platform administrator requiredWhat non-administrators see where an Install button would be: ask your platform administrator to install it.
Coming SoonThe 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 / DisableTurns the app on or off for your organization.

Enable, Disable and Uninstall

Enable an app

  1. Open Marketplace in the sidebar.
  2. Find the app and click Enable.
  3. When the card turns green, click it (or open Apps) to start using the app. Its pages are added to the sidebar.

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 an app

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.

Uninstall

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.

The Installed Apps Page

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.

  • Each card shows the app's logo, name, version, vendor, an Enabled or Disabled badge, its description, a category badge, and a source badge for non-built-in apps.
  • Below the card, quick links open each of the app's pages directly. A disabled app shows “Enable this app to see its pages”; an app with no dedicated pages says so. The links respect permissions, so you only see pages your role can use.
  • Open app goes to the app. Browse the marketplace jumps to the catalog, and Refresh reloads the list.
  • Filters: search (name, vendor, category, description), vendor, category, and an All / Enabled / Disabled switch. Cards are sorted by name.
  • With nothing installed, the page says “No apps installed yet” and links to the marketplace.

Inside an App

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:

  • Pages — the app's own screens, plus a platform-provided Pipeline page for that app.
  • Configurations — one entry per configuration type the app manages; large apps split these into labelled sub-groups.
  • Settings — app-defined settings pages, for example connections.

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.

Configuration types

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 labelMeaning
DraftEditable; not yet submitted.
Validating / Validation failedThe app's validator is running, or it rejected the configuration.
Pending approval / Changes requested / ApprovedApproval workflow states.
Queued / Deploying / Paused / DeployedDeployment progress.
Deploy failed / Rolled backRetryable states.
ArchivedNo longer active.

App Settings

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 typeControl
TextSingle-line input.
NumberNumeric input.
BooleanOn/off switch.
SelectDropdown of the options the app declares.
  • Required fields carry a red asterisk. Save Settings refuses to save until they are filled and lists the missing ones.
  • If an app has no settings the dialog says so. The gear icon is only shown on apps that declare settings.
  • Saving requires the apps write permission; viewing does not.
  • At the bottom, a Drift detection section sets a per-app override of your organization's drift-check frequency, or lets the app inherit the tenant default. It saves as soon as you change it, independently of Save Settings. The tenant-wide schedule lives under Settings and is covered in Drift Detection.

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.

Upgrades and the Update Banner

When the catalog has a newer version of an app than the one your organization runs, two things happen:

  • The marketplace card shows an Update available badge.
  • Inside the app, a banner reads A new version of <App> is available with “You're on vX · Latest release vY”. The banner only appears for users with the apps write permission.

Upgrade your organization

  1. Click Review & upgrade in the banner.
  2. Read the release notes in the dialog (basic Markdown: headings, bullets, quotes, bold, code and links; if the release has none, the dialog says so).
  3. Click Upgrade to vY. A success message confirms the new version, or says the app is already up to date.

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.

For Platform Administrators

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:

  • File — drag and drop or browse for a .zip, .tar, .tar.gz or .tgz package, up to 50 MB, containing a valid manifest.yaml.
  • URL — paste a link to a package (for example a release asset) and choose Install from URL.

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.

Permissions, Plans and Limits

ActionRequirement
Browse Marketplace and Installed Apps, view app settingsAny signed-in user.
Enable, disable, save settings, upgrade your tenantapps write permission.
UninstallPlatform administrator only.
Install from catalog, upload a package, install from URL, pull a new version to the serverPlatform administrator.

Enabled-app limit by plan

The limit counts enabled apps for your organization. Disabled apps do not count.

PlanEnabled apps
Free10
Starter15
Professional20
Enterprise100

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.

Good to Know

  • The marketplace and installed lists are scoped to your organization; another tenant's installs never appear.
  • Enable is per organization and cheap to undo. Uninstall is platform-wide and limited to platform administrators. Use Disable.
  • The version shown on a card is the platform copy; your organization's own installed version can lag it until you upgrade.
  • A Coming Soon entry is a placeholder in the catalog, not a hidden feature you can unlock.
  • If the catalog cannot be fetched, the page still lists the apps that are already on the platform.
  • AI assistants connected through the MCP server can list apps (veltrix_list_apps) but cannot enable, disable or install them.