API 레퍼런스

환경

환경 목록을 보고 새 환경을 만듭니다.

환경 목록

GET/projects/{project}/environments

모든 환경을 표시 순서대로 돌려줍니다.

헤더

Authorizationstring필수: Bearer <token>

경로 파라미터

projectstring필수: 프로젝트 id. 예: prj_8d2kq.

요청

Terminal

curl https://api.shoal.dev/v2/projects/prj_8d2kq/environments \
  -H "Authorization: Bearer $SHOAL_TOKEN"

TypeScript

const { data } = await api.environments.list("prj_8d2kq");

Python

envs = api.environments.list("prj_8d2kq")

응답

JSON

{
  "data": [
    { "key": "development", "protected": false, "color": "#5b8def" },
    { "key": "production", "protected": true, "color": "#e5484d" }
  ]
}

환경 만들기

POST/projects/{project}/environments

환경과 서버·클라이언트 키를 만듭니다. 플래그는 꺼진 상태로 시작합니다.

헤더

Authorizationstring필수: Bearer <token>

경로 파라미터

projectstring필수: 프로젝트 id. 예: prj_8d2kq.

본문 파라미터

keystring필수: 예: staging.
protectedboolean선택기본값: false: 변경 시 코멘트(선택적으로 승인) 필요.
copyFromstring선택: 다른 환경의 플래그 상태 복사.

요청

Terminal

curl -X POST https://api.shoal.dev/v2/projects/prj_8d2kq/environments \
  -H "Authorization: Bearer $SHOAL_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "key": "staging", "copyFrom": "development" }'

TypeScript

const env = await api.environments.create("prj_8d2kq", { key: "staging", copyFrom: "development" });

Python

env = api.environments.create("prj_8d2kq", key="staging", copy_from="development")

응답

JSON

{
  "key": "staging",
  "protected": false,
  "keys": { "server": "sk_stg_…", "client": "ck_stg_…" }
}