integration-profile

Configures integration profiles, providers and import/export operations.

Source path: libraries/core/src/integration-profile

Module file: integration-profile.module.ts

Introduction

This page documents the integration-profile submodule as part of the Core package. Use it as a quick technical reference for implementation scope, exposed APIs and MCP integration points.

HTTP Endpoints

11 endpoints

List all available integration types.

List available providers, optionally filtered by integration type.

Query: typeId? (int), typeSlug? (string)

List integration profiles with optional filters.

Query: page, pageSize, typeId?, typeSlug?, providerSlug?

Export integration profiles as JSON, optionally including secrets.

Query: ids: number[], include_secrets? (bool)

Get an integration profile by ID.

Params: id (int)

Create a new integration profile.

Body

Field	Type	Required	Notes
slug	string	yes	Max 255 chars
name	string	yes	Max 127 chars
type_id	number	yes	Min 1
provider_id	number	yes	Min 1
config	object	no	—
is_active	boolean	no	—

Test an integration profile configuration without saving.

Body

Field	Type	Required	Notes
slug	string	yes	Max 255 chars
name	string	yes	Max 127 chars
type_id	number	yes	—
provider_id	number	yes	—
config	object	no	—

Update an integration profile.

Params: id (int)

Body

Field	Type	Required	Notes
slug	string	no	Max 255 chars
name	string	no	Max 127 chars
type_id	number	no	—
provider_id	number	no	—
config	object	no	—
is_active	boolean	no	—

Delete one or more integration profiles.

Body

Field	Type	Required	Notes
ids	number[]	yes	IDs to delete

Validate an integration profile import file before applying.

Body

Field	Type	Required	Notes
file	File	yes	JSON export file, multipart/form-data

Confirm and apply a previously validated integration profile import.

Body

Field	Type	Required	Notes
profiles	{ slug, name, type_slug, provider_slug, config?, is_active? }[]	yes	ArrayNotEmpty
conflict_resolutions	{ slug, action: "ignore" \| "replace" \| "rename_auto" }[]	no	—

MCP Tools

No MCP tools mapped for this submodule.