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

레시피 목록

기본 제공 레시피와 워크스페이스 레시피를 돌려줍니다

GET /v1/recipes

인증

방식허용조건
API 키 (Authorization: Bearer xci_live_…)가능키 권한 read (run 키도 가능)
콘솔 세션 쿠키가능조직 역할 owner, admin, developer

매개변수

이름위치타입필수설명
workspace_id쿼리string콘솔 세션은 워크스페이스가 필요한 곳에서 필수, API 키는 생략하거나 키의 워크스페이스와 같아야 합니다

응답

200

필드타입항상설명
dataarray<object>항상항목 배열
data[].idstring항상ID
data[].builtinboolean항상기본 제공이면 true, 읽기 전용이고 모든 워크스페이스가 공유합니다
data[].workspace_idstring워크스페이스 ID, null 가능
data[].namestring항상이름
data[].descriptionstring설명, null 가능
data[].scriptstring항상스크립트
data[].default_xcodestring잡이 Xcode를 안 고르면 쓰는 값, null 가능
data[].required_envarray<string>이 레시피 잡이 꼭 넘겨야 하는 env 이름, 빠지면 VM을 띄우기 전에 400
data[].guidestring필요한 값을 어떻게 준비하는지 안내, null 가능
data[].created_atstring만든 시각
data[].updated_atstring바꾼 시각
{
  "data": [
    {
      "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코드다시 시도뜻
400invalid_request아니오본문이나 쿼리가 검증에 실패했습니다, error.details.fields에 문제 필드가 있습니다
401api_key_required아니오API 키 엔드포인트에 Authorization: Bearer 헤더가 없습니다
401api_key_revoked_leaked아니오공개 유출 신고로 자동 폐기된 키입니다, 새 키를 발급하세요
401invalid_api_key아니오모르는 키이거나 폐기, 만료, 체크섬 불일치입니다(종료된 xeno_ 접두사 포함)
401session_required아니오콘솔 엔드포인트를 유효한 콘솔 세션 쿠키 없이 불렀습니다
403insufficient_permission아니오역할이나 키 권한(run/read)이 이 요청을 허용하지 않습니다
404not_found아니오자원이 없거나 이 호출자에게 보이지 않습니다
429rate_limited가능이 키 또는 조직의 요청이 너무 많습니다, retryafters만큼 기다리세요
500internal_error가능예상하지 못한 오류입니다, 다시 시도하고 반복되면 request_id와 함께 알려 주세요

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

예시

curl "https://xenoci.com/api/runner/v1/recipes" \
  -H "Authorization: Bearer $XENOCI_API_KEY"

다음 단계