메인 콘텐츠로 건너뛰기
Guard API는 요청 헤더로 전송되는 API 키로 인증합니다.

​
헤더

X-Starfort-Guard-Api-Key: sf_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
  • 키는 콘솔에서 Guardian별로 생성되며 sf_로 시작합니다.
  • 키는 생성 시 한 번만 표시됩니다 — 안전하게 보관하세요.
  • 키의 이름은 모든 트레이스에 태그로 기록되므로, 호출자/환경 기준으로 키 이름을 지정하세요.
인증용 쿼리 파라미터는 없습니다 — 인증은 헤더로만 이루어집니다.

​
잘못되었거나 누락된 키

키가 누락되었거나, 찾을 수 없거나/형식이 잘못되었거나, 폐기됨(revoked) 상태일 때 HTTP 401로 거부됩니다. 폐기는 영구적이며 되돌릴 수 없습니다 — 폐기된 키는 다시는 인증되지 않습니다. 
{
  "ok": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid credentials (getApiGuardGate)",
    "details": "API_KEY_INVALID"
  }
}

​
인증 vs. 활성 상태

인증(위의 401)은 키가 현재 실행을 허용받았는지 여부와는 별개로, 그보다 먼저 검사됩니다. 인증에 성공한 키라도 관리자가 **비활성(inactive)**으로 전환했거나 상위 리소스에서 Kill Switch가 발동된 경우 중단될 수 있습니다 — 이는 401이 아니며, 어떤 리소스가 차단했는지 드러내지 않습니다. 오류 및 상태를 참고하세요.

​
키 관리

키는 활성 또는 비활성 상태일 수 있으며, 폐기할 수도 있습니다. 폐기는 영구적입니다. 전체 수명 주기는 API 키 관리를 참고하세요.