콘텐츠로 이동
endue OSDocs

프로젝트 수정

PATCH
/api/v1/projects/{project_id}
curl --request PATCH \
  --url https://dev.api.endueos.com/api/v1/projects/prj_01J9ZK3Q8M4XW7D2N5R6T0V1BC \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "description": "example" }'

이름·설명을 바꾼다. 그 조직의 owner·admin (아니면 403 ORG_FORBIDDEN).

인증

섹션 제목: “인증”

파라미터

섹션 제목: “파라미터”

경로 파라미터

섹션 제목: “경로 파라미터”
project_id
필수

프로젝트 — 조직 아래, Station 위 (D-51 · D-60).

string
/^prj_[0-9A-HJKMNP-TV-Z]{26}$/
예시
prj_01J9ZK3Q8M4XW7D2N5R6T0V1BC

요청 본문필수

섹션 제목: “요청 본문필수”
Media typeapplication/json
object
name
string
>= 1 characters <= 100 characters
description
Any of:
string
예시자동 생성
{
  "name": "example",
  "description": "example"
}

응답

섹션 제목: “응답”

200

섹션 제목: “200”

성공.

Media typeapplication/json
object
data
필수

Station 을 묶는 단위. 조직 아래, Station 위. 빌링을 따로 갖지 않는다 — 조직의 지갑을 함께 쓴다.

object
project_id
필수

프로젝트 — 조직 아래, Station 위 (D-51 · D-60).

string
/^prj_[0-9A-HJKMNP-TV-Z]{26}$/
org_id
필수

이 프로젝트의 조직 (D-60).

string
/^org_[0-9A-HJKMNP-TV-Z]{26}$/
name
필수
string
description
필수
Any of:
string
station_count
필수

이 프로젝트의 Station 수.

integer format: int32
created_at
필수
string format: date-time
updated_at
필수
string format: date-time
meta
필수
object
request_id
필수
string
timestamp
필수
string format: date-time
duration

서버 처리 시간(ms).

integer format: int32
예시
{
  "data": {
    "project_id": "prj_01J9ZK3Q8M4XW7D2N5R6T0V1BC",
    "org_id": "org_01J9ZK3Q8M4XW7D2N5R6T0V1BC"
  }
}

400

섹션 제목: “400”

요청 형식이 틀렸다 — VALIDATION_ERROR(details.errors[]) 또는 BAD_REQUEST. 본문은 오류 봉투.

401

섹션 제목: “401”

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

403

섹션 제목: “403”

이 인증 수단으로는 못 하는 일이다 — FORBIDDEN (예: API 키로 클라우드 기기 만들기). 본문은 오류 봉투.

404

섹션 제목: “404”

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

429

섹션 제목: “429”

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

500

섹션 제목: “500”

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

503

섹션 제목: “503”

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