API Referansı

Sırlar

API üzerinden proje sırlarını listeleyin, oluşturun, güncelleyin ve silin. Değerler yalnızca yazılabilir — düz metin olarak asla döndürülmez.

Son güncelleme:

Gizli Bilgiler API

Dağıtılmış projenizin çalışma zamanında process.envüzerinden okuduğu proje gizli bilgilerini — API anahtarları, token'lar ve diğer kimlik bilgilerini — yönetin. Değerler yalnızca yazılabilir: bu uç noktalar aracılığıyla girilir ve dağıtılmış projenin çalışma zamanı üzerinden çıkar; hiçbir API yanıtında döndürülmez.

Gizli bilgilerin nasıl çalıştığı ve nasıl saklandığı hakkında arka plan bilgisi için Gizli Bilgiler & Ortam Değişkenleri kılavuzuna bakın.

Gizli Bilgileri Listele

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

Bir projede tanımlı gizli bilgiler kümesini döndürür. Yalnızca anahtar adı, değerin son dört karakteri ve zaman damgaları döndürülür.

Yanıt:

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

Gizli Bilgi Oluştur veya Güncelle

POST /api/v1/projects/{projectId}/secrets
{ "key": "STRIPE_SECRET_KEY", "value": "sk_live_..." }

(projectId, key)ile idempotent — aynı anahtarı yeniden göndermek saklanan değerin üzerine yazar. Güncellemeler proje başına sınıra sayılmaz; yalnızca yeni bir anahtar eklemek sayılır.

Anahtar formatı: UPPER_SNAKE_CASE, 1–64 karakter, bir harfle başlamalıdır. Değer uzunluğu: 1–4096 karakter.

Yanıt:

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

Gizli Bilgiyi Sil

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

Bir gizli bilgiyi kaldırır. İdempotent — mevcut olmayan bir anahtarı silmek yine de success: true döndürür; existedalanı bir satırın gerçekten kaldırılıp kaldırılmadığını gösterir.

Yanıt:

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

Hatalar

  • 400 VALIDATION_ERROR — Gövde şekli yanlış, anahtar format kontrolünden geçemiyor veya değer boş ya da 4096 karakterden uzun.
  • 404 NOT_FOUND — Proje mevcut değil veya çağıranın API anahtarı buna erişim yetkisine sahip değil. Yazma/silme işlemleri için çağıranın aynı zamanda sahip olan ekipte adminrolüne sahip olması gerekir.
  • 409 SECRET_LIMIT_EXCEEDED — Projede zaten 25 gizli bilgi var. Yeni bir tane eklemek yerine birini silin veya mevcut bir anahtarı güncelleyin.
  • 429 RATE_LIMITED — API hız sınırı aşıldı. Ayrıntılar için Hata Yönetimi bölümüne bakın.