GitHub-App-Repository verknüpfen

POST

apps

{app_id}

deploy

github-app

GitHub-App-Repository verknüpfen

curl --request POST \
  --url https://api.squarecloud.app/v2/apps/{app_id}/deploy/github-app \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "repositoryName": "<string>",
  "repositoryBranch": "<string>"
}
'

import requests

url = "https://api.squarecloud.app/v2/apps/{app_id}/deploy/github-app"

payload = {
    "repositoryName": "<string>",
    "repositoryBranch": "<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({repositoryName: '<string>', repositoryBranch: '<string>'})
};

fetch('https://api.squarecloud.app/v2/apps/{app_id}/deploy/github-app', 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/github-app",
  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([
    'repositoryName' => '<string>',
    'repositoryBranch' => '<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/github-app"

	payload := strings.NewReader("{\n  \"repositoryName\": \"<string>\",\n  \"repositoryBranch\": \"<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/github-app")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"repositoryName\": \"<string>\",\n  \"repositoryBranch\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/apps/{app_id}/deploy/github-app")

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  \"repositoryName\": \"<string>\",\n  \"repositoryBranch\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
    "status": "success",
    "response": {
        "repository": {
            "id": 1234567,
            "full_name": "octocat/hello-world",
            "branch": "main"
        }
    }
}

string

erforderlich

Der API-Schlüssel für dein Konto. Du findest ihn in deinen Kontoeinstellungen.

Erfordert einen API-Schlüssel mit dem Scope apps:deploy. Dieser Endpunkt verknüpft eine Anwendung über die Square Cloud GitHub App mit einem GitHub-Repository und einem Branch, sodass jeder Push auf diesen Branch die Anwendung deployt. Er ist die empfohlene Alternative zu GitHub-Webhook einrichten: Es wird kein Personal Access Token gespeichert, und jedes Deployment erscheint als Check Run am Commit. Verbinde vor dem Aufruf dein GitHub-Konto mit Square Cloud und installiere die Square Cloud GitHub App im Repository. Das Repository muss von einer Installation abgedeckt sein, die zu deinem eigenen GitHub-Konto gehört; andernfalls schlägt die Anfrage mit REPOSITORY_NOT_AVAILABLE fehl. Dieses GitHub-Konto braucht außerdem Schreib- (Push) oder Admin-Rechte am Repository: Mit reinem Lesezugriff schlägt die Anfrage mit REPOSITORY_PERMISSION_REQUIRED fehl. Er funktioniert mit einem API-Schlüssel mit dem Scope apps:deploy, und nur der Eigentümer der Anwendung kann ihn aufrufen. Eine Anwendung hat jeweils nur eine GitHub-App-Verknüpfung. Trenne also das aktuelle Repository, bevor du ein anderes verknüpfst. Ein Repository und Branch kann auf der gesamten Plattform nur mit einer Anwendung verknüpft sein, egal wem sie gehört. Das Verknüpfen invalidiert die zwischengespeicherte Antwort von Aktuelles Deployment abrufen. Aufrufe sind auf 3 pro 60 Sekunden pro Benutzer begrenzt, gemeinsam mit dem Trennen.

Parameter

string

erforderlich

Die ID der Anwendung. Du findest sie in der URL des Dashboards deiner Anwendung.

string

erforderlich

Der vollständige Name des Repositorys im Format owner/repository.

string

erforderlich

Der Branch, dessen Pushes die Anwendung deployen. Bis zu 256 Zeichen, und er muss unter genau diesem Namen im Repository existieren.

Antwort

string

Gibt an, ob der Aufruf erfolgreich war: success, wenn ja, error, wenn nicht.

object

Der Inhalt der Antwort.

Anzeigen Objekt umschalten

object

Das verknüpfte Repository.

Anzeigen Objekt umschalten

number

Die GitHub-ID des Repositorys.

string

Der vollständige Name des Repositorys.

string

Der Branch, der die Anwendung deployt.

{
    "status": "success",
    "response": {
        "repository": {
            "id": 1234567,
            "full_name": "octocat/hello-world",
            "branch": "main"
        }
    }
}

Häufige Fehler

Code	HTTP	Bedeutung
`MISSING_REQUIRED_FIELDS`	400	`repositoryName` oder `repositoryBranch` fehlt.
`INVALID_BRANCH_LENGTH`	400	Der Branch-Name ist länger als 256 Zeichen.
`BRANCH_NOT_FOUND`	400	Der Branch existiert nicht im Repository.
`GIT_ALREADY_CONFIGURED`	400	Die Anwendung hat bereits ein GitHub-App-Repository. Trenne es zuerst.
`REPOSITORY_NOT_AVAILABLE`	403	Die Square Cloud GitHub App ist über dein GitHub-Konto nicht im Repository installiert.
`REPOSITORY_PERMISSION_REQUIRED`	403	Dein verbundenes GitHub-Konto hat nur Lesezugriff auf das Repository. Es braucht Schreib- (Push) oder Admin-Rechte.
`REPOSITORY_NOT_FOUND`	404	Das Repository existiert nicht oder dein GitHub-Konto kann es nicht sehen.
`APP_NOT_FOUND`	404	Die Anwendung existiert nicht oder du bist nicht ihr Eigentümer.
`REPOSITORY_BRANCH_ALREADY_CONFIGURED`	409	Eine andere Anwendung, egal von welchem Konto, verknüpft bereits dieses Repository und diesen Branch. Die Nachricht nennt diese Anwendung nur, wenn sie dir gehört.
`FAILED_TO_FETCH`	502	GitHub hat den Branch nicht bestätigt. Versuche es erneut.

Siehe auch

CLI: squarecloud app deploy github link
SDKs: api.apps.deploys.linkGithubApp() (JavaScript), client.apps.deploys.link_github_app() (Python), c.Apps.Deploys.LinkGithubApp() (Go)

GitHub-App-Repository verknüpfen

curl --request POST \
  --url https://api.squarecloud.app/v2/apps/{app_id}/deploy/github-app \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "repositoryName": "<string>",
  "repositoryBranch": "<string>"
}
'

import requests

url = "https://api.squarecloud.app/v2/apps/{app_id}/deploy/github-app"

payload = {
    "repositoryName": "<string>",
    "repositoryBranch": "<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({repositoryName: '<string>', repositoryBranch: '<string>'})
};

fetch('https://api.squarecloud.app/v2/apps/{app_id}/deploy/github-app', 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/github-app",
  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([
    'repositoryName' => '<string>',
    'repositoryBranch' => '<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/github-app"

	payload := strings.NewReader("{\n  \"repositoryName\": \"<string>\",\n  \"repositoryBranch\": \"<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/github-app")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"repositoryName\": \"<string>\",\n  \"repositoryBranch\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/apps/{app_id}/deploy/github-app")

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  \"repositoryName\": \"<string>\",\n  \"repositoryBranch\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
    "status": "success",
    "response": {
        "repository": {
            "id": 1234567,
            "full_name": "octocat/hello-world",
            "branch": "main"
        }
    }
}

Erste Schritte

Konto

Anwendungen

Datenbanken

Workspaces

KI

GitHub-App-Repository verknüpfen

Parameter

Antwort

Häufige Fehler

Siehe auch

​Parameter

​Antwort

​Häufige Fehler

​Siehe auch

Parameter

Antwort

Häufige Fehler

Siehe auch