installWorkspace

POST

/api/v1/workspaces/{workspace_id}/install

const url = 'https://dev.api.endueos.com/api/v1/workspaces/wsp_01J9ZK3Q8M4XW7D2N5R6T0V1BC/install';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://dev.api.endueos.com/api/v1/workspaces/wsp_01J9ZK3Q8M4XW7D2N5R6T0V1BC/install \
  --header 'Authorization: Bearer <token>'

Issues the agent connection token of a local workspace. Each call invalidates the previous token; 409 AGENT_CONNECTED while its device is connected, 409 WORKSPACE_STATE_CONFLICT for cloud workspaces.

인증

파라미터

경로 파라미터

workspace_id

필수

string

/^wsp_[0-9A-HJKMNP-TV-Z]{26}$/

예시

wsp_01J9ZK3Q8M4XW7D2N5R6T0V1BC

응답

200

성공.

application/json

object

data

필수

Connection values for installing the agent of a local workspace. The token is shown only here.

object

workspace_id

필수

string

/^wsp_[0-9A-HJKMNP-TV-Z]{26}$/

environment

필수

string

허용 값: linux chrome macos android

endpoint

필수

Relay socket the agent connects to, wss://{host}/api/v1/relay/socket.

string

token

필수

Agent connection token (osat_). Issuing again invalidates the previous token.

string

download_base

필수

Any of:

string
null

string

meta

필수

object

request_id

필수

string

timestamp

필수

string format: date-time

duration

서버 처리 시간(ms).

integer format: int32

예시

{
  "data": {
    "workspace_id": "wsp_01J9ZK3Q8M4XW7D2N5R6T0V1BC",
    "environment": "linux"
  }
}

응답 헤더

Cache-Control

필수

string

허용 값: no-store

401

인증이 없거나 무효다 — UNAUTHORIZED. 본문은 오류 봉투.

404

없거나 내 것이 아니다 — *_NOT_FOUND. 본문은 오류 봉투.

409

지금 상태와 충돌한다 — 코드는 위 설명을 본다. 본문은 오류 봉투.

429

한도를 넘었다 — Retry-After 초 뒤에 다시. 본문은 오류 봉투.

500

서버 오류 — INTERNAL_ERROR. 본문은 오류 봉투.

503

의존 서비스에 닿지 못했다 — 잠시 뒤 다시. 본문은 오류 봉투.