API 레퍼런스
로그인
본문으로 건너뛰기

API 키 목록

GET/v1/organizations/{org_id}/api-keys

키 목록을 돌려줍니다, 비밀 값은 돌려주지 않고 개발자는 배정된 워크스페이스의 키만 봅니다

콘솔 세션 전용입니다, 조직 역할 owner, admin, developer만 부를 수 있고 API 키로 부르면 403 console_only입니다

참고 서버 구현(2026-10-12 dev 기준)이 계약 초안과 다른 점

  • 서버는 workspace_id와 status 쿼리를 무시하고 보이는 키를 모두 돌려줍니다, status 필드로 직접 거르세요
  • 서버 응답에는 revoke_reason이 아직 없습니다

Headers

  • Cookie: string
    콘솔 로그인 세션 쿠키, 콘솔 전용 엔드포인트라 API 키로 부르면 403 console_only입니다

Parameters

  • org_id: string
    조직 ID
    형식 ^org_[A-Za-z0-9]+$
  • workspace_id: optional string
    콘솔 세션은 워크스페이스가 필요한 곳에서 필수, API 키는 생략하거나 키의 워크스페이스와 같아야 합니다
  • status: optional "active" or "revoked" or "expired" or "all"
    active, revoked, expired, all, 기본 active
    기본값 "active"

Returns

200 application/json

  • ApiKeyList: object
    • data: array of ApiKey { id, organization_id, workspace_id, … }
      항목 배열
      • id: string
        ID
        형식 ^key_[A-Za-z0-9]+$
      • organization_id: optional string
        조직 ID
      • workspace_id: string
        워크스페이스 ID
      • name: string
        이름
      • permission: "run" or "read"
        권한(run 또는 read)
      • prefix_display: string
        앞 12자와 뒤 4자, 예 xci_live_3fK…Pm81
      • status: "active" or "disabled" or "revoked" or "expired"
        active, revoked, expired
      • created_by: optional string or null
        만든 사용자
      • created_at: string
        만든 시각
        RFC 3339 UTC 시각
      • last_used_at: optional string or null
        마지막 사용 시각
      • expires_at: optional string or null
        만료 시각, 없으면 null
      • revoked_at: optional string or null
        폐기 시각
      • revoke_reason: optional "user" or "leaked_public" or "workspace_archived" or null
        user(사용자 폐기), leaked_public(공개 유출 자동 폐기), workspace_archived(워크스페이스 보관), 아니면 null
      • disabled_at: optional string or null
        키를 끈 시각, 꺼진 키는 다시 켤 때까지 폐기된 키처럼 거부됩니다
        RFC 3339 UTC 시각
      • allowed_cidrs: optional array of string
        키별 CIDR 허용 목록, 조직 목록에 더해 검사합니다, 비어 있으면 추가 제한 없음

오류

  • invalid_request: HTTP 400
    본문이나 쿼리가 검증에 실패했습니다, error.details.fields에 문제 필드가 있습니다
  • session_required: HTTP 401
    콘솔 엔드포인트를 유효한 콘솔 세션 쿠키 없이 불렀습니다
  • console_only: HTTP 403
    콘솔 세션 전용 엔드포인트입니다, API 키로는 결제, 키, 멤버 관리를 할 수 없습니다
  • insufficient_permission: HTTP 403
    역할이나 키 권한(run/read)이 이 요청을 허용하지 않습니다
  • not_found: HTTP 404
    자원이 없거나 이 호출자에게 보이지 않습니다
  • rate_limited: HTTP 429, 다시 시도 가능
    이 키 또는 조직의 요청이 너무 많습니다, retry_after_s만큼 기다리세요
  • internal_error: HTTP 500, 다시 시도 가능
    예상하지 못한 오류입니다, 다시 시도하고 반복되면 request_id와 함께 알려 주세요

오류 봉투 모양과 전체 코드 표는 오류 코드에 있습니다

다음 단계