Home Docs Schema Formats Errors
Conduit

Core

Philosophy Getting Started Roadmap

Formats

Formats ▶
Overview JSON XML YAML TOML NDJSON CSV CBOR

Configuration

Configuration ▶
Overview Server Settings Database Settings Policy Settings Authorization Overview Environment Auth Database Auth No-Op Auth

API Reference

API Reference ▶
Schema API CRUD API Validation Pagination

Architecture

Architecture ▶
Overview High-Level Flow Multi-Format Engine Database Drivers Error System

Errors

Errors ▶
Error Index 400 Bad Request 401 Unauthorized 403 Forbidden 404 Not Found 405 Method Not Allowed 409 Conflict 415 Unsupported Media Type 422 Unprocessable Entity 429 Too Many Requests 500 Internal Server Error 501 Not Implemented 503 Service Unavailable

Policy Settings

Policy Configuration

The policy section controls whether unauthenticated clients may read data, write data, or perform schema‑level mutations. These settings apply globally across all tables.

Policy Settings

policy:
  publicReads: true
  publicWrites: false
  publicMutation: false

Each flag enables or disables a category of operations for clients who do not present authentication credentials:

  • publicReads — allows unauthenticated GET requests.
  • publicWrites — allows unauthenticated POST, PUT, and PATCH requests.
  • publicMutation — allows unauthenticated schema‑level operations such as table creation or deletion.

When these values are set to false, Conduit requires authentication for the corresponding operations.

Example

policy:
  publicReads: true
  publicWrites: true
  publicMutation: false

In this configuration, anyone can read and write data, but only authenticated users may perform schema mutations.