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

API 키 발급

워크스페이스에 묶인 API 키를 발급합니다, 비밀 값은 이 응답에서 한 번만 보입니다

POST /v1/organizations/{org_id}/workspaces/{workspace_id}/api-keys

인증

방식허용조건
API 키 (Authorization: Bearer xci_live_…)불가콘솔 세션 전용, 키로 부르면 403 console_only
콘솔 세션 쿠키가능조직 역할 owner, admin, developer, 같은 출처의 Origin 헤더 필요
  • 개발자는 자기에게 배정된 워크스페이스에서만 키를 만들 수 있습니다
  • secret은 이 응답에서만 보입니다, 서버는 해시만 저장합니다

매개변수

이름위치타입필수설명
org_id경로string필수조직 ID, 형식 ^org_[A-Za-z0-9]+$
workspace_id경로string필수워크스페이스 ID, 형식 ^wrk_[A-Za-z0-9]+$

요청 본문

필드타입필수설명
namestring필수키 이름, 1자 이상, 80자 이하
permissionrun | readrun(잡 제출과 취소, 조회) 또는 read(조회만), 기본 run
expires_in_days30 | 90 | 36530, 90, 365 또는 null(만료 없음), null 가능

응답

201

필드타입항상설명
idstring항상ID, 형식 ^key_[A-Za-z0-9]+$
organization_idstring조직 ID
workspace_idstring항상워크스페이스 ID
namestring항상이름
permissionrun | read항상권한(run 또는 read)
prefix_displaystring항상표시용 앞뒤 글자
statusactive | revoked | expired항상상태
created_bystring만든 사용자, null 가능
created_attimestamp항상만든 시각
last_used_attimestamp 또는 null마지막 사용, null 가능
expires_attimestamp 또는 null만료 시각, null 가능
revoked_attimestamp 또는 null폐기 시각, null 가능
revoke_reasonuser | leaked_public | workspace_archived폐기 이유, null 가능
secretstring항상키 비밀 값, 이 응답에서만 보이고 기록에 남지 않습니다, 형식 ^xci_live_[A-Za-z0-9]{43}_[A-Za-z0-9]{6}$
{
  "id": "key_8Pz4Nk1Rt6",
  "organization_id": "org_7Kq2m9ZtP3",
  "workspace_id": "wrk_3fK9Qm2Zp8",
  "name": "ios-app",
  "permission": "run",
  "prefix_display": "…",
  "status": "active",
  "created_by": "usr_5Jd2Lm8Qw1",
  "created_at": "2026-10-12T03:11:05Z",
  "last_used_at": "2026-10-12T03:11:05Z",
  "expires_at": "2026-10-12T03:11:05Z",
  "revoked_at": "2026-10-12T03:11:05Z",
  "revoke_reason": "user",
  "secret": "xci_live_3fK9Qm2Zp8Wn4Hb7Tc1Lx5Rv0Yd6Ke2Ja9Mu8Sq3Go_Pm81zQ"
}

오류

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

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

예시

curl -X POST "https://xenoci.com/api/runner/v1/organizations/org_7Kq2m9ZtP3/workspaces/wrk_3fK9Qm2Zp8/api-keys" \
  --cookie "xci_console=$SESSION" \
  -H "Origin: https://xenoci.com" \
  -H "Content-Type: application/json" \
  -d '{"name":"ci","permission":"run","expires_in_days":90}'

다음 단계