Commiter une application

POST

apps

{app_id}

commit

curl --request POST \
  --url https://api.squarecloud.app/v2/apps/{app_id}/commit \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://api.squarecloud.app/v2/apps/{app_id}/commit"

payload = {}
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({})
};

fetch('https://api.squarecloud.app/v2/apps/{app_id}/commit', 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}/commit",
  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([
    
  ]),
  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}/commit"

	payload := strings.NewReader("{}")

	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}/commit")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

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

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

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

{
    "status": "success"
}

string

requis

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

Commit envoie un fichier unique ou une archive .zip vers une application existante sans la recréer. Un .zip est décompressé dans le répertoire de destination, tandis que tout autre fichier est écrit tel quel. C’est le moyen le plus rapide de pousser de petites modifications de code, des correctifs urgents ou des mises à jour de configuration depuis un pipeline CI ou un script de déploiement. Le commit ne redémarre pas l’application par lui-même : après l’envoi de vos modifications, appelez Redémarrer l’application pour que les nouveaux fichiers prennent effet. Pour un premier déploiement d’une nouvelle application, utilisez plutôt Envoyer une application, et pour modifier un seul fichier en place sans le réenvoyer, consultez les endpoints du gestionnaire de fichiers. Les envois sont limités à 100 Mo par fichier. Les noms de fichiers contenant une traversée de répertoire (..), des séparateurs de chemin ou des caractères de contrôle sont rejetés avant toute modification. Sur les applications partagées en workspace, l’appelant doit avoir le rôle Maintainer ou Administrator.

Paramètres

string

requis

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

file

requis

Utilisez FormData ou un Buffer NodeJS (fichier unique ou archive compressée [zip])

string

Optionnel. Le répertoire de destination à l’intérieur de l’application. Un .zip est décompressé ici ; tout autre fichier est placé dans path/filename. Par défaut, la racine de l’application.

Réponse

string

Indique si l’appel a réussi. success en cas de succès, error sinon.

{
    "status": "success"
}

Erreurs courantes

Code	HTTP	Signification
`INVALID_CONTENT_TYPE`	415	Le corps de la requête n’est pas `multipart/form-data`.
`INVALID_FILE`	400	Aucun champ de fichier n’a été trouvé dans les données du formulaire.
`INVALID_FILENAME`	400	Le nom du fichier contient des séparateurs de chemin, `..` ou des caractères de contrôle.
`INVALID_PATH`	400	Le paramètre de requête `path` contient une traversée de répertoire ou des métacaractères shell.
`FILE_TOO_LARGE`	413	L’envoi a dépassé la limite de 100 Mo par fichier.

Supprimer une applicationRetirez votre application de Square Cloud.

Commiter une application

curl --request POST \
  --url https://api.squarecloud.app/v2/apps/{app_id}/commit \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://api.squarecloud.app/v2/apps/{app_id}/commit"

payload = {}
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({})
};

fetch('https://api.squarecloud.app/v2/apps/{app_id}/commit', 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}/commit",
  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([
    
  ]),
  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}/commit"

	payload := strings.NewReader("{}")

	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}/commit")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

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

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

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

{
    "status": "success"
}

​Paramètres

​Réponse

​Erreurs courantes

Paramètres

Réponse

Erreurs courantes