Collega un repository della GitHub App

POST

apps

{app_id}

deploy

github-app

Collega un repository della 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

obbligatorio

La chiave API del tuo account. Puoi trovarla nelle impostazioni del tuo account.

Questo endpoint collega un’applicazione a un repository e a un branch GitHub tramite la Square Cloud GitHub App, così ogni push su quel branch esegue il deploy dell’applicazione. È l’alternativa consigliata a Imposta Webhook GitHub: non viene salvato alcun token di accesso personale e ogni deploy compare come Check Run sul commit. Prima di chiamarlo, collega il tuo account GitHub a Square Cloud e installa la Square Cloud GitHub App sul repository. Il repository deve essere coperto da un’installazione del tuo account GitHub; altrimenti la richiesta fallisce con REPOSITORY_NOT_AVAILABLE. Funziona con una chiave API che abbia l’ambito apps:deploy, e solo il proprietario dell’applicazione può chiamarlo. Un’applicazione può avere un solo collegamento GitHub App alla volta, quindi scollega il repository attuale prima di collegarne un altro; inoltre lo stesso repository e branch non può essere collegato a due delle tue applicazioni. Il collegamento invalida la risposta memorizzata in cache di Ottieni Deployment Corrente. Le chiamate sono limitate a 3 ogni 60 secondi per utente, condivise con lo scollegamento.

Parametri

string

obbligatorio

L’ID dell’applicazione. Puoi trovarlo nell’URL della dashboard della tua applicazione.

string

obbligatorio

Il nome completo del repository, nel formato owner/repository.

string

obbligatorio

Il branch i cui push eseguono il deploy dell’applicazione. Fino a 256 caratteri, e deve esistere nel repository.

Risposta

string

Indica se la chiamata è andata a buon fine. success in caso di successo, error in caso contrario.

object

Il contenuto della risposta.

Mostra Mostra oggetto

object

Il repository collegato.

Mostra Mostra oggetto

number

L’ID GitHub del repository.

string

Il nome completo del repository.

string

Il branch che esegue il deploy dell’applicazione.

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

Errori comuni

Codice	HTTP	Significato
`MISSING_REQUIRED_FIELDS`	400	Manca `repositoryName` o `repositoryBranch`.
`INVALID_BRANCH_LENGTH`	400	Il nome del branch supera i 256 caratteri.
`BRANCH_NOT_FOUND`	400	Il branch non esiste nel repository.
`GIT_ALREADY_CONFIGURED`	400	L’applicazione ha già un repository della GitHub App. Scollegalo prima.
`REPOSITORY_NOT_AVAILABLE`	403	La Square Cloud GitHub App non è installata sul repository tramite il tuo account GitHub.
`REPOSITORY_NOT_FOUND`	404	Il repository non esiste o il tuo account GitHub non può vederlo.
`APP_NOT_FOUND`	404	L’applicazione non esiste o non ne sei il proprietario.
`REPOSITORY_BRANCH_ALREADY_CONFIGURED`	409	Un’altra delle tue applicazioni collega già questo repository e branch.

Collega un repository della 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"
        }
    }
}

​Parametri

​Risposta

​Errori comuni

Parametri

Risposta

Errori comuni