API 레퍼런스

시크릿

API를 통해 프로젝트 시크릿을 나열, 생성, 업데이트 및 삭제합니다. 값은 쓰기 전용 — 평문으로 반환되지 않습니다.

마지막 업데이트:

시크릿 API

프로젝트 시크릿을 관리합니다 — 배포된 프로젝트가 런타임 시process.env에서 읽는 API 키, 토큰 및 기타 자격 증명입니다. 값은 쓰기 전용입니다: 이 엔드포인트를 통해 입력되고 배포된 프로젝트의 런타임을 통해 출력되며, API 응답에서는 절대 반환되지 않습니다.

시크릿의 작동 방식과 저장 방법에 대한 배경 정보는 시크릿 & 환경 변수 가이드를 참조하십시오.

시크릿 목록 조회

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

프로젝트에 정의된 시크릿 세트를 반환합니다. 키 이름, 값의 마지막 네 자리, 그리고 타임스탬프만 반환됩니다.

응답:

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

시크릿 생성 또는 업데이트

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

(projectId, key)에 대해 멱등성을 보장합니다 — 동일한 키를 재전송하면 저장된 값이 덮어쓰입니다. 업데이트는 프로젝트 한도에 포함되지 않으며; 새 키를 추가할 때만 포함됩니다.

키 형식: UPPER_SNAKE_CASE, 1–64자, 문자로 시작해야 합니다. 값 길이: 1–4096자.

응답:

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

시크릿 삭제

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

시크릿을 제거합니다. 멱등성을 보장합니다 — 존재하지 않는 키를 삭제해도success: true를 반환하며, existed 필드가 행이 실제로 제거되었는지 여부를 나타냅니다.

응답:

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

오류

  • 400 VALIDATION_ERROR — 본문 형식이 잘못되었거나, 키가 형식 검사에 실패하거나, 값이 비어 있거나 4096자를 초과합니다.
  • 404 NOT_FOUND — 프로젝트가 존재하지 않거나 호출자의 API 키가 해당 프로젝트에 범위가 지정되지 않았습니다. 쓰기/삭제의 경우 호출자는 소유 팀에서 admin 역할도 가져야 합니다.
  • 409 SECRET_LIMIT_EXCEEDED — 프로젝트에 이미 25개의 시크릿이 있습니다. 새 키를 추가하는 대신 기존 키를 삭제하거나 업데이트하십시오.
  • 429 RATE_LIMITED — API 속도 제한을 초과했습니다. 자세한 내용은 오류 처리를 참조하십시오.