Retrieve MCP Gateway Instances
get
/ic/api/integration/v1/monitoring/mcp/instances
Retrieve MCP gateway tracking instances.
Request
Query Parameters
-
integrationInstance(required): string
Service instance name, as in the About page. Public routing parameter; not declared in the factory controller.Example:
example-instance -
limit: integer(int32)
Page size; values normalize to the range 1–500.Default Value:
100 -
offset: integer(int32)
Page offset; negative values normalize to 0.Default Value:
0 -
orderBy: string
Allowed values: creationdate, lastupdateddate. Default: lastupdateddate. Valid values: creationdate, lastupdateddate.Default Value:
lastupdateddate -
projectId: string
Optional project code. When supplied, checks project access. Collection endpoints also apply a project filter. When omitted, the factory applies no project-specific access check or filter.
-
q: string
Mongo-style filter string. Implemented filters: timewindow, startdate, enddate, id/instanceId, status. timewindow: 1h (default), 6h, 1d, 2d, 3d, 7d, 8d, 32d, RETENTIONPERIOD. Dates use UTC yyyy-MM-dd HH:mm:ss; do not combine timewindow with dates. Canonical statuses: RECEIVED, FAULTED, DISALLOWED_BY_MCP_GATEWAY_POLICY, COMPLETED. Aliases accepted: IN_PROGRESS/INPROGRESS/RUNNING; FAILED/ERROR/ERRORED; DISALLOWED/POLICY_DENIED/POLICY_DENY/POLICY_DISALLOWED; SUCCEEDED/SUCCESS. With id/instanceId and no projectId, the factory uses direct ID lookup rather than date/sort search. Other generic tracking filter keys may parse but are not applied by this MCP builder.Example:
{timewindow:'1h', status:'FAULTED'} -
sortOrder: string
Allowed values: ASC, DESC. Default: DESC. Valid values: ASC, DESC.Default Value:
DESC
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json; charset=utf-8
200 Response
Successful operation
Root Schema : MCPGatewayInstancesRs
Type:
Show Source
object-
hasMore: boolean
Indicates whether more instances are available
-
items: array
items
List of MCP Gateway tracking instances
-
limit: integer
(int32)
Limit used for the query
-
offset: integer
(int32)
Offset used for the query
-
searchDurationInMs: integer
(int64)
Query service search duration in milliseconds
-
totalMatchedInstances: integer
(int64)
Total matched instances in the query service
-
totalResults: integer
(int64)
Number of instances returned
Match All
Show Source
Nested Schema : MCPGatewayInstanceRs
Type:
Show Source
object-
creationDate: string
(date-time)
Instance creation date
-
errorCode: string
Error code
-
errorMessage: string
Error message
-
errorSummary: string
Error summary
-
eventsCount: integer
(int32)
Number of events returned with the instance
-
flowEventId: string
Flow event id
-
flowId: string
Flow id
-
gatewayCode: string
Gateway code
-
gatewayVersion: string
Gateway version
-
httpResponseCode: integer
(int32)
HTTP response code
-
invokedBy: string
User that invoked the MCP Gateway request
-
isError: boolean
Indicates whether the instance has error details
-
isEventsLimited: boolean
Indicates whether event data was limited
-
lastErrorType: string
Last error type
-
lastUpdatedDate: string
(date-time)
Instance last updated date
-
mcpServerCode: string
MCP server code
-
mcpServerVersion: string
MCP server version
-
mcpToolName: string
MCP tool name
-
ociRequestId: string
OCI request id
-
payloadAvailable: boolean
Indicates whether payload metadata exists
-
policyCategory: string
MCP Gateway policy category
-
policyCode: string
MCP Gateway policy code
-
policyVersion: string
MCP Gateway policy version
-
projectCode: string
Project code
-
requestHeaders: string
Request headers captured by runtime tracking
-
requestOperation: string
Request operation
-
requestUrl: string
Request URL
-
serviceInstanceId: string
Runtime service instance id used for payload lookup
-
sizeLimited: boolean
Indicates whether payload data was size-limited
-
state: string
Normalized runtime state
-
totalInboundPayloadsSize: integer
(int64)
Total inbound payload size
-
totalOutboundPayloadsSize: integer
(int64)
Total outbound payload size
-
totalProcessingTime: integer
(int64)
Total processing time in milliseconds
-
totalWirePayloadsSize: integer
(int64)
Total wire payload size
-
tracingLevel: string
MCP Gateway tracing/reporting level
-
updatesCount: integer
(int64)
Number of runtime updates
Match All
Show Source
400 Response
Invalid parameters; also used for downstream query-service errors other than throttling.
401 Response
Unauthorized, or supplied project context fails the factory access check.
429 Response
Downstream tracking service throttled the request.
500 Response
Server error
Examples
The following examples show how to retrieve the MCP gateway tracking instances by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL. For more information about endpoint URL structure, see Send Requests.
Example: Retrieve MCP gateway tracking instances
curl --get \"${BASE_URL}/ic/api/integration/v1/monitoring/mcp/instances\" \\\n --header \"Authorization: Bearer ${ACCESS_TOKEN}\" \\\n --data-urlencode \"integrationInstance=${INTEGRATION_INSTANCE}\" \\\n --data-urlencode \"projectId=${PROJECT_ID}\"