Instaclustr Logo
Powered by Redocly

MCP Gateway Virtual Server V1

Operations related to MCP Gateway virtual servers.

List all virtual servers in an MCP Gateway cluster.

SecurityBasic Authentication
Request
path Parameters
clusterId
required
string <uuid>

ID of the MCP Gateway cluster.

Responses
200

Successfully retrieved virtual servers for the MCP Gateway cluster.

get/cluster-management/v2/data-sources/mcp_gateway_cluster/{clusterId}/virtual-servers/v1
Request samples 
Response samples 
application/json
[
  • {
    }
]
Create an MCP Gateway virtual server.
SecurityBasic Authentication 
Request 
Request Body schema: application/json
required
name
required
string^[a-zA-Z0-9_-]+$
Name of the virtual server.


 
clusterId
required
string <uuid> 
ID of the MCP Gateway cluster.


 
endpointUrl
required
string
URL path pattern for the virtual server endpoint.


 
Array of objects (McpGatewayMcpVirtualServerAuthenticationV1)   <= 1 items 
Authentication configuration for the virtual server.


 
Responses 
202
MCP Gateway virtual server creation requested.


post/cluster-management/v2/resources/applications/mcp-gateway/virtual-servers/v1
Request samples 
application/json
{
  • "clusterId": "4650aa98-e894-4675-9614-558915d5837a",
  • "endpointUrl": "/my-mcp-server",
  • "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  • "name": "my-virtual-server"
}
Response samples 
application/json
{
  • "clusterId": "4650aa98-e894-4675-9614-558915d5837a",
  • "endpointUrl": "/my-mcp-server",
  • "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  • "name": "my-virtual-server"
}
Get MCP Gateway virtual server details.
SecurityBasic Authentication 
Request 
path Parameters
virtualServerId
required
string <uuid> 
ID of the MCP Gateway virtual server.


 
Responses 
200
MCP Gateway virtual server details retrieved.


get/cluster-management/v2/resources/applications/mcp-gateway/virtual-servers/v1/{virtualServerId}
Request samples 
Response samples 
application/json
{
  • "clusterId": "4650aa98-e894-4675-9614-558915d5837a",
  • "endpointUrl": "/my-mcp-server",
  • "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  • "name": "my-virtual-server"
}
Update an MCP Gateway virtual server.
SecurityBasic Authentication 
Request 
path Parameters
virtualServerId
required
string <uuid> 
ID of the MCP Gateway virtual server.


 
Request Body schema: application/json
required
endpointUrl
required
string
URL path pattern for the virtual server endpoint.


 
name
required
string^[a-zA-Z0-9_-]+$
Name of the virtual server.


 
Array of objects (McpGatewayMcpVirtualServerAuthenticationV1)   <= 1 items 
Authentication configuration for the virtual server.


 
Responses 
202
MCP Gateway virtual server update requested.


404
MCP Gateway virtual server not found.


put/cluster-management/v2/resources/applications/mcp-gateway/virtual-servers/v1/{virtualServerId}
Request samples 
application/json
{}
Response samples 
application/json
{
  • "clusterId": "4650aa98-e894-4675-9614-558915d5837a",
  • "endpointUrl": "/my-mcp-server",
  • "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  • "name": "my-virtual-server"
}
Delete an MCP Gateway virtual server.
SecurityBasic Authentication 
Request 
path Parameters
virtualServerId
required
string <uuid> 
ID of the MCP Gateway virtual server.


 
Responses 
204
MCP Gateway virtual server delete requested.


404
MCP Gateway virtual server not found.


delete/cluster-management/v2/resources/applications/mcp-gateway/virtual-servers/v1/{virtualServerId}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
➔ Next to Management Units Usage