---
title: "API Key"
manual: "API_KEY"
version: "1.0"
permalink: "https://docs.typo3.org/permalink/maikschneider/api-key:start@1.0"
source: "Index.rst"
start: true
rendered: "2026-10-27T08:22:54+00:00"
---

# API Key {#start}

-   *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](https://www.opencontent.org/openpub/).

-   *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](https://docs.typo3.org/permalink/maikschneider/api-key:introduction@1.0)**

What API Key does and when to use it.

**[Installation](https://docs.typo3.org/permalink/maikschneider/api-key:installation@1.0)**

How to install the extension via Composer.

**[Usage](https://docs.typo3.org/permalink/maikschneider/api-key:usage@1.0)**

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

**[Configuration](https://docs.typo3.org/permalink/maikschneider/api-key:configuration@1.0)**

The frontend middleware and the extension configuration.

**[Developer guide](https://docs.typo3.org/permalink/maikschneider/api-key:developer@1.0)**

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

**[Security](https://docs.typo3.org/permalink/maikschneider/api-key:security@1.0)**

How keys are stored, sent, revoked and logged.

**[Known problems](https://docs.typo3.org/permalink/maikschneider/api-key:known-problems@1.0)**

Current limitations.