Secrets

Secrets API

Beheer projectsecrets — API-sleutels, tokens en andere credentials die je gedeployde project leest vanuit process.env tijdens de uitvoering. Waarden zijn write-only: ze komen binnen via deze endpoints en komen naar buiten via de runtime van het gedeployde project, en worden nooit teruggegeven in een API-response.

Zie de Secrets & Environment Variables-gids voor achtergrondinformatie over hoe secrets werken en worden opgeslagen.

Secrets opvragen

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

Geeft de set secrets terug die op een project zijn gedefinieerd. Alleen de sleutelnaam, de laatste vier tekens van de waarde en tijdstempels worden teruggegeven.

Response:

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

Secret aanmaken of bijwerken

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

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

Idempotent op basis van (projectId, key)— een bestaande sleutel opnieuw posten overschrijft de opgeslagen waarde. Updates tellen niet mee voor de per-project-limiet; alleen het toevoegen van een nieuwe sleutel doet dat.

Sleutelformaat: UPPER_SNAKE_CASE, 1–64 tekens, moet beginnen met een letter. Waardelengte: 1–4096 tekens.

Response:

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

Secret verwijderen

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

Verwijdert een secret. Idempotent — het verwijderen van een sleutel die niet bestaat geeft toch success: true terug, waarbij existedaangeeft of er daadwerkelijk een rij is verwijderd.

Response:

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

Fouten

• 400 VALIDATION_ERROR— De body heeft een onjuiste vorm, de sleutel voldoet niet aan het formaatcontrole, of de waarde is leeg of langer dan 4096 tekens.
• 404 NOT_FOUND — Het project bestaat niet of de API-sleutel van de aanroeper heeft geen toegang tot het project. Voor schrijf-/verwijderbewerkingen moet de aanroeper ook de rol admin hebben in het eigendomsteam.
• 409 SECRET_LIMIT_EXCEEDED— Het project heeft al 25 secrets. Verwijder er een of werk een bestaande sleutel bij in plaats van een nieuwe toe te voegen.
• 429 RATE_LIMITED — API-rate limit overschreden. Zie Foutafhandeling voor details.