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

워크스페이스 기본 환경

PUT/v1/organizations/{org_id}/workspaces/{workspace_id}/environment

워크스페이스의 기본 환경과 기본 Xcode를 정합니다

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

Headers

  • Cookie: string
    콘솔 로그인 세션 쿠키, 콘솔 전용 엔드포인트라 API 키로 부르면 403 console_only입니다
  • Origin: string
    콘솔 세션으로 상태를 바꿀 때 같은 출처(https://xenoci.com)여야 합니다, API 키 요청에는 필요 없습니다

Path Parameters

  • org_id: string
    조직 ID
    형식 ^org_[A-Za-z0-9]+$
  • workspace_id: string
    워크스페이스 ID
    형식 ^wrk_[A-Za-z0-9]+$

Body

  • environment_id: string
    환경 ID
  • xcode: optional string or null
    환경 목록의 Xcode 버전 중 하나

Returns

200 application/json

  • WorkspaceEnvironment: object
    • workspace_id: string
      워크스페이스 ID
    • environment_id: string
      환경 ID
    • xcode: string or null
      잡과 배치와 플레이그라운드가 Xcode를 안 고르면 쓰는 값(레시피 default_xcode가 우선), null이면 이미지 기본값
    • updated_at: optional string or null
      바꾼 시각

오류

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

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

다음 단계