Commit files to an 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

required

The API key for your account. You can find this in your account settings.

Requires an API key with the apps:deploy scope. Commit streams a single file or a .zip archive into an existing application without recreating it. A .zip is unpacked at the destination directory, while any other file is written as-is. This makes it the fastest way to push small code changes, hotfixes, or configuration updates from a CI pipeline or deploy script. Committing does not restart the application by itself: after sending your changes, call Restart Application so the new files take effect. For a first deployment of a new application, use Upload Application instead, and to edit a single file in place without re-uploading, see the File Manager endpoints. Uploads are limited to 100 MB per file. The request body is limited to 101 MB (a file of up to 100 MB plus form overhead): a larger request is rejected with 413 FILE_TOO_LARGE while it is still uploading. Only the first file part is read; additional form fields are ignored. File names containing path traversal (..), path separators, or control characters are rejected before any change is applied. On workspace-shared applications, the caller needs the maintain or admin role.

Parameters

string

required

The ID of the application. You can find this in the URL of your application’s dashboard.

file

required

Use FormData or NodeJS Buffer (single file or compress [zip])

string

Optional. The destination directory inside the application. A .zip is unpacked here; any other file is placed at path/filename. Defaults to the application root.

Response

string

Indicates whether the call was successful: success if it was, error if not.

{
    "status": "success"
}

Common errors

Code	HTTP	Meaning
`INVALID_CONTENT_TYPE`	415	The request body is not `multipart/form-data`.
`INVALID_FILE`	400	No file field was found in the form data.
`INVALID_FILENAME`	400	The file name contains path separators, `..`, or control characters.
`INVALID_PATH`	400	The `path` query parameter contains traversal or shell metacharacters.
`COMMIT_FAILED`	400	The commit could not be applied to the application; retry, and check the archive if it repeats.
`FILE_TOO_LARGE`	413	The file exceeded 100 MB or the request body exceeded 101 MB.
`UPLOAD_BUSY`	503	Too many uploads are being processed right now; retry in a moment.

CLI: squarecloud commit
SDKs: api.apps.commit() (JavaScript), client.apps.commit() (Python), c.Apps.Commit() (Go)

Commit files to an 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"
}

Get started

Account

Applications

Databases

Workspaces

AI

Commit files to an application

Parameters

Response

Common errors

​Parameters

​Response

​Common errors

​Related

Parameters

Response

Common errors

Related