API docs by Redocly

API Catalog Connect REST API (67.0)

Download OpenAPI specification:Download

Use the API Catalog Connect REST API to discover and browse APIs in your org, inspect API versions and operations, and register and manage external MCP servers.

getApi

Gets an API.

path Parameters
apiId
required
string

The ID of the API.

sourceId
required
string

The ID of the source of the API.

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "id": "string",
  • "label": "string",
  • "properties": {
    },
  • "providerType": "string"
}

fetchMcpServer

Fetch current metadata from the MCP server (stateless). Returns the merged list of remote-advertised assets and locally-stored assets so the caller can decide what to allowlist via PUT /assets.

path Parameters
id
required
string

The MCP server identifier.

Responses

Response samples

Content type
application/json
{
  • "assets": [
    ]
}

createMcpServer

Registers a new EXTERNAL MCP server. The connection is established and an initial fetch of remote assets is performed; the response includes the discovered assets so the caller can immediately allowlist them via PUT /assets. type must be set to EXTERNAL in the request body.

Request Body schema: application/json
object (sfdc.apicatalog.connect.api.input.McpServerAuthorizationInputRepresentation)

Authorization payload for an EXTERNAL MCP server. Discriminated by authType. Required fields by authType: OAUTH: identityProvider, clientId, clientSecret, scope NO_AUTH: authType only.

description
string

Description of the MCP server.

label
string

Human-readable label.

name
required
string

Developer name (unique within the org). Immutable after create.

serverUrl
required
string

The remote MCP endpoint URL.

type
required
string

Server type. Required. Must be EXTERNAL.

Responses

Request samples

Content type
application/json
{
  • "authorization": {
    },
  • "description": "string",
  • "label": "string",
  • "name": "string",
  • "serverUrl": "string",
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "assets": [
    ],
  • "server": {
    }
}

listMcpServers

Lists registered MCP servers.

query Parameters
label
string

Filter by label (case-insensitive partial match).

status
string

Filter by connection status. One of ACTIVE, DISCONNECTED.

type
string

Filter by server type.

Responses

Response samples

Content type
application/json
{
  • "mcpServers": [
    ]
}

getMcpServer

Gets MCP server metadata.

path Parameters
id
required
string

The MCP server identifier.

Responses

Response samples

Content type
application/json
{
  • "authorization": {
    },
  • "createdById": "string",
  • "createdDate": "string",
  • "description": "string",
  • "id": "string",
  • "label": "string",
  • "lastModifiedById": "string",
  • "lastModifiedDate": "string",
  • "name": "string",
  • "serverUrl": "string",
  • "status": "string",
  • "type": "string"
}

deleteMcpServer

Hard-deletes an MCP server. Cascades to all allowlisted assets and the connection record. Irreversible.

path Parameters
id
required
string

The MCP server identifier.

Responses

updateMcpServer

Updates MCP server metadata and/or credentials. Top-level scalars use PATCH semantics; the authorization block uses REPLACE semantics. name and type are immutable.

path Parameters
id
required
string

The MCP server identifier.

Request Body schema: application/json
object (sfdc.apicatalog.connect.api.input.McpServerAuthorizationInputRepresentation)

Authorization payload for an EXTERNAL MCP server. Discriminated by authType. Required fields by authType: OAUTH: identityProvider, clientId, clientSecret, scope NO_AUTH: authType only.

description
string

Description of the MCP server.

label
string

Human-readable label.

serverUrl
string

The remote MCP endpoint URL.

Responses

Request samples

Content type
application/json
{
  • "authorization": {
    },
  • "description": "string",
  • "label": "string",
  • "serverUrl": "string"
}

Response samples

Content type
application/json
{
  • "authorization": {
    },
  • "createdById": "string",
  • "createdDate": "string",
  • "description": "string",
  • "id": "string",
  • "label": "string",
  • "lastModifiedById": "string",
  • "lastModifiedDate": "string",
  • "name": "string",
  • "serverUrl": "string",
  • "status": "string",
  • "type": "string"
}

listMcpServerAssets

Lists allowlisted assets on the MCP server.

path Parameters
id
required
string

The MCP server identifier.

Responses

Response samples

Content type
application/json
{
  • "assets": [
    ]
}

replaceMcpServerAssets

Replaces the full set of assets for the server. Assets in the body are stored; previously stored assets omitted from the body are removed from the allowlist.

path Parameters
id
required
string

The MCP server identifier.

Request Body schema: application/json
required
Array of objects (sfdc.apicatalog.connect.api.input.McpServerAssetReplaceItemRepresentation)

Desired asset allowlist.

Responses

Request samples

Content type
application/json
{
  • "assets": [
    ]
}

Response samples

Content type
application/json
{
  • "assets": [
    ]
}

getApiVersions

Gets all the API versions.

path Parameters
apiId
required
string

The ID of the API.

sourceId
required
string

The ID of the source of the API.

Responses

Response samples

Content type
application/json
{
  • "apiVersions": [
    ]
}

getSources

Gets all the API sources.

Responses

Response samples

Content type
application/json
{
  • "sources": [
    ]
}

getApis

Gets all the APIs.

query Parameters
schemaType
string

The schema type of the APIs to be retrieved. Supported values are REST and MCP.

source
string

The source of the APIs to be retrieved.

Responses

Response samples

Content type
application/json
{
  • "apis": [
    ]
}

getApiVersion

Gets an API version.

path Parameters
apiId
required
string

The ID of the API.

apiVersionId
required
string

The ID of the API version.

sourceId
required
string

The ID of the source of the API.

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "developerName": "string",
  • "externalSourceIdentifier": "string",
  • "id": "string",
  • "label": "string",
  • "providerType": "string",
  • "version": "string"
}

getApiVersionOperations

Gets all API version operations.

path Parameters
apiId
required
string

The ID of the API.

apiVersionId
required
string

The ID of the API version.

sourceId
required
string

The ID of the source of the API.

Responses

Response samples

Content type
application/json
{
  • "apiVersionOperations": [
    ]
}

DID THIS ARTICLE SOLVE YOUR ISSUE?
Let us know so we can improve!