REST · v2

API 레퍼런스

Shoal REST API로 프로젝트, 플래그, 환경, 웹훅을 관리합니다. HTTPS 위의 JSON, 예측 가능한 리소스 URL, 표준 HTTP 상태 코드를 씁니다.

기본 URL

https://api.shoal.dev/v2

Authorization 헤더에 API 토큰을 넣어 인증합니다. 토큰은 계정 → API 토큰에서 만들며 내 권한을 그대로 가지므로 서버에만 두세요.

목록 엔드포인트는 최대 limit개(기본 20, 최대 100)와 next 커서를 돌려줍니다. 다음 페이지는 이 값을 cursor로 넘기세요.

Terminal

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

TypeScript

import { Shoal } from "@shoal/api";

const api = new Shoal(process.env.SHOAL_TOKEN);
const projects = await api.projects.list();

Python

from shoal import Shoal

api = Shoal(os.environ["SHOAL_TOKEN"])
projects = api.projects.list()

오류는 기계가 읽는 code와 사람이 읽는 message가 담긴 JSON으로 돌아옵니다.