Share feedback
Answers are generated based on the documentation.

Experimental

Product manualDownload OpenAPI specificationMarkdown

AddMcpGatewayServer adds one server to an existing ready gateway.

POST/v1/sandboxes/{sandbox}/mcp-gateway/servers
AddMcpGatewayServer adds one server to an existing ready gateway.

Connection and access

API connection and authentication guidance

https://connect.docker.com/sandboxes — The API base URL. Append the /v1 paths while preserving this URL's path prefix.

Use one of these alternatives. Requirements within an alternative apply together.

  • bearer

Parameters

sandbox path Required

The sandbox id.

Type: string

All schema constraints and annotations
{
  "type": "string"
}

Request and responses

Request

application/json

Type: object

AddMcpGatewayServerRequest adds one server to an existing ready gateway.
server · required

Type: string

server is the external configured key; a supplied registration must define this same key. A mismatch refuses FAILED_PRECONDITION before changing the gateway.
All schema constraints and annotations
{
  "description": "server is the external configured key; a supplied registration must define this same key.\nA mismatch refuses FAILED_PRECONDITION before changing the gateway.",
  "minLength": 1,
  "type": "string"
}
All schema constraints and annotations
{
  "additionalProperties": false,
  "description": "AddMcpGatewayServerRequest adds one server to an existing ready gateway.",
  "properties": {
    "server": {
      "description": "server is the external configured key; a supplied registration must define this same key.\nA mismatch refuses FAILED_PRECONDITION before changing the gateway.",
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "server"
  ],
  "title": "AddMcpGatewayServerRequest",
  "type": "object"
}

Response 200

Success

application/json

Schema: AddMcpGatewayServerResponse

Response default

The structured Error body identifies the failure with a stable code and optional typed details.

application/json

Schema: Error

Schema example

{
  "code": "notFound",
  "details": [],
  "message": "sandbox not found"
}

Referenced schemas

#/components/schemas/AddMcpGatewayServerResponse

#/components/schemas/Error

Complete operation contract
{
  "description": "AddMcpGatewayServer adds one server to an existing ready gateway.",
  "operationId": "addMcpGatewayServer",
  "parameters": [
    {
      "description": "The sandbox id.",
      "in": "path",
      "name": "sandbox",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "additionalProperties": false,
          "description": "AddMcpGatewayServerRequest adds one server to an existing ready gateway.",
          "properties": {
            "server": {
              "description": "server is the external configured key; a supplied registration must define this same key.\nA mismatch refuses FAILED_PRECONDITION before changing the gateway.",
              "minLength": 1,
              "type": "string"
            }
          },
          "required": [
            "server"
          ],
          "title": "AddMcpGatewayServerRequest",
          "type": "object"
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/AddMcpGatewayServerResponse"
          }
        }
      },
      "description": "Success"
    },
    "default": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "The structured Error body identifies the failure with a stable code and optional typed details."
    }
  },
  "security": [
    {
      "bearer": []
    }
  ],
  "summary": "AddMcpGatewayServer adds one server to an existing ready gateway.",
  "tags": [
    "MCP gateways"
  ],
  "x-sbx-authenticated-only": false,
  "x-sbx-conditional-permissions": [],
  "x-sbx-plane": "control",
  "x-sbx-required-permissions": [
    "mcpWrite"
  ],
  "x-sbx-serving-surface": "management"
}