メインコンテンツへスキップ
GET
現在のデプロイメントの取得
string
必須
アカウントの API キーです。これはアカウント設定で確認できます。
apps:read スコープを持つ API キーが必要です。 このエンドポイントは、アプリケーションが現在どのように Git ベースのデプロイに接続されているかを示します。連携の設定方法に応じて、GitHub App によるリポジトリ連携、従来型の webhook URL、またはその両方が返されます。デプロイのトラブルシューティングを行う前に追跡対象のリポジトリとブランチを確認したり、webhook をまだ生成する必要があるかどうかを確認したりする際に利用してください。 レスポンスは所有者とアプリケーションごとに 5 分間キャッシュされるため、GitHub Webhook の設定 で行った変更が反映されるまで数分かかる場合があります。ワークスペースで共有されているアプリケーションでは、呼び出し元に manager または admin のロール、あるいは所有権が必要です。現在の設定ではなくデプロイ履歴を確認したい場合は、デプロイメントの一覧 を使用してください。 webhook URL はデプロイの認証情報として機能するため、完全な形で返されるのはそれを設定できる呼び出し元のみです。対象は apps:deploy スコープ(またはフルアクセス)を持つ API キー、およびワークスペースで共有されているアプリケーションでは admin ロールまたは所有者です。それ以外の呼び出し元(apps:read キーや manager など)にはマスクされた URL(https://api.squarecloud.app/v2/git/webhook/********)が返されますが、webhook が設定されていることは確認できます。

パラメータ

string
必須
アプリケーションの ID です。アプリケーションのダッシュボードの URL で確認できます。

レスポンス

string
呼び出しが成功したかどうかを示します。成功した場合は success、失敗した場合は error です。
object
レスポンスの内容です。

関連項目