Lier un dépôt via la GitHub App

POST

apps

{app_id}

deploy

github-app

Lier un dépôt via la GitHub App

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

requis

La clé d’API de votre compte. Vous pouvez la trouver dans les paramètres de votre compte.

Nécessite une clé API avec le scope apps:deploy. Cet endpoint lie une application à un dépôt et à une branche GitHub via la GitHub App Square Cloud, afin que chaque push sur cette branche déploie l’application. C’est l’alternative recommandée à Configurer un webhook GitHub : aucun jeton d’accès personnel n’est stocké, et chaque déploiement apparaît comme un Check Run sur le commit. Avant de l’appeler, connectez votre compte GitHub à Square Cloud et installez la GitHub App Square Cloud sur le dépôt. Le dépôt doit être couvert par une installation détenue par votre propre compte GitHub ; sinon, la requête échoue avec REPOSITORY_NOT_AVAILABLE. Ce compte GitHub doit aussi avoir la permission d’écriture (push) ou d’administration sur le dépôt : un accès en lecture seule échoue avec REPOSITORY_PERMISSION_REQUIRED. Il fonctionne avec une clé d’API disposant de la portée apps:deploy, et seul le propriétaire de l’application peut l’appeler. Une application ne peut avoir qu’une seule liaison GitHub App à la fois : déliez donc le dépôt actuel avant d’en lier un autre. Un dépôt et une branche ne peuvent être liés qu’à une seule application sur toute la plateforme, quel que soit son propriétaire. La liaison invalide la réponse mise en cache par Obtenir le déploiement actuel. Les appels sont limités à 3 toutes les 60 secondes par utilisateur, un quota partagé avec l’action de délier.

Paramètres

string

requis

L’ID de l’application. Vous pouvez le trouver dans l’URL du tableau de bord de votre application.

string

requis

Le nom complet du dépôt, au format owner/repository.

string

requis

La branche dont les push déploient l’application. 256 caractères maximum, et elle doit exister dans le dépôt sous ce nom exact.

Réponse

string

Indique si l’appel a réussi : success si c’est le cas, error sinon.

object

Le contenu de la réponse.

Afficher Afficher l'objet

object

Le dépôt lié.

Afficher Afficher l'objet

number

L’ID GitHub du dépôt.

string

Le nom complet du dépôt.

string

La branche qui déploie l’application.

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

Erreurs courantes

Code	HTTP	Signification
`MISSING_REQUIRED_FIELDS`	400	`repositoryName` ou `repositoryBranch` est manquant.
`INVALID_BRANCH_LENGTH`	400	Le nom de la branche dépasse 256 caractères.
`BRANCH_NOT_FOUND`	400	La branche n’existe pas dans le dépôt.
`GIT_ALREADY_CONFIGURED`	400	L’application a déjà un dépôt GitHub App. Déliez-le d’abord.
`REPOSITORY_NOT_AVAILABLE`	403	La GitHub App Square Cloud n’est pas installée sur le dépôt via votre compte GitHub.
`REPOSITORY_PERMISSION_REQUIRED`	403	Votre compte GitHub connecté n’a qu’un accès en lecture au dépôt. Il lui faut la permission d’écriture (push) ou d’administration.
`REPOSITORY_NOT_FOUND`	404	Le dépôt n’existe pas ou votre compte GitHub ne peut pas le voir.
`APP_NOT_FOUND`	404	L’application n’existe pas ou vous n’en êtes pas le propriétaire.
`REPOSITORY_BRANCH_ALREADY_CONFIGURED`	409	Une autre application, de n’importe quel compte, lie déjà ce dépôt et cette branche. Le message ne nomme cette application que si elle vous appartient.
`FAILED_TO_FETCH`	502	GitHub n’a pas confirmé la branche. Réessayez.

Voir aussi

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

Lier un dépôt via la GitHub App

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"
        }
    }
}

Premiers pas

Compte

Applications

Bases de données

Workspaces

IA

Lier un dépôt via la GitHub App

Paramètres

Réponse

Erreurs courantes

Voir aussi

​Paramètres

​Réponse

​Erreurs courantes

​Voir aussi

Paramètres

Réponse

Erreurs courantes

Voir aussi