init command

Initialize a new Data API builder configuration file. The resulting JSON captures data source details, enabled endpoints (REST, GraphQL, MCP), authentication, and runtime behaviors.

Syntax

dab init [options]

If the target config file already exists, the command overwrites it. There is no merge. Use version control or backups if you need to preserve the previous file.

Quick glance

Authentication

Data Source

GraphQL

Host and authentication

MCP

REST

-c, --config

Output configuration file name. Default is dab-config.json.

Example

dab init --database-type mssql --config dab-config.local.json

Resulting config

{
  "data-source": {
    "database-type": "mssql",
    "connection-string": "@env('MSSQL_CONNECTION_STRING')"
  }
}

--auth.audience

JWT audience claim.

Example

dab init --database-type mssql --auth.audience "https://example.com/api"

Resulting config

{
  "runtime": {
    "authentication": {
      "audience": "https://example.com/api"
    }
  }
}

--auth.issuer

JWT issuer claim.

Example

dab init --database-type mssql --auth.issuer "https://login.microsoftonline.com/{tenant-id}/v2.0"

Resulting config

{
  "runtime": {
    "authentication": {
      "issuer": "https://login.microsoftonline.com/{tenant-id}/v2.0"
    }
  }
}

--auth.provider

Identity provider. Default is StaticWebApps.

Example

dab init --database-type mssql --auth.provider AzureAD

Resulting config

{
  "runtime": {
    "authentication": {
      "provider": "AzureAD"
    }
  }
}

--connection-string

Database connection string. Supports @env().

Example

dab init --database-type mssql --connection-string "@env('MSSQL_CONNECTION_STRING')"

Resulting config

{
  "data-source": {
    "connection-string": "@env('MSSQL_CONNECTION_STRING')"
  }
}

--cors-origin

Comma-separated list of allowed origins.

Example

dab init --database-type mssql --cors-origin "https://app.example.com,https://admin.example.com"

Resulting config

{
  "runtime": {
    "cors": {
      "origins": [ "https://app.example.com", "https://admin.example.com" ]
    }
  }
}

--cosmosdb_nosql-container

Cosmos DB NoSQL container name.

Example

dab init --database-type cosmosdb_nosql --cosmosdb_nosql-container MyContainer

Resulting config

{
  "data-source": {
    "database-type": "cosmosdb_nosql",
    "options": {
      "container": "MyContainer"
    }
  }
}

--cosmosdb_nosql-database

Cosmos DB NoSQL database name. Required for cosmosdb_nosql.

Example

dab init --database-type cosmosdb_nosql --cosmosdb_nosql-database MyDb

Resulting config

{
  "data-source": {
    "database-type": "cosmosdb_nosql",
    "options": {
      "database": "MyDb"
    }
  }
}

--database-type

Specifies the target database engine. Supported values: mssql, mysql, postgresql, cosmosdb_postgresql, cosmosdb_nosql.

Example

dab init --database-type mssql

Resulting config

{
  "data-source": {
    "database-type": "mssql"
  }
}

--graphql.disabled

Deprecated. Disables GraphQL. Prefer --graphql.enabled false.

--graphql.enabled

Enable GraphQL endpoint. Default is true.

Example

dab init --database-type mssql --graphql.enabled false

Resulting config

{
  "runtime": {
    "graphql": {
      "enabled": false
    }
  }
}

--graphql.multiple-create.enabled

Allows multiple row creation in a single mutation. Default is false.

Example

dab init --database-type mssql --graphql.multiple-create.enabled true

Resulting config

{
  "runtime": {
    "graphql": {
      "multiple-create": { "enabled": true }
    }
  }
}

--graphql.path

GraphQL endpoint prefix. Default is /graphql.

Example

dab init --database-type mssql --graphql.path /gql

Resulting config

{
  "runtime": {
    "graphql": {
      "path": "/gql"
    }
  }
}

--graphql-schema

Path to a GraphQL schema file. Required for cosmosdb_nosql.

Example

dab init --database-type cosmosdb_nosql --graphql-schema ./schema.gql

Resulting config

{
  "runtime": {
    "graphql": {
      "schema": "./schema.gql"
    }
  }
}

--host-mode

Host mode. Default is Production.

Valid values: Development, Production.

Example

dab init --database-type mssql --host-mode development

Resulting config

{
  "runtime": {
    "host": {
      "mode": "development"
    }
  }
}

--mcp.disabled

Deprecated. Disables MCP. Prefer --mcp.enabled false.

--mcp.enabled

Enable MCP endpoint. Default is true.

Example

dab init --database-type mssql --mcp.enabled false

Resulting config

{
  "runtime": {
    "mcp": {
      "enabled": false
    }
  }
}

--mcp.path

MCP endpoint prefix. Default is /mcp.

Example

dab init --database-type mssql --mcp.path /model

Resulting config

{
  "runtime": {
    "mcp": {
      "path": "/model"
    }
  }
}

--rest.disabled

Deprecated. Disables REST. Prefer --rest.enabled false.

--rest.enabled

Enable REST endpoint. Default is true.

Example

dab init --database-type mssql --rest.enabled false

Resulting config

{
  "runtime": {
    "rest": {
      "enabled": false
    }
  }
}

--rest.path

REST endpoint prefix. Default is /api.

Example

dab init --database-type mssql --rest.path /rest

Resulting config

{
  "runtime": {
    "rest": {
      "path": "/rest"
    }
  }
}

--rest.request-body-strict

Controls handling of extra fields in request bodies. Default is true.

• true: Rejects extraneous fields (HTTP 400).
• false: Ignores extra fields.

Example

dab init --database-type mssql --rest.request-body-strict false

Resulting config

{
  "runtime": {
    "rest": {
      "request-body-strict": false
    }
  }
}

--runtime.base-route

Global prefix prepended to all endpoints. Must begin with /.

Example

dab init --database-type mssql --runtime.base-route /v1

Resulting config

{
  "runtime": {
    "base-route": "/v1"
  }
}

--set-session-context

Enable sending data to SQL Server using session context. Only valid for mssql. Default is false.

Example

dab init --database-type mssql --set-session-context true

Resulting config

{
  "runtime": {
    "mssql": {
      "set-session-context": true
    }
  }
}