ORorq-ai
MCP Gateway

Update an MCP gateway

Changed on

Updates mutable fields of an existing MCP gateway. Omitted optional fields keep their current values.

patch/v2/mcp-gateways/{id}

Request

  • Base URL
    https://my.orq.ai
  • URL
    https://my.orq.ai/v2/mcp-gateways/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

Unique identifier of the MCP gateway.

Request body

keystring

Rejected with INVALID_ARGUMENT: the key backs the gateway's public MCP URL and is immutable after creation. Retained so callers get an error rather than a silently ignored field.

display_namestring

Human readable name shown in the workspace.

descriptionstring

Free-form note about what this gateway is for.

tool_naming'MCP_TOOL_NAMING_PREFIX_WITH_SERVER_KEY' | 'MCP_TOOL_NAMING_PREFIX_ON_COLLISION'
mode'MCP_GATEWAY_MODE_CODE' | 'MCP_GATEWAY_MODE_DIRECT'
clear_server_linksboolean

Set true to remove every link; cannot be combined with server_links.

skill_idsstring[]

Replaces the served workspace skills. An empty array is treated as no change; use clear_skill_ids to remove them all.

clear_skill_idsboolean

Set true to stop serving every workspace skill; cannot be combined with skill_ids.

replace_iconsboolean

Set true with an empty icons list to restore default ORQ branding.

website_urlstring

Empty restores the default ORQ documentation website.

Example request

{
  "server_links": [
    {
      "tool_exposure": {
        "mode": "MCP_TOOL_EXPOSURE_MODE_ALL"
      },
      "skill_exposure": {
        "mode": "MCP_TOOL_EXPOSURE_MODE_ALL"
      }
    }
  ]
}

Response

OK

Example response

{
  "mcp_gateway": {
    "display_name": "Production Gateway",
    "server_links": [
      {
        "tool_exposure": {
          "mode": "MCP_TOOL_EXPOSURE_MODE_ALL"
        },
        "skill_exposure": {
          "mode": "MCP_TOOL_EXPOSURE_MODE_ALL"
        }
      }
    ]
  }
}

Changes

  • 928a71e92252Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 33d63277cd4eRevision changes
    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status