Waiting for engine...
Skip to main content

Boomi API Control Plane REST API (MCP Registry) - Servers

Toggle Pane

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.

Servers

Query MCP servers and server versions across registries. Requires JWT issued by Platform in the Authorization header.

Get a specific MCP server version

Get the details of a specific server version in the resolved registry, including its cached tool definitions.

Authorizations:
bearerAuth
path Parameters
serverName
required
string

URL-decoded MCP server name in namespace/name format (for example, com.example/my-server).

version
required
string

MCP server version to retrieve (for example, 1.0.0).

Responses

Response Schema: application/json
object (ServerResponseMeta)

Registry metadata for a server version response

object (ServerJSON)

Schema for a static representation of an MCP server. Used in various contexts related to discovery, installation, and configuration.

Response samples

Content type
application/json
{
  • "_meta": {
    • "com.boomi.registry/official": {
      },
    • "additionalProperties": {
      }
    },
  • "server": {
    • "name": "io.github.user/weather",
    • "description": "MCP server providing weather data and forecasts via OpenWeatherMap API",
    • "version": "1.0.2",
    • "title": "Weather API",
    • "icons": [],
    • "packages": { },
    • "remotes": { },
    • "repository": {},
    • "_meta": {
      }
    }
}

Get all registered MCP servers

Get a paginated list of MCP servers in the resolved registry, optionally filtered by search term, version, update time, status, or source registry. Set full_text_search=true to use full-text search across server and tool metadata.

Authorizations:
bearerAuth
query Parameters
sort
string
Default: "name,asc"
Enum: "name,asc" "name,desc" "createdAt,asc" "createdAt,desc"

Sort order. Format: field,direction. Defaults to name,asc.

cursor
string

Opaque cursor token returned as nextCursor in the previous response. Omit on the first request. Treat this value as opaque; its internal format may change.

limit
integer [ 1 .. 100 ]
Default: 30

Maximum number of items to return per page. Must be between 1 and 100.

search
string

Case-insensitive substring match against the server name.

updated_since
string <date-time>
version
string
status
string
Enum: "active" "deprecated" "deleted"
source_id
string <uuid>
full_text_search
boolean
Default: false
fetch_unassigned
boolean
Default: false
exclude_local_servers
boolean
Default: false
exclude_packages
boolean
Default: false

Responses

Response Schema: application/json
object (PaginationMetadata)
Array of objects (ServerResponse)

Response samples

Content type
application/json
{
  • "metadata": {
    • "offsetStart": 0,
    • "nextCursor": "string",
    • "page": 0,
    • "totalPages": 0,
    • "totalElements": 0,
    • "limit": 0,
    • "count": 0
    },
  • "servers": [
    • {
      }
    ]
}

Get all versions of a specific MCP server

Get all available versions for the named MCP server in the resolved registry, ordered by publication date (newest first).

Authorizations:
bearerAuth
path Parameters
serverName
required
string

URL-decoded MCP server name in namespace/name format (for example, com.example/my-server).

Responses

Response Schema: application/json
object (PaginationMetadata)
Array of objects (ServerResponse)

Response samples

Content type
application/json
{
  • "metadata": {
    • "offsetStart": 0,
    • "nextCursor": "string",
    • "page": 0,
    • "totalPages": 0,
    • "totalElements": 0,
    • "limit": 0,
    • "count": 0
    },
  • "servers": [
    • {
      }
    ]
}

Get all registered MCP servers for a given registry

Get a paginated list of MCP servers in the specified registry, optionally filtered by search term, version, update time, status, or source registry. Set full_text_search=true to use full-text search across server and tool metadata.

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

Identifier of the target registry.

query Parameters
sort
string
Default: "name,asc"
Enum: "name,asc" "name,desc" "createdAt,asc" "createdAt,desc"

Sort order. Format: field,direction. Defaults to name,asc.

cursor
string

Opaque cursor token returned as nextCursor in the previous response. Omit on the first request. Treat this value as opaque; its internal format may change.

limit
integer [ 1 .. 100 ]
Default: 30

Maximum number of items to return per page. Must be between 1 and 100.

search
string

Case-insensitive substring match against the server name.

updated_since
string <date-time>
version
string
status
string
Enum: "active" "deprecated" "deleted"
source_id
string <uuid>
full_text_search
boolean
Default: false
fetch_unassigned
boolean
Default: false
exclude_local_servers
boolean
Default: false
exclude_packages
boolean
Default: false

Responses

Response Schema: application/json
object (PaginationMetadata)
Array of objects (ServerResponse)

Response samples

Content type
application/json
{
  • "metadata": {
    • "offsetStart": 0,
    • "nextCursor": "string",
    • "page": 0,
    • "totalPages": 0,
    • "totalElements": 0,
    • "limit": 0,
    • "count": 0
    },
  • "servers": [
    • {
      }
    ]
}

Get all versions of a specific MCP server in a given registry

Get all available versions for the named MCP server in the specified registry, ordered by publication date (newest first).

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

Identifier of the target registry.

serverName
required
string

URL-decoded MCP server name in namespace/name format (for example, com.example/my-server).

Responses

Response Schema: application/json
object (PaginationMetadata)
Array of objects (ServerResponse)

Response samples

Content type
application/json
{
  • "metadata": {
    • "offsetStart": 0,
    • "nextCursor": "string",
    • "page": 0,
    • "totalPages": 0,
    • "totalElements": 0,
    • "limit": 0,
    • "count": 0
    },
  • "servers": [
    • {
      }
    ]
}

Get a specific MCP server version in a given registry

Get the details of a specific server version in the specified registry, including its cached tool definitions.

Authorizations:
bearerAuth
path Parameters
id
required
string <uuid>

Identifier of the target registry.

serverName
required
string

URL-decoded MCP server name in namespace/name format (for example, com.example/my-server).

version
required
string

MCP server version to retrieve (for example, 1.0.0).

Responses

Response Schema: application/json
object (ServerResponseMeta)

Registry metadata for a server version response

object (ServerJSON)

Schema for a static representation of an MCP server. Used in various contexts related to discovery, installation, and configuration.

Response samples

Content type
application/json
{
  • "_meta": {
    • "com.boomi.registry/official": {
      },
    • "additionalProperties": {
      }
    },
  • "server": {
    • "name": "io.github.user/weather",
    • "description": "MCP server providing weather data and forecasts via OpenWeatherMap API",
    • "version": "1.0.2",
    • "title": "Weather API",
    • "icons": [],
    • "packages": { },
    • "remotes": { },
    • "repository": {},
    • "_meta": {
      }
    }
}