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

API 키 이름 바꾸기

키 이름을 바꿉니다

PATCH /v1/organizations/{org_id}/api-keys/{key_id}

인증

방식허용조건
API 키 (Authorization: Bearer xci_live_…)불가콘솔 세션 전용, 키로 부르면 403 console_only
콘솔 세션 쿠키가능조직 역할 owner, admin, developer, 같은 출처의 Origin 헤더 필요

매개변수

이름위치타입필수설명
org_id경로string필수조직 ID, 형식 ^org_[A-Za-z0-9]+$
key_id경로string필수API 키 ID, 형식 ^key_[A-Za-z0-9]+$

요청 본문

필드타입필수설명
namestring필수이름, 1자 이상, 80자 이하

응답

200

필드타입항상설명
idstring항상ID, 형식 ^key_[A-Za-z0-9]+$
organization_idstring조직 ID
workspace_idstring항상워크스페이스 ID
namestring항상이름
permissionrun | read항상권한(run 또는 read)
prefix_displaystring항상앞 12자와 뒤 4자, 예 xcilive3fK…Pm81
statusactive | revoked | expired항상active, revoked, expired
created_bystring만든 사용자, null 가능
created_attimestamp항상만든 시각
last_used_attimestamp 또는 null마지막 사용 시각, null 가능
expires_attimestamp 또는 null만료 시각, 없으면 null, null 가능
revoked_attimestamp 또는 null폐기 시각, null 가능
revoke_reasonuser | leaked_public | workspace_archiveduser(사용자 폐기), leakedpublic(공개 유출 자동 폐기), workspacearchived(워크스페이스 보관), 아니면 null, null 가능
{
  "id": "key_8Pz4Nk1Rt6",
  "organization_id": "org_7Kq2m9ZtP3",
  "workspace_id": "wrk_3fK9Qm2Zp8",
  "name": "ci",
  "permission": "run",
  "prefix_display": "xci_live_3fK…Pm81",
  "status": "active",
  "created_by": "usr_5Jd2Lm8Qw1",
  "created_at": "2026-10-12T03:11:05Z",
  "last_used_at": null,
  "expires_at": "2027-01-10T03:11:05Z",
  "revoked_at": null,
  "revoke_reason": null
}

오류

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

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

예시

curl -X PATCH "https://xenoci.com/api/runner/v1/organizations/org_7Kq2m9ZtP3/api-keys/key_8Pz4Nk1Rt6" \
  --cookie "xci_console=$SESSION" \
  -H "Origin: https://xenoci.com" \
  -H "Content-Type: application/json" \
  -d '{"name":"ci-main"}'

다음 단계