Enviar commit da aplicação

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

Authorization

string

obrigatório

A chave da API para sua conta. Você pode encontrá-la nas configurações da conta.

O commit transmite um único arquivo ou um arquivo .zip para uma aplicação existente sem recriá-la. Um .zip é descompactado no diretório de destino, enquanto qualquer outro arquivo é gravado como está. Isso torna essa a forma mais rápida de enviar pequenas alterações de código, hotfixes ou atualizações de configuração a partir de um pipeline de CI ou script de deploy. O commit não reinicia a aplicação por conta própria: depois de enviar suas alterações, chame Reiniciar aplicação para que os novos arquivos entrem em vigor. Para o primeiro deploy de uma nova aplicação, use Enviar aplicação; para editar um único arquivo no local sem reenviar tudo, veja os endpoints do Gerenciador de Arquivos. Os envios são limitados a 100 MB por arquivo. Nomes de arquivo contendo path traversal (..), separadores de caminho ou caracteres de controle são rejeitados antes de qualquer alteração ser aplicada. Em aplicações compartilhadas em workspace, quem chamar o endpoint precisa ter o cargo de Mantenedor ou Administrador.

Parâmetros

app_id

string

obrigatório

O ID da aplicação. Você pode encontrá-lo na URL do painel da sua aplicação.

file

obrigatório

Use FormData ou Buffer do NodeJS (arquivo único ou comprimido [zip])

path

string

Opcional. O diretório de destino dentro da aplicação. Um .zip é descompactado aqui; qualquer outro arquivo é colocado em path/nome. O padrão é a raiz da aplicação.

Resposta

status

string

Indica se a chamada foi bem-sucedida. success se bem-sucedida, error se não.

{
    "status": "success"
}

Erros comuns

Código	HTTP	Significado
`INVALID_CONTENT_TYPE`	415	O corpo da requisição não é `multipart/form-data`.
`INVALID_FILE`	400	Nenhum campo de arquivo foi encontrado nos dados do formulário.
`INVALID_FILENAME`	400	O nome do arquivo contém separadores de caminho, `..` ou caracteres de controle.
`INVALID_PATH`	400	O parâmetro de query `path` contém traversal ou metacaracteres de shell.
`FILE_TOO_LARGE`	413	O envio excedeu o limite de 100 MB por arquivo.

Excluir aplicaçãoRemover sua aplicação da Square Cloud.

Enviar commit da aplicação

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

​Parâmetros

​Resposta

​Erros comuns

Parâmetros

Resposta

Erros comuns