Crear/Modificar archivo

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

requerido

La clave de API de tu cuenta. Puedes encontrarla en la configuración de tu cuenta.

Crear/Modificar archivo escribe content en path dentro de una aplicación en ejecución, creando el archivo si no existe o sobrescribiéndolo si ya existe. content acepta una cadena UTF-8 para archivos de texto, o un array de bytes { type: "Buffer", data: number[] } para contenido binario. Úsalo para ediciones pequeñas y puntuales, como ajustar un valor de configuración o incorporar un archivo generado, sin volver a subir toda la aplicación; para cambios masivos o un .zip, usa en su lugar Enviar Commit a la Aplicación. Escribir en squarecloud.app o squarecloud.config se trata de forma especial: la plataforma lo interpreta como la configuración de la aplicación (nombre visible, descripción, memoria, autorestart, subdominio) y valida cada campo; un valor inválido devuelve un código de error específico (por ejemplo INVALID_MEMORY o INVALID_SUBDOMAIN) en lugar de escribir el archivo. Estas reescrituras de configuración están limitadas a 1 solicitud cada 15 segundos por usuario. En aplicaciones compartidas en un workspace, quien llama necesita el rol de Maintainer o Administrador, y los miembros sin el permiso de archivos restringidos no pueden escribir en rutas excluidas como .env. Al igual que otras rutas del administrador de archivos, esto no reinicia la aplicación; llama a Reiniciar aplicación para aplicar cambios que requieran un proceso nuevo.

Parámetros

string

requerido

El ID de la aplicación. Puedes encontrarlo en la URL del panel de tu aplicación.

string

requerido

La ruta donde se debe crear el archivo. Ejemplo: /test.txt

string

requerido

El contenido del archivo que se va a crear.

Respuesta

string

Indica si la llamada fue exitosa. success si fue exitosa, error si no.

{
    "status": "success"
}

Errores comunes

Código	HTTP	Significado
`INVALID_PATH`	400	El campo `path` falló la validación.
`INVALID_CONTENT`	400	`content` falta o está vacío.
`INVALID_DISPLAY_NAME` / `INVALID_DESCRIPTION` / `INVALID_MEMORY` / `INVALID_AUTORESTART` / `INVALID_SUBDOMAIN`	400	Un campo interpretado a partir de una escritura en `squarecloud.app`/`squarecloud.config` falló la validación.
`CANNOT_SET_SUBDOMAIN`	400	La configuración interpretada intentó establecer un subdominio que el plan o la cuenta no pueden usar.
`BLOCKED_PATH`	403	Quien llama no tiene el permiso de workspace para escribir en un archivo restringido.
`SAVE_FAILED`	500	No se pudo persistir la actualización de configuración interpretada.

Mover archivoMueve un archivo en tu aplicación.

Crear/Modificar archivo

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

​Respuesta

​Errores comunes

Parámetros

Respuesta

Errores comunes