Criar/modificar arquivo

PUT

apps

{app_id}

files

curl --request PUT \
  --url https://api.squarecloud.app/v2/apps/{app_id}/files \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "path": "<string>",
  "content": "<string>"
}
'

import requests

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

payload = {
    "path": "<string>",
    "content": "<string>"
}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({path: '<string>', content: '<string>'})
};

fetch('https://api.squarecloud.app/v2/apps/{app_id}/files', 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}/files",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'path' => '<string>',
    'content' => '<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}/files"

	payload := strings.NewReader("{\n  \"path\": \"<string>\",\n  \"content\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.squarecloud.app/v2/apps/{app_id}/files")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"path\": \"<string>\",\n  \"content\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"path\": \"<string>\",\n  \"content\": \"<string>\"\n}"

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

{
    "status": "success"
}

string

obrigatório

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

Criar/modificar arquivo grava content em path dentro de uma aplicação em execução, criando o arquivo se ele não existir ou sobrescrevendo-o se existir. content aceita uma string UTF-8 para arquivos de texto ou um array de bytes { type: "Buffer", data: number[] } para conteúdo binário. Use-o para edições pequenas e pontuais, como ajustar um valor de configuração ou inserir um arquivo gerado, sem reenviar toda a aplicação; para alterações em massa ou um .zip, use Enviar commit da aplicação. Gravar em squarecloud.app ou squarecloud.config é tratado de forma especial: a plataforma interpreta o conteúdo como a configuração da aplicação (nome de exibição, descrição, memória, autorestart, subdomínio) e valida cada campo; um valor inválido retorna um código de erro específico (por exemplo, INVALID_MEMORY ou INVALID_SUBDOMAIN) em vez de gravar o arquivo. Essas regravações de configuração são limitadas a 1 requisição a cada 15 segundos por usuário. Em aplicações compartilhadas em workspace, quem chama precisa da função Mantenedor ou Administrador, e membros sem a permissão de arquivos restritos ficam bloqueados de gravar em caminhos excluídos como .env. Assim como outras rotas do gerenciador de arquivos, isso não reinicia a aplicação; chame Reiniciar aplicação para aplicar alterações que exijam um processo novo.

Parâmetros

string

obrigatório

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

string

obrigatório

O caminho onde o arquivo deve ser criado. Exemplo: /test.txt

string

obrigatório

O conteúdo do arquivo a ser criado.

Resposta

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_PATH`	400	O campo `path` falhou na validação.
`INVALID_CONTENT`	400	`content` está ausente ou vazio.
`INVALID_DISPLAY_NAME` / `INVALID_DESCRIPTION` / `INVALID_MEMORY` / `INVALID_AUTORESTART` / `INVALID_SUBDOMAIN`	400	Um campo interpretado a partir de uma gravação em `squarecloud.app`/`squarecloud.config` falhou na validação.
`CANNOT_SET_SUBDOMAIN`	400	A configuração interpretada tentou definir um subdomínio que o plano ou a conta não pode usar.
`BLOCKED_PATH`	403	Quem chama não tem a permissão de workspace para gravar em um arquivo restrito.
`SAVE_FAILED`	500	Não foi possível persistir a atualização da configuração interpretada.

Mover arquivoMover um arquivo na sua aplicação.

Criar/modificar arquivo

curl --request PUT \
  --url https://api.squarecloud.app/v2/apps/{app_id}/files \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "path": "<string>",
  "content": "<string>"
}
'

import requests

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

payload = {
    "path": "<string>",
    "content": "<string>"
}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({path: '<string>', content: '<string>'})
};

fetch('https://api.squarecloud.app/v2/apps/{app_id}/files', 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}/files",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'path' => '<string>',
    'content' => '<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}/files"

	payload := strings.NewReader("{\n  \"path\": \"<string>\",\n  \"content\": \"<string>\"\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.squarecloud.app/v2/apps/{app_id}/files")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"path\": \"<string>\",\n  \"content\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"path\": \"<string>\",\n  \"content\": \"<string>\"\n}"

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

{
    "status": "success"
}

​Parâmetros

​Resposta

​Erros comuns

Parâmetros

Resposta

Erros comuns