Zenn
🐡

Vercelのプロジェクトを一時停止する

2023/12/23に公開
Vercel
tech

備忘録としてまとめておきます。

参考: https://vercel.com/docs/projects/overview#pausing-a-project

2023年12月現在、Vercelのプロジェクトを管理画面から停止することはできません。
代わりにプロジェクト一時停止APIが用意されているので、それを使って一時停止を行います。

APIリクエストに必要な値は以下です。

  • アクセストークン
    • Bearer認証で利用
  • チームID
  • プロジェクトID

設定値取得

アクセストークン

account settingsからアクセストークンを発行してください。
参考: https://vercel.com/docs/rest-api#creating-an-access-token

チームID

一時停止したいプロジェクトが属するチームのSettingsを開き、画面中程のTeam IDをコピーしてください。

プロジェクトID

一時停止したいプロジェクトのSettingsを開き、画面中程のProject IDをコピーしてください。

APIリクエスト

前項で取得した設定値を用いてcurlでAPIをリクエストします。

curl -X POST "https://api.vercel.com/v1/projects/PROJECT_ID/pause?teamId=TEAM_ID" \
-H "Authorization: Bearer ACCESS_TOKEN" \
-H "Content-Type: application/json"

リクエスト後に、ページにアクセスして503の画面が表示されたら一時停止の完了です👏
余談ですが、再開は管理画面から行うことができます。(一時停止も管理画面からできるようにしてくれるとうれしそう)

最後に

ドキュメントに当たるのはやっぱり大事

GitHubで編集を提案

Discussion