레시피 하나를 돌려줍니다
GET /v1/recipes/{recipe_id}
| 방식 | 허용 | 조건 |
|---|
API 키 (Authorization: Bearer xci_live_…) | 가능 | 키 권한 read (run 키도 가능) |
| 콘솔 세션 쿠키 | 가능 | 조직 역할 owner, admin, developer |
| 이름 | 위치 | 타입 | 필수 | 설명 |
|---|
recipe_id | 경로 | string | 필수 | 레시피 ID, 형식 ^rcp_[A-Za-z0-9_]+$ |
| 필드 | 타입 | 항상 | 설명 |
|---|
id | string | 항상 | ID |
builtin | boolean | 항상 | 기본 제공이면 true, 읽기 전용이고 모든 워크스페이스가 공유합니다 |
workspace_id | string | | 워크스페이스 ID, null 가능 |
name | string | 항상 | 이름 |
description | string | | 설명, null 가능 |
script | string | 항상 | 스크립트 |
default_xcode | string | | 잡이 Xcode를 안 고르면 쓰는 값, null 가능 |
required_env | array<string> | | 이 레시피 잡이 꼭 넘겨야 하는 env 이름, 빠지면 VM을 띄우기 전에 400 |
guide | string | | 필요한 값을 어떻게 준비하는지 안내, null 가능 |
created_at | string | | 만든 시각 |
updated_at | string | | 바꾼 시각 |
{
"id": "rcp_ios_build",
"builtin": true,
"workspace_id": null,
"name": "iOS 빌드",
"description": "xcodebuild로 앱을 빌드합니다",
"script": "xcodebuild -scheme \"$SCHEME\" -destination \"generic/platform=iOS Simulator\" build",
"default_xcode": null,
"required_env": [
"SCHEME"
],
"guide": "SCHEME에 Xcode 스킴 이름을 넣습니다",
"created_at": "…",
"updated_at": "…"
}
| HTTP | 코드 | 다시 시도 | 뜻 |
|---|
| 400 | invalid_request | 아니오 | 본문이나 쿼리가 검증에 실패했습니다, error.details.fields에 문제 필드가 있습니다 |
| 401 | api_key_required | 아니오 | API 키 엔드포인트에 Authorization: Bearer 헤더가 없습니다 |
| 401 | api_key_revoked_leaked | 아니오 | 공개 유출 신고로 자동 폐기된 키입니다, 새 키를 발급하세요 |
| 401 | invalid_api_key | 아니오 | 모르는 키이거나 폐기, 만료, 체크섬 불일치입니다(종료된 xeno_ 접두사 포함) |
| 401 | session_required | 아니오 | 콘솔 엔드포인트를 유효한 콘솔 세션 쿠키 없이 불렀습니다 |
| 403 | insufficient_permission | 아니오 | 역할이나 키 권한(run/read)이 이 요청을 허용하지 않습니다 |
| 404 | not_found | 아니오 | 자원이 없거나 이 호출자에게 보이지 않습니다 |
| 429 | rate_limited | 가능 | 이 키 또는 조직의 요청이 너무 많습니다, retryafters만큼 기다리세요 |
| 500 | internal_error | 가능 | 예상하지 못한 오류입니다, 다시 시도하고 반복되면 request_id와 함께 알려 주세요 |
오류 봉투 모양과 전체 코드 표는 오류 코드에 있습니다
curl "https://xenoci.com/api/runner/v1/recipes/rcp_2Wn5Kz8Qp1" \
-H "Authorization: Bearer $XENOCI_API_KEY"
