Retrieve MCP Gateway Instances

get

/ic/api/integration/v1/monitoring/mcp/instances

Retrieve MCP gateway tracking instances.

Request

Query Parameters
  • Service instance name, as in the About page. Public routing parameter; not declared in the factory controller.
    Example:
    example-instance
  • Page size; values normalize to the range 1–500.
    Default Value: 100
  • Page offset; negative values normalize to 0.
    Default Value: 0
  • Allowed values: creationdate, lastupdateddate. Default: lastupdateddate. Valid values: creationdate, lastupdateddate.
    Default Value: lastupdateddate
  • 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.
  • 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'}
  • Allowed values: ASC, DESC. Default: DESC. Valid values: ASC, DESC.
    Default Value: DESC

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : MCPGatewayInstancesRs
Type: object
Show Source
Match All
Show Source
Nested Schema : items
Type: array
List of MCP Gateway tracking instances
Show Source
Nested Schema : MCPGatewayMonitoringIdResource
Type: object
Match All
Show Source
Nested Schema : MCPGatewayMonitoringGenericRestResource
Type: object
Show Source
Nested Schema : MCPGatewayMonitoringIdResource-allOf[1]
Type: object
Show Source
Nested Schema : MCPGatewayInstanceRs
Type: object
Show Source
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
Back to Top

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}\"
Back to Top