Jump to

• Request
• Response
• Examples

Retrieve MCP Gateways in a Project

get

/ic/api/integration/v1/projects/{projectId}/mcp/gateways

Retrieves MCP gateways configured for a project.

Request

Path Parameters

• projectId(required): string
  Project identifier

  Example:

  MCP_PROJECT

Query Parameters

• expand: string
  Reserved for future MCP gateway expansions.
• integrationInstance(required): string
  This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.

  Example:

  example-instance

• label: string
  Label parameter
• limit: integer(int32)
  Use with the offset parameter for paginating through the returned results.
• offset: integer(int32)
  Use with the limit parameter for paginating through the returned results.
• orderBy: string

  Lists MCP gateways ordered by name or last updated time.

  Valid values: name, time.

• q: string

  Filters MCP gateways by name, code, or status.

  Example:

  {code:'TOOLFILTER_GATEWAY', status:'CONFIGURED'}

• return: string
  Accepted but ignored in this release; this parameter does not select a minimal or full response view.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/vnd.oracle.model+json;type=collection
• application/json; charset=utf-8

200 Response

Successful operation

Body ()

Root Schema : MCPGatewaysRs

Type: object

Paginated collection of MCP gateways in a project.

Show Source

• hasMore: boolean
  Whether more results are available.
• items: array items
  Items returned in this collection.
• limit: integer (int32)
  Maximum number of results in this response.
• totalResults: integer (int32)
  Total number of matching results.

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MCPGatewayRs"
            },
            "description":"Items returned in this collection."
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of matching results."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Whether more results are available."
        },
        "limit":{
            "type":"integer",
            "format":"int32",
            "description":"Maximum number of results in this response."
        }
    },
    "description":"Paginated collection of MCP gateways in a project."
}

Nested Schema : items

Type: array

Items returned in this collection.

Show Source

• Array of: object MCPGatewayRs
  Project MCP gateway configuration, lifecycle state, resource references, and execution plan.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/MCPGatewayRs"
    },
    "description":"Items returned in this collection."
}

Nested Schema : MCPGatewayRs

Type: object

Project MCP gateway configuration, lifecycle state, resource references, and execution plan.

Show Source

• authorizationMode: string
  Allowed Values: [ "OIC", "DEDICATED_RESOURCE" ]

  Authorization mode for gateway activation.
• businessPolicies: array businessPolicies
  Policy references. On update, omitted or null retains existing policies and an empty array clears this category. A configured gateway must retain at least one security or business policy.
• code: string
  Resource code.
• created: string (date-time)
  Time the resource was created.
• createdBy: string
  User who created the resource.
• description: string
  Description of the resource.
• endpointURI: string
  Runtime endpoint of an active MCP gateway.
• executionPlan: executionPlan
  Policy execution order for gateway requests and responses.
• id: string
  Resource identifier.
• lastUpdated: string (date-time)
  Time the resource was last updated.
• lastUpdatedBy: string
  User who last updated the resource.
• links: array links
  Links to related resources.
• mcpServers: array mcpServers
  MCP server references used by the gateway.
• name: string
  Display name of the resource.
• processingTime: number (float)
  Server-reported processing time.
• projectId: string
  Project identifier.
• projectName: string
  Project display name.
• securityPolicies: array securityPolicies
  Policy references. On update, omitted or null retains existing policies and an empty array clears this category. A configured gateway must retain at least one security or business policy.
• status: string
  Allowed Values: [ "INPROGRESS", "ACTIVE", "CONFIGURED", "ACTIVATING", "ACTIVATION_FAILED", "DEACTIVATING", "FAILED" ]

  Current resource state.
• traceLevel: string
  Allowed Values: [ "NONE", "PRODUCTION", "AUDIT", "DEBUG" ]

  Gateway tracing level.
• version: string
  Resource version. The release accepts only 01.00.0000 on writes and uses it when the version is omitted.

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/MCP2610_Link"
            },
            "description":"Links to related resources."
        },
        "processingTime":{
            "type":"number",
            "format":"float",
            "description":"Server-reported processing time."
        },
        "id":{
            "type":"string",
            "description":"Resource identifier."
        },
        "projectId":{
            "type":"string",
            "description":"Project identifier."
        },
        "projectName":{
            "type":"string",
            "description":"Project display name."
        },
        "name":{
            "type":"string",
            "description":"Display name of the resource."
        },
        "code":{
            "type":"string",
            "description":"Resource code."
        },
        "version":{
            "type":"string",
            "description":"Resource version. The release accepts only 01.00.0000 on writes and uses it when the version is omitted."
        },
        "description":{
            "type":"string",
            "description":"Description of the resource."
        },
        "status":{
            "type":"string",
            "enum":[
                "INPROGRESS",
                "ACTIVE",
                "CONFIGURED",
                "ACTIVATING",
                "ACTIVATION_FAILED",
                "DEACTIVATING",
                "FAILED"
            ],
            "description":"Current resource state."
        },
        "traceLevel":{
            "type":"string",
            "enum":[
                "NONE",
                "PRODUCTION",
                "AUDIT",
                "DEBUG"
            ],
            "description":"Gateway tracing level."
        },
        "authorizationMode":{
            "type":"string",
            "enum":[
                "OIC",
                "DEDICATED_RESOURCE"
            ],
            "description":"Authorization mode for gateway activation."
        },
        "endpointURI":{
            "type":"string",
            "description":"Runtime endpoint of an active MCP gateway."
        },
        "mcpServers":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceRefRs"
            },
            "description":"MCP server references used by the gateway."
        },
        "securityPolicies":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceRefRs"
            },
            "description":"Policy references. On update, omitted or null retains existing policies and an empty array clears this category. A configured gateway must retain at least one security or business policy.",
            "nullable":true
        },
        "businessPolicies":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ResourceRefRs"
            },
            "description":"Policy references. On update, omitted or null retains existing policies and an empty array clears this category. A configured gateway must retain at least one security or business policy.",
            "nullable":true
        },
        "executionPlan":{
            "description":"Policy execution order for gateway requests and responses.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/ExecutionPlanRs"
                }
            ]
        },
        "created":{
            "type":"string",
            "format":"date-time",
            "description":"Time the resource was created."
        },
        "createdBy":{
            "type":"string",
            "description":"User who created the resource."
        },
        "lastUpdated":{
            "type":"string",
            "format":"date-time",
            "description":"Time the resource was last updated."
        },
        "lastUpdatedBy":{
            "type":"string",
            "description":"User who last updated the resource."
        }
    },
    "description":"Project MCP gateway configuration, lifecycle state, resource references, and execution plan."
}

Nested Schema : businessPolicies

Type: array

Policy references. On update, omitted or null retains existing policies and an empty array clears this category. A configured gateway must retain at least one security or business policy.

Show Source

• Array of: object ResourceRefRs
  Reference to an MCP server or policy used by a gateway.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ResourceRefRs"
    },
    "description":"Policy references. On update, omitted or null retains existing policies and an empty array clears this category. A configured gateway must retain at least one security or business policy.",
    "nullable":true
}

Nested Schema : executionPlan

Policy execution order for gateway requests and responses.

Match All

Policy execution order for gateway requests and responses.

Show Source

• object ExecutionPlanRs
  Ordered policy steps applied to gateway requests and responses.

{
    "description":"Policy execution order for gateway requests and responses.",
    "allOf":[
        {
            "$ref":"#/components/schemas/ExecutionPlanRs"
        }
    ]
}

Nested Schema : links

Type: array

Links to related resources.

Show Source

• Array of: object MCP2610_Link
  A link to a related REST resource.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/MCP2610_Link"
    },
    "description":"Links to related resources."
}

Nested Schema : mcpServers

Type: array

MCP server references used by the gateway.

Show Source

• Array of: object ResourceRefRs
  Reference to an MCP server or policy used by a gateway.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ResourceRefRs"
    },
    "description":"MCP server references used by the gateway."
}

Nested Schema : securityPolicies

Type: array

Policy references. On update, omitted or null retains existing policies and an empty array clears this category. A configured gateway must retain at least one security or business policy.

Show Source

• Array of: object ResourceRefRs
  Reference to an MCP server or policy used by a gateway.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ResourceRefRs"
    },
    "description":"Policy references. On update, omitted or null retains existing policies and an empty array clears this category. A configured gateway must retain at least one security or business policy.",
    "nullable":true
}

Nested Schema : ResourceRefRs

Type: object

Reference to an MCP server or policy used by a gateway.

Show Source

• code(required): string
  Minimum Length: 1

  Pattern: [^\u0000-\u0020]

  Nonblank code of the referenced MCP server or policy. The referenced resource must exist in the current project.
• version: string
  Referenced resource version. Omitted or blank values default to 01.00.0000; other nonblank versions are rejected.

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Nonblank code of the referenced MCP server or policy. The referenced resource must exist in the current project.",
            "minLength":1,
            "pattern":"[^\\u0000-\\u0020]"
        },
        "version":{
            "type":"string",
            "description":"Referenced resource version. Omitted or blank values default to 01.00.0000; other nonblank versions are rejected."
        }
    },
    "description":"Reference to an MCP server or policy used by a gateway.",
    "required":[
        "code"
    ]
}

Nested Schema : ExecutionPlanRs

Type: object

Ordered policy steps applied to gateway requests and responses.

Show Source

• request: array request
  Ordered policy execution steps for requests. If steps are supplied, their step numbers must start at 1 and be sequential. An omitted or empty list is allowed.
• response: array response
  Ordered policy execution steps for responses. If steps are supplied, their step numbers must start at 1 and be sequential. An omitted or empty list is allowed.

{
    "type":"object",
    "properties":{
        "request":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExecutionStepRs"
            },
            "description":"Ordered policy execution steps for requests. If steps are supplied, their step numbers must start at 1 and be sequential. An omitted or empty list is allowed."
        },
        "response":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExecutionStepRs"
            },
            "description":"Ordered policy execution steps for responses. If steps are supplied, their step numbers must start at 1 and be sequential. An omitted or empty list is allowed."
        }
    },
    "description":"Ordered policy steps applied to gateway requests and responses."
}

Nested Schema : request

Type: array

Ordered policy execution steps for requests. If steps are supplied, their step numbers must start at 1 and be sequential. An omitted or empty list is allowed.

Show Source

• Array of: object ExecutionStepRs
  One security or business policy step in the gateway execution plan.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ExecutionStepRs"
    },
    "description":"Ordered policy execution steps for requests. If steps are supplied, their step numbers must start at 1 and be sequential. An omitted or empty list is allowed."
}

Nested Schema : response

Type: array

Ordered policy execution steps for responses. If steps are supplied, their step numbers must start at 1 and be sequential. An omitted or empty list is allowed.

Show Source

• Array of: object ExecutionStepRs
  One security or business policy step in the gateway execution plan.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ExecutionStepRs"
    },
    "description":"Ordered policy execution steps for responses. If steps are supplied, their step numbers must start at 1 and be sequential. An omitted or empty list is allowed."
}

Nested Schema : ExecutionStepRs

Type: object

One security or business policy step in the gateway execution plan.

Show Source

• kind(required): string
  Pattern: ^[\u0000-\u0020]*([Ss][Ee][Cc][Uu][Rr][Ii][Tt][Yy]_[Pp][Oo][Ll][Ii][Cc][Yy]|[Bb][Uu][Ss][Ii][Nn][Ee][Ss][Ss]_[Pp][Oo][Ll][Ii][Cc][Yy])[\u0000-\u0020]*$

  Policy kind: SECURITY_POLICY or BUSINESS_POLICY. Requests are trimmed and normalized to uppercase by the service; conventional mixed-case forms are accepted.
• policyCode(required): string
  Minimum Length: 1

  Pattern: [^\u0000-\u0020]

  Nonblank code of the policy executed in this step. The code and normalized version must match a declared securityPolicies or businessPolicies reference, according to kind.
• policyVersion: string
  Version of the policy executed in this step. Omitted or blank values default to 01.00.0000; other nonblank versions are rejected.
• step(required): integer (int32)
  Minimum Value: 1

  Positive execution step number. Each request or response step list must be sequential, starting at 1; sequence order is validated by the service.

{
    "type":"object",
    "properties":{
        "step":{
            "type":"integer",
            "format":"int32",
            "description":"Positive execution step number. Each request or response step list must be sequential, starting at 1; sequence order is validated by the service.",
            "minimum":1
        },
        "kind":{
            "type":"string",
            "description":"Policy kind: SECURITY_POLICY or BUSINESS_POLICY. Requests are trimmed and normalized to uppercase by the service; conventional mixed-case forms are accepted.",
            "pattern":"^[\\u0000-\\u0020]*([Ss][Ee][Cc][Uu][Rr][Ii][Tt][Yy]_[Pp][Oo][Ll][Ii][Cc][Yy]|[Bb][Uu][Ss][Ii][Nn][Ee][Ss][Ss]_[Pp][Oo][Ll][Ii][Cc][Yy])[\\u0000-\\u0020]*$"
        },
        "policyCode":{
            "type":"string",
            "description":"Nonblank code of the policy executed in this step. The code and normalized version must match a declared securityPolicies or businessPolicies reference, according to kind.",
            "minLength":1,
            "pattern":"[^\\u0000-\\u0020]"
        },
        "policyVersion":{
            "type":"string",
            "description":"Version of the policy executed in this step. Omitted or blank values default to 01.00.0000; other nonblank versions are rejected."
        }
    },
    "description":"One security or business policy step in the gateway execution plan.",
    "required":[
        "step",
        "kind",
        "policyCode"
    ]
}

Nested Schema : MCP2610_Link

Type: object

A link to a related REST resource.

Show Source

• href: string
  URL of the linked resource.
• mediaType: string
  Media type of the linked resource.
• rel: string
  Relationship of the linked resource.

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Relationship of the linked resource."
        },
        "href":{
            "type":"string",
            "description":"URL of the linked resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type of the linked resource."
        }
    },
    "description":"A link to a related REST resource."
}

400 Response

Malformed parameters

401 Response

Unauthorized or insufficient design-time permissions

404 Response

Project or resource not found, or the MCP feature is not available

500 Response

Server error

Back to Top

Examples

The following example shows how to retrieve MCP gateways configured for a project 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 Gateways in a Project

curl --request GET --include \
  --url "${BASE_URL}/ic/api/integration/v1/projects/${PROJECT_ID}/mcp/gateways?integrationInstance=${INTEGRATION_INSTANCE}" \
  --header "Authorization: Bearer ${ACCESS_TOKEN}" \
  --header "Accept: application/json"

Back to Top