Secrets

Secrets API

Verwalten Sie Projekt-Secrets — API-Schlüssel, Tokens und andere Zugangsdaten, die Ihr bereitgestelltes Projekt zur Laufzeit aus process.env liest. Werte sind schreibgeschützt: Sie gelangen über diese Endpunkte hinein und über die Laufzeit des bereitgestellten Projekts heraus — sie werden in keiner API-Antwort zurückgegeben.

Hintergrundinformationen dazu, wie Secrets funktionieren und wie sie gespeichert werden, finden Sie im Secrets & Environment Variables-Leitfaden.

Secrets auflisten

GET /api/v1/projects/{projectId}/secrets

Gibt die Menge der für ein Projekt definierten Secrets zurück. Nur der Schlüsselname, die letzten vier Zeichen des Werts und Zeitstempel werden zurückgegeben.

Response:

{
  "data": {
    "secrets": [
      {
        "key": "STRIPE_SECRET_KEY",
        "lastFour": "aB3x",
        "createdAt": "2026-04-18T09:12:44.000Z",
        "updatedAt": "2026-04-21T15:03:10.000Z"
      }
    ]
  }
}

Secret erstellen oder aktualisieren

POST /api/v1/projects/{projectId}/secrets

{ "key": "STRIPE_SECRET_KEY", "value": "sk_live_..." }

Idempotent nach (projectId, key)— durch erneutes Posten desselben Schlüssels wird der gespeicherte Wert überschrieben. Aktualisierungen zählen nicht gegen das Pro-Projekt-Limit; nur das Hinzufügen eines neuen Schlüssels zählt.

Schlüsselformat: UPPER_SNAKE_CASE, 1–64 Zeichen, muss mit einem Buchstaben beginnen. Wertlänge: 1–4096 Zeichen.

Response:

{
  "data": {
    "secret": {
      "key": "STRIPE_SECRET_KEY",
      "lastFour": "aB3x",
      "createdAt": "2026-04-18T09:12:44.000Z",
      "updatedAt": "2026-04-21T15:03:10.000Z"
    }
  }
}

Secret löschen

DELETE /api/v1/projects/{projectId}/secrets/{key}

Entfernt ein Secret. Idempotent — das Löschen eines nicht vorhandenen Schlüssels gibt dennoch success: true zurück, wobei existedangibt, ob tatsächlich eine Zeile entfernt wurde.

Response:

{ "data": { "success": true, "existed": true } }

Fehler

• 400 VALIDATION_ERROR— Die Body-Struktur ist falsch, der Schlüssel besteht die Formatprüfung nicht, oder der Wert ist leer oder länger als 4096 Zeichen.
• 404 NOT_FOUND— Das Projekt existiert nicht oder der API-Schlüssel des Aufrufers ist nicht darauf beschränkt. Für Schreib-/Löschvorgänge muss der Aufrufer außerdem die admin-Rolle für das besitzende Team haben.
• 409 SECRET_LIMIT_EXCEEDED— Das Projekt hat bereits 25 Secrets. Löschen Sie eines oder aktualisieren Sie einen vorhandenen Schlüssel, anstatt einen neuen hinzuzufügen.
• 429 RATE_LIMITED— API-Rate-Limit überschritten. Weitere Informationen finden Sie unter Error Handling.