アプリケーション - デプロイ
GitHub Webhook の設定
Square Cloud を GitHub の webhook と連携します。
POST
/
v2
/
apps
/
{app_id}
/
deploy
/
webhook
GitHub Webhook の設定
curl --request POST \
--url https://api.squarecloud.app/v2/apps/{app_id}/deploy/webhook \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"access_token": "<string>"
}
'import requests
url = "https://api.squarecloud.app/v2/apps/{app_id}/deploy/webhook"
payload = { "access_token": "<string>" }
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({access_token: '<string>'})
};
fetch('https://api.squarecloud.app/v2/apps/{app_id}/deploy/webhook', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.squarecloud.app/v2/apps/{app_id}/deploy/webhook",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'access_token' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.squarecloud.app/v2/apps/{app_id}/deploy/webhook"
payload := strings.NewReader("{\n \"access_token\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.squarecloud.app/v2/apps/{app_id}/deploy/webhook")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"access_token\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.squarecloud.app/v2/apps/{app_id}/deploy/webhook")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"access_token\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"response": {
"webhook": "https://api.squarecloud.app/v2/git/webhook/<webhook-code>"
}
}
このエンドポイントは、従来型の方法でアプリケーションを GitHub リポジトリに接続します。パーソナルアクセストークン(
ghp_* または詳細設定形式の github_pat_*)を生成すると、Square Cloud はそのリポジトリに登録するための一意な webhook URL を返し、push があるたびにデプロイがトリガーされるようになります。代わりに access_token: "@" を送信すると、アプリケーションに設定されている既存の webhook とアクセストークンが削除されます。
webhook を設定または削除すると、現在のデプロイメントの取得 のキャッシュされたレスポンスは無効になります。呼び出しはユーザーごとに 60 秒あたり 5 回までレート制限されており、ワークスペースで共有されているアプリケーションでは呼び出し元に Administrator ロールまたは所有権が必要です。この webhook によってトリガーされたデプロイ試行を確認するには、デプロイメントの一覧 を使用してください。
パラメータ
string
必須
アプリケーションの ID。アプリケーションのダッシュボードの URL で確認できます。
string
必須
GitHub リポジトリのアクセストークン。GitHub Tokens Classic で確認できます。
レスポンス
string
呼び出しが成功したかどうかを示します。成功した場合は
success、失敗した場合は error です。{
"status": "success",
"response": {
"webhook": "https://api.squarecloud.app/v2/git/webhook/<webhook-code>"
}
}
一般的なエラー
| コード | HTTP | 説明 |
|---|---|---|
INVALID_ACCESS_TOKEN | 400 | access_token が @ ではなく、ghp_*/github_pat_* の GitHub トークン形式とも一致しません。 |
⌘I
GitHub Webhook の設定
curl --request POST \
--url https://api.squarecloud.app/v2/apps/{app_id}/deploy/webhook \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"access_token": "<string>"
}
'import requests
url = "https://api.squarecloud.app/v2/apps/{app_id}/deploy/webhook"
payload = { "access_token": "<string>" }
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({access_token: '<string>'})
};
fetch('https://api.squarecloud.app/v2/apps/{app_id}/deploy/webhook', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.squarecloud.app/v2/apps/{app_id}/deploy/webhook",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'access_token' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.squarecloud.app/v2/apps/{app_id}/deploy/webhook"
payload := strings.NewReader("{\n \"access_token\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.squarecloud.app/v2/apps/{app_id}/deploy/webhook")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"access_token\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.squarecloud.app/v2/apps/{app_id}/deploy/webhook")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"access_token\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"response": {
"webhook": "https://api.squarecloud.app/v2/git/webhook/<webhook-code>"
}
}

