Commit Applicazione - Square Cloud

POST

apps

{app_id}

commit

Commit Applicazione

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

obbligatorio

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

Commit trasmette in streaming un singolo file o un archivio .zip in un’applicazione esistente senza ricrearla. Uno .zip viene decompresso nella directory di destinazione, mentre qualsiasi altro file viene scritto così com’è. Questo lo rende il modo più veloce per inviare piccole modifiche al codice, hotfix o aggiornamenti di configurazione da una pipeline CI o da uno script di deploy. Il commit non riavvia automaticamente l’applicazione: dopo aver inviato le modifiche, chiama Riavvia Applicazione affinché i nuovi file abbiano effetto. Per il primo deploy di una nuova applicazione, usa invece Carica Applicazione; per modificare un singolo file sul posto senza ricaricare tutto, consulta gli endpoint del File Manager. I caricamenti sono limitati a 100 MB per file. I nomi dei file contenenti path traversal (..), separatori di percorso o caratteri di controllo vengono rifiutati prima che venga applicata qualsiasi modifica. Sulle applicazioni condivise in un workspace, chi effettua la richiesta deve avere il ruolo di Maintainer o Administrator.

Parametri

string

obbligatorio

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

file

obbligatorio

Usa FormData o NodeJS Buffer (singolo file o compresso [zip])

string

Opzionale. La directory di destinazione all’interno dell’applicazione. Un file .zip viene decompresso qui; qualsiasi altro file viene collocato in path/filename. Il valore predefinito è la radice dell’applicazione.

Risposta

string

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

{
    "status": "success"
}

Errori comuni

Codice	HTTP	Significato
`INVALID_CONTENT_TYPE`	415	Il corpo della richiesta non è `multipart/form-data`.
`INVALID_FILE`	400	Nessun campo file trovato nei dati del form.
`INVALID_FILENAME`	400	Il nome del file contiene separatori di percorso, `..` o caratteri di controllo.
`INVALID_PATH`	400	Il parametro di query `path` contiene path traversal o metacaratteri di shell.
`FILE_TOO_LARGE`	413	Il caricamento ha superato il limite di 100 MB per file.

Elimina ApplicazioneRimuovi la tua applicazione da Square Cloud.

Commit Applicazione

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

​Parametri

​Risposta

​Errori comuni

Parametri

Risposta

Errori comuni