Referensi API

Secret

Daftar, buat, perbarui, dan hapus secret proyek melalui API. Nilai bersifat write-only — tidak pernah dikembalikan dalam plaintext.

Terakhir diperbarui:

API Secrets

Kelola secrets proyek — API key, token, dan kredensial lainnya yang dibaca oleh proyek yang di-deploy dari process.env saat runtime. Nilai bersifat write-only: masuk melalui endpoint ini dan keluar melalui runtime proyek yang di-deploy, dan tidak pernah dikembalikan dalam respons API apa pun.

Untuk latar belakang tentang cara kerja secrets dan cara penyimpanannya, lihat panduan Secrets & Environment Variables.

Daftar Secrets

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

Mengembalikan kumpulan secrets yang didefinisikan pada proyek. Hanya nama key, empat karakter terakhir dari nilai, dan timestamp yang dikembalikan.

Respons:

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

Buat atau Perbarui Secret

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

Idempoten berdasarkan (projectId, key)— mengirim ulang key yang sama akan menimpa nilai yang tersimpan. Pembaruan tidak dihitung terhadap batas per-proyek; hanya penambahan key baru yang dihitung.

Format key: UPPER_SNAKE_CASE, 1–64 karakter, harus diawali dengan huruf. Panjang nilai: 1–4096 karakter.

Respons:

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

Hapus Secret

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

Menghapus secret. Idempoten — menghapus key yang tidak ada tetap mengembalikan success: true, dengan existedmenunjukkan apakah baris benar-benar dihapus.

Respons:

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

Error

  • 400 VALIDATION_ERROR— Bentuk body salah, key gagal pemeriksaan format, atau nilai kosong atau lebih dari 4096 karakter.
  • 404 NOT_FOUND— Proyek tidak ada atau API key pemanggil tidak terbatas padanya. Untuk write/delete, pemanggil juga harus memiliki peran admin pada tim pemilik.
  • 409 SECRET_LIMIT_EXCEEDED— Proyek sudah memiliki 25 secrets. Hapus satu atau perbarui key yang ada alih-alih menambahkan yang baru.
  • 429 RATE_LIMITED— Batas laju API terlampaui. Lihat Penanganan Error untuk detail.
SebelumnyaDomain KustomBerikutnyaPenasihat AI (streaming)