Guide

SQL Server Endpoint

Source

SQL Server endpoints connect Gateway to Microsoft SQL Server and SQL Server-compatible services for governed T-SQL access and operational planning.

Endpoint Kind

Use mssql as the endpoint kind when creating this endpoint through the API or dashboard.

What Gateway Uses This Endpoint For

  • Run governed T-SQL queries through Gateway.
  • Expose SQL Server data to AI Orchestration and approved tools through RBAC.
  • Inventory databases, schemas, tables, views, indexes, and stored procedures.
  • Plan modernization from SQL Server to another relational target.

Basic Endpoint Shape

json
{
  "endpoint": "sqlserver-prod",
  "kind": "mssql",
  "config": {
    "read_conn": {
      "host": "sqlserver.internal",
      "port": 1433,
      "database": "appdb",
      "auth": {
        "username": "app_user",
        "password": "secret"
      }
    }
  }
}

Create it with the endpoint API:

bash
curl -sS -X POST "$EDEN/endpoints" \
  -H "$AUTH_HEADER" \
  -H "Content-Type: application/json" \
  -d '{
  "endpoint": "sqlserver-prod",
  "kind": "mssql",
  "config": {
    "read_conn": {
      "host": "sqlserver.internal",
      "port": 1433,
      "database": "appdb",
      "auth": {
        "username": "app_user",
        "password": "secret"
      }
    }
  }
}'

Configuration Fields

FieldPurpose
hostSQL Server host
portSQL Server port, usually 1433
databaseDatabase name
usernameLogin name
passwordLogin password

Operating Notes

  • Validate encryption and certificate requirements for production SQL Server deployments.
  • Use least-privilege logins scoped to the required database.
  • Document collation, compatibility level, and stored procedure dependencies before migration planning.
Help improve Eden Docs

Find something unclear or incomplete? Review the source and propose an update.

View on GitLab Updated August 2, 2026