Waiting for engine...
Skip to main content

Boomi Agent Garden Design APIs - Sources

Toggle Pane
API docs by Redocly

Download OpenAPI Specification: Download

Run In Postman

For more information about Postman collections, forking, and making your first API call, refer to the Working with Boomi APIs on Postman page.

Sources

Manage data sources and MCP servers available to agents.

List All MCP Servers

List all MCP servers with pagination and filtering options.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_VIEW.

Authorizations:
Boomi-Platform-JWTBoomi-Platform-API-Key
query Parameters
page
integer (Page) >= 1
Default: 1

Page number to retrieve

page_size
integer (Page Size) [ 1 .. 100 ]
Default: 100

Number of records per page

status
Array of strings (Status)
Items Enum: "ACTIVE" "STALE" "DISABLED"

Filter by server status

search_term
string (Search Term)

Filter by a substring match in name or description

sort_by
string (Sort By)
Default: "last_updated_on"

Field to sort by

sort_order
string (Sort Order) ^(asc|desc)$
Default: "desc"

Sort order (default: desc)

Responses

Response Schema: application/json
Any of
success
boolean (Success)
Default: true
Message (string) or Message (null) (Message)
PaginationResponse[MCPServerSummaryResponse] (object) or null

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "MCP servers retrieved successfully",
  • "data": {}
}

Create A New MCP Server

Create a new MCP server and retrieve its tools via MCP list_tools call.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_INSTALL, AGENT_CREATE.

Authorizations:
Boomi-Platform-JWTBoomi-Platform-API-Key
Request Body schema: application/json
required
name
required
string (Name)

Human-readable name which is defined from UI.

url
required
string (Url)

Base connection URL (NOT NULL for SSE/HTTP).

transport_type
required
string (MCPServerTransportType)
Enum: "SSE" "HTTP"

How the server communicates.

Description (string) or Description (null) (Description)

Optional server description.

Title (string) or Title (null) (Title)

UI Intended server title.

Array of Headers (objects) or Headers (string) or Headers (null) (Headers)

Optional Server Headers.

Capabilities (object) or Capabilities (null) (Capabilities)

Server capabilities as JSON.

Instructions (object) or Instructions (null) (Instructions)

Server instructions.

MCPServerAuthentication (object) or Authentication (string) or Authentication (null) (Authentication)

Authentication configuration for the API endpoint.

Array of Tools (objects) or Tools (null) (Tools)
Default: []

List of tools names to include from the MCP server. If not specified, all tools will be included.

Request Id (string) or Request Id (null) (Request Id)

Unique request ID for Oauth.

Meta (object) or Meta (null) (Meta)

Opaque provenance/metadata blob from the MCP Registry (source id, source name, registry server name/version, provenance, isLatest, updatedAt, repository, icons, ...). Stored as-is.

Responses

Response Schema: application/json
Any of
success
boolean (Success)
Default: true
Message (string) or Message (null) (Message)
MCPServer (object) or null

Request samples

Content type
application/json
{
  • "name": "o2c-mcp-source-1",
  • "description": "o2c-mcp-source",
  • "url": "https://baselineagent-qa-tr1e90.mcp-bridge.qa.apiida-pipeline.boomi.com/mcp?name=<mcp-server-name>",
  • "transport_type": "SSE",
  • "headers": [
    • {
      }
    ],
  • "tools": [
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      }
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "5 tools for o2c-mcp-source-1 successfully imported.",
  • "data": {
    • "id": "f5e55d6e-31a3-4d98-945d-817f497193e4",
    • "created_on": "2026-06-01T12:21:19.036858Z",
    • "last_updated_on": "2026-06-01T12:21:19.036858Z",
    • "installed_on": "2026-06-01T12:21:20.920221Z",
    • "name": "o2c-mcp-source-1",
    • "description": "o2c-mcp-source",
    • "url": "https://baselineagent-qa-tr1e90.mcp-bridge.qa.apiida-pipeline.boomi.com/mcp?name=<mcp-server-name>",
    • "title": null,
    • "headers": [
      ],
    • "transport_type": "SSE",
    • "authentication": null,
    • "tools": [ ],
    • "status": "ACTIVE",
    • "agents_equipped_count": 0,
    • "tool_counts": {
      },
    • "imported_tools": [
      ],
    • "available_tools": [
      ],
    • "tool_changes": {
      }
    }
}

Get A Specific MCP Server By Id

Retrieve a specific MCP server by its ID.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_VIEW.

Authorizations:
Boomi-Platform-JWTBoomi-Platform-API-Key
path Parameters
server_id
required
string <uuid> (Server Id)
query Parameters
include_tools
boolean (Include Tools)
Default: true

Include associated tools in response

Responses

Response Schema: application/json
Any of
success
boolean (Success)
Default: true
Message (string) or Message (null) (Message)
MCPServer (object) or null

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "MCP server retrieved successfully",
  • "data": {
    • "id": "853490e8-c574-41ac-8d9f-38e49f3860b0",
    • "created_on": "2026-05-21T08:53:42.285528Z",
    • "last_updated_on": "2026-05-21T08:53:42.285528Z",
    • "installed_on": "2026-05-21T08:53:44.885911Z",
    • "name": "o2c-mcp-source-1",
    • "description": "o2c-mcp-source",
    • "url": "https://baselineagent-qa-tr1e90.mcp-bridge.qa.apiida-pipeline.boomi.com/mcp?name=<mcp-server-name>",
    • "title": null,
    • "headers": [
      ],
    • "transport_type": "SSE",
    • "authentication": null,
    • "tools": [ ],
    • "status": "ACTIVE",
    • "agents_equipped_count": 0,
    • "tool_counts": {
      },
    • "imported_tools": [
      ],
    • "available_tools": [ ],
    • "tool_changes": {
      }
    }
}

Update An Existing MCP Server

Update an existing MCP server with the provided data.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_EDIT.

Authorizations:
Boomi-Platform-JWTBoomi-Platform-API-Key
path Parameters
server_id
required
string <uuid> (Server Id)
Request Body schema: application/json
required
id
string (Id)

Unique identifier for the resource.

created_on
string <date-time> (Created On)

Timestamp when the resource was created.

last_updated_on
string <date-time> (Last Updated On)

Timestamp when the resource was last updated.

Installed On (string) or Installed On (null) (Installed On)

Timestamp when the resource was last used.

Name (string) or Name (null) (Name)

Human-readable name which is defined from UI.

Description (string) or Description (null) (Description)

Optional server description.

Url (string) or Url (null) (Url)

Base connection URL (NOT NULL for SSE/HTTP).

Title (string) or Title (null) (Title)

UI Intended server title.

Array of Headers (objects) or Headers (string) or Headers (null) (Headers)

Optional Server Headers.

Capabilities (object) or Capabilities (null) (Capabilities)

Server capabilities as JSON.

Instructions (object) or Instructions (null) (Instructions)

Server instructions.

MCPServerTransportType (string) or null
Default: "HTTP"

How the server communicates.

MCPServerAuthentication (object) or MCPServerSecureOAuthAuthentication (object) or Authentication (string) or Authentication (null) (Authentication)

Authentication configuration for the API endpoint.

Array of Tools (objects) or Tools (null) (Tools)
Default: []

List of tools names to include from the MCP server. If not specified, all tools will be included.

Request Id (string) or Request Id (null) (Request Id)

Unique request ID for Oauth token.

Meta (object) or Meta (null) (Meta)

Opaque provenance/metadata blob from the MCP Registry (source id, source name, registry server name/version, provenance, isLatest, updatedAt, repository, icons, ...). Stored as-is.

MCPServerStatus (string) or null
Default: "ACTIVE"

Server lifecycle status.

unique_name
string (Unique Name)

Unique name of the MCP Server.

Encrypted Data Key (string) or Encrypted Data Key (null) (Encrypted Data Key)
imported_tools_count
integer (Imported Tools Count)
Default: 0

Count of tools imported

agents_equipped_count
integer (Agents Equipped Count)
Default: 0

Count of agent equipped

MCPToolCounts (object) or null

Count of tools count

Array of Imported Tools (objects) or Imported Tools (null) (Imported Tools)
Default: []

List of tools names to include from the MCP server.

Array of Available Tools (objects) or Available Tools (null) (Available Tools)
Default: []

Available tools for MCP

MCPServerToolChanges (object) or null

Dictionary of tools changes

Responses

Response Schema: application/json
Any of
success
boolean (Success)
Default: true
Message (string) or Message (null) (Message)
MCPServerSecure (object) or null

Request samples

Content type
application/json
{
  • "name": "Order to Customer MCP Server",
  • "description": "MCP server exposing order management tools - handles orders, customers, products, payments and notifications",
  • "transport_type": "SSE",
  • "status": "ACTIVE",
  • "headers": [
    • {
      }
    ],
  • "tools": [
    • {
      },
    • {
      },
    • {
      }
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "MCP server Order to Customer MCP Server updated successfully",
  • "data": {
    • "id": "bcb51e3a-8cbc-474a-ab1b-1fda2a2bbdfa",
    • "created_on": "2026-06-01T10:25:01.751837Z",
    • "last_updated_on": "2026-06-01T10:26:23.629436Z",
    • "installed_on": "2026-06-01T10:25:04.248505Z",
    • "name": "Order to Customer MCP Server",
    • "description": "MCP server exposing order management tools - handles orders, customers, products, payments and notifications",
    • "url": "https://baselineagent-qa-tr1e90.mcp-bridge.qa.apiida-pipeline.boomi.com/mcp?name=<mcp-server-name>",
    • "title": null,
    • "headers": [
      ],
    • "transport_type": "SSE",
    • "authentication": null,
    • "tools": [ ],
    • "status": "ACTIVE",
    • "agents_equipped_count": 0,
    • "tool_counts": {
      },
    • "imported_tools": [
      ],
    • "available_tools": [
      ],
    • "tool_changes": {
      }
    }
}

Delete An Existing MCP Server

Perform a soft delete on an MCP server by updating its is_deleted flag to True.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_DELETE.

Authorizations:
Boomi-Platform-JWTBoomi-Platform-API-Key
path Parameters
server_id
required
string <uuid> (Server Id)

Responses

Response Schema: application/json
Any of
success
boolean (Success)
Default: true
Message (string) or Message (null) (Message)
MCPServer (object) or null

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "MCP server deleted successfully",
  • "data": null
}

Discover Tools From MCP Server

Connect to MCP server and discover available tools with their input parameters.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_CREATE.

Authorizations:
Boomi-Platform-JWTBoomi-Platform-API-Key
Request Body schema: application/json
required
name
required
string (Name)

Human-readable name which is defined from UI.

url
required
string (Url)

Base connection URL (NOT NULL for SSE/HTTP).

transport_type
required
string (MCPServerTransportType)
Enum: "SSE" "HTTP"

How the server communicates.

Description (string) or Description (null) (Description)

Optional server description.

Title (string) or Title (null) (Title)

UI Intended server title.

Array of Headers (objects) or Headers (string) or Headers (null) (Headers)

Optional Server Headers.

Capabilities (object) or Capabilities (null) (Capabilities)

Server capabilities as JSON.

Instructions (object) or Instructions (null) (Instructions)

Server instructions.

MCPServerAuthentication (object) or Authentication (string) or Authentication (null) (Authentication)

Authentication configuration for the API endpoint.

Array of Tools (objects) or Tools (null) (Tools)
Default: []

List of tools names to include from the MCP server. If not specified, all tools will be included.

Request Id (string) or Request Id (null) (Request Id)

Unique request ID for Oauth.

Meta (object) or Meta (null) (Meta)

Opaque provenance/metadata blob from the MCP Registry (source id, source name, registry server name/version, provenance, isLatest, updatedAt, repository, icons, ...). Stored as-is.

Responses

Response Schema: application/json
Any of
success
boolean (Success)
Default: true
Message (string) or Message (null) (Message)
Array of Data (objects) or Data (null) (Data)

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Discovered tools successfully updated.",
  • "data": [
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      }
    ]
}

List All Sources

Retrieve a paginated list of source_builders with optional filters and sorting.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_VIEW, AGENT_CREATE.

Authorizations:
Boomi-Platform-JWTBoomi-Platform-API-Key
query Parameters
page
integer (Page) >= 1
Default: 1

Page number to retrieve

page_size
integer (Page Size) [ 1 .. 100 ]
Default: 100

Number of records per page

source_type
Array of strings (Source Type)
Items Enum: "MCPServer" "acp_source" "Application"

Filter by source type

source_status
Array of strings (Source Status)
Items Enum: "DRAFT" "ACTIVE" "DISABLED" "STALE" "NOT_AVAILABLE"

Filter by source status

search_term
string (Search Term)

Filter by a substring match in name or description

sort_by
string (Sort By)
Default: "last_updated_on"

Field to sort by

sort_order
string (Sort Order) ^(asc|desc)$
Default: "desc"

Sort order (default: desc)

Responses

Response Schema: application/json
Any of
success
boolean (Success)
Default: true
Message (string) or Message (null) (Message)
PaginationResponse[SourceSummaryResponse] (object) or null

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Sources retrieved successfully",
  • "data": {
    • "total_items": 19,
    • "total_pages": 1,
    • "current_page": 1,
    • "page_size": 100,
    • "items": []
    }
}

Get A Specific Application Source By Id

Retrieve detailed information about a specific Application/Fabric source.

Required privileges: AGENT_GARDEN_ACCESS, AGENT_VIEW.

Authorizations:
Boomi-Platform-JWTBoomi-Platform-API-Key
path Parameters
source_id
required
string <uuid> (Source Id)

The unique identifier of the application source to retrieve

Responses

Response Schema: application/json
Any of
success
boolean (Success)
Default: true
Message (string) or Message (null) (Message)
SystemFabricSourceDetailResponse (object) or null

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Application source retrieved successfully",
  • "data": {
    • "id": "26c6f3d8-8d0f-4af0-8f73-ab0bf8594b92",
    • "created_on": "2026-04-28T08:37:24.682277Z",
    • "last_updated_on": "2026-04-28T08:37:24.682277Z",
    • "installed_on": null,
    • "name": "Gmail",
    • "description": "Google's email service",
    • "application_name": "gmail",
    • "application_icon": "PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjUyIDQyIDg4IDY2Ij4NCjxwYXRoIGZpbGw9IiM0Mjg1ZjQiIGQ9Ik01OCAxMDhoMTRWNzRMNTIgNTl2NDNjMCAzLjMyIDIuNjkgNiA2IDYiLz4NCjxwYXRoIGZpbGw9IiMzNGE4NTMiIGQ9Ik0xMjAgMTA4aDE0YzMuMzIgMCA2LTIuNjkgNi02VjU5bC0yMCAxNSIvPg0KPHBhdGggZmlsbD0iI2ZiYmMwNCIgZD0iTTEyMCA0OHYyNmwyMC0xNXYtOGMwLTcuNDItOC40Ny0xMS42NS0xNC40LTcuMiIvPg0KPHBhdGggZmlsbD0iI2VhNDMzNSIgZD0iTTcyIDc0VjQ4bDI0IDE4IDI0LTE4djI2TDk2IDkyIi8+DQo8cGF0aCBmaWxsPSIjYzUyMjFmIiBkPSJNNTIgNTF2OGwyMCAxNVY0OGwtNS42LTQuMmMtNS45NC00LjQ1LTE0LjQtLjIyLTE0LjQgNy4yIi8+DQo8L3N2Zz4=",
    • "status": "ACTIVE",
    • "agents_equipped_count": 0,
    • "tool_counts": {
      },
    • "imported_tools": [
      ],
    • "fabric_application_id": "gmail"
    }
}