API Key

Extension key: api_key
Package name: maikschneider/api-key
Version: 1.0
Language: en
Author: Maik Schneider & Contributors
License: This document is published under the Open Publication License.
Rendered: Tue, 27 Oct 2026 08:22:54 +0000

API Key adds stateless API key authentication to TYPO3. Scripts, cron jobs, CI pipelines and server-to-server integrations send a key, and any API, PSR-15 middleware or auth service can verify it without creating sessions or cookies.

Introduction

What API Key does and when to use it.

Installation

How to install the extension via Composer.

Usage

Key format, managing keys on the command line and secret scanning.

Configuration

The frontend middleware and the extension configuration.

Developer guide

Verifying keys in your own API, middleware or authentication service.

Security

How keys are stored, sent, revoked and logged.

Known problems

Current limitations.