---
warning: DO NOT CHANGE THIS MANUALLY, THIS IS GENERATED BY https://github.com/duckdb/community-extensions repository, check README there
title: httpserver
excerpt: |
  DuckDB Community Extensions
  DuckDB HTTP API Server Extension

docs:
  extended_description: For more information regarding usage, see the [documentation](https://query.farm/products/extensions/httpserver/).
  hello_world: "-- Start a DuckDB HTTP API Server with parameters\nD SELECT httpserve_start('0.0.0.0',\
    \ 9999, 'user:pass');\n\u250C\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\
    \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\
    \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\
    \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\
    \n\u2502 httpserve_start('0.0.0.0', 9999, 'user:pass') \u2502\n\u2502        \
    \            varchar                    \u2502\n\u251C\u2500\u2500\u2500\u2500\
    \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\
    \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\
    \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\
    \u2500\u2500\u2500\u2500\u2524\n\u2502 HTTP server started on 0.0.0.0:9999   \
    \        \u2502\n\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\
    \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\
    \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\
    \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\n\n--\
    \ Browse to your DuckDB HTTP API endpoint to Query using the embedded interface\n\
    \n-- Query your DuckDB HTTP API Server using curl or any other client w/ HTTP\
    \ Basic Auth\ncurl -X POST -d \"LOAD chsql; SELECT *, uuid() FROM numbers(10)\"\
    \ \"http://user:pass@localhost:9999/\"\n\n-- Query your DuckDB HTTP API Server\
    \ using curl or any other client w/ X-API-Key header\ncurl -X POST --header \"\
    X-API-Key: secretkey\" -d \"LOAD chsql; SELECT *, uuid() FROM numbers(10)\" \"\
    http://localhost:9999/\"\n\n-- Query your DuckDB HTTP API Server using DuckDB\
    \ HTTPFS extension w/ Header Authentication\nD CREATE SECRET extra_http_headers\
    \ (\n  TYPE HTTP,\n  EXTRA_HTTP_HEADERS MAP{\n      'X-API-Key': 'secretkey'\n\
    \  }\n);\n\n-- DuckDB API Server settings\n* If you want no authentication, just\
    \ pass an empty string as parameter.\n* If you want the API run in foreground\
    \ set `DUCKDB_HTTPSERVER_FOREGROUND=1`\n* If you want logs set `DUCKDB_HTTPSERVER_DEBUG=1`\
    \ or `DUCKDB_HTTPSERVER_SYSLOG=1`\n\n![image info](https://private-user-images.githubusercontent.com/1423657/376339324-e930a8d2-b3e4-454e-ba12-e5e91b30bfbe.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MzMzNDI2MTksIm5iZiI6MTczMzM0MjMxOSwicGF0aCI6Ii8xNDIzNjU3LzM3NjMzOTMyNC1lOTMwYThkMi1iM2U0LTQ1NGUtYmExMi1lNWU5MWIzMGJmYmUucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI0MTIwNCUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNDEyMDRUMTk1ODM5WiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9ZjI5OTEwZGNhM2NhZGI4NDJiYTE5ZmM1ZWIzZDE4OTBkZDY3ODBkMTkxM2E1ZWNiMjRmZDAzNzlkOWEyMjVmMiZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QifQ.iCK1p26RFbEjMWPyG5i8XmhPyzUn8J9cCsm1N1T8y5E)\n"
extension:
  build: cmake
  description: DuckDB HTTP API Server Extension
  excluded_platforms: wasm_mvp;wasm_eh;wasm_threads
  language: SQL & C++
  license: MIT
  maintainers:
  - lmangani
  - akvlad
  - niclashaderer
  - gropaul
  - rustyconover
  name: httpserver
  version: '20260707'
repo:
  github: Query-farm/httpserver
  ref: 647d099778dac1fced7d442b7f46c75413c7d8a3
  variegata: bb04a75a66c80b29c7ef8fccaff9dbb40b7b9f86

extension_star_count: 284
extension_star_count_pretty: 284
extension_download_count: 41476
extension_download_count_pretty: 41.5k
image: '/images/community_extensions/social_preview/preview_community_extension_httpserver.png'
layout: community_extension_doc
---
### Compatibility Matrix

This table covers all DuckDB releases that have not reached [end-of-life](https://duckdb.org/release_calendar), including LTS releases, and shows the 2 most recent patch releases of each. Older patch releases are not listed, but the extension may be available for them as well.

<div class="extension_compatibility_table"></div>

| Platform | 1.4.4 | 1.4.5 | 1.5.5 | 1.5.6 | 2.0.0 |
| :--- | :---: | :---: | :---: | :---: | :---: |
| Linux AMD64 | ✅ | ❌ | ✅ | ✅ | ✅ |
| Linux ARM64 | ✅ | ❌ | ✅ | ✅ | ✅ |
| macOS AMD64 | ✅ | ❌ | ✅ | ✅ | ✅ |
| macOS ARM64 | ✅ | ❌ | ✅ | ✅ | ✅ |
| Windows AMD64 | ✅ | ❌ | ✅ | ✅ | ✅ |
| Windows ARM64 | ❌ | ❌ | ❌ | ❌ | ❌ |
| WebAssembly | ❌ | ❌ | ❌ | ❌ | ❌ |

### Installing and Loading
```sql
INSTALL {{ page.extension.name }} FROM community;
LOAD {{ page.extension.name }};
```

{% if page.docs.hello_world %}
### Example
```sql
{{ page.docs.hello_world }}```
{% endif %}

{% if page.docs.extended_description %}
### About {{ page.extension.name }}
{{ page.docs.extended_description }}
{% endif %}
### Added Functions

<div class="extension_functions_table"></div>

This extension does not add any functions.

### Overloaded Functions

<div class="extension_functions_table"></div>

This extension does not add any function overloads.

### Added Types

<div class="extension_types_table"></div>

This extension does not add any types.

### Added Settings

<div class="extension_settings_table"></div>

This extension does not add any settings.