Créer/Modifier un fichier

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

requis

La clé d’API de votre compte. Vous pouvez la trouver dans les paramètres de votre compte.

Create/Modify File écrit content dans path à l’intérieur d’une application en cours d’exécution, créant le fichier s’il n’existe pas ou l’écrasant s’il existe déjà. content accepte soit une chaîne UTF-8 pour les fichiers texte, soit un tableau d’octets { type: "Buffer", data: number[] } pour le contenu binaire. Utilisez-le pour des modifications ciblées et de petite taille, comme ajuster une valeur de configuration ou déposer un fichier généré, sans réenvoyer l’application entière ; pour des changements en masse ou un .zip, utilisez plutôt Commiter une application. Écrire dans squarecloud.app ou squarecloud.config est traité de façon particulière : la plateforme l’interprète comme la configuration de l’application (nom d’affichage, description, mémoire, autorestart, sous-domaine) et valide chaque champ, une valeur invalide renvoie un code d’erreur spécifique (par exemple INVALID_MEMORY ou INVALID_SUBDOMAIN) plutôt que d’écrire le fichier. Ces réécritures de configuration sont limitées à 1 requête toutes les 15 secondes par utilisateur. Sur les applications partagées en workspace, l’appelant doit avoir le rôle Maintainer ou Administrator, et les membres sans la permission des fichiers restreints ne peuvent pas écrire dans les chemins exclus comme .env. Comme les autres routes du gestionnaire de fichiers, cela ne redémarre pas l’application, appelez Redémarrer l’application pour appliquer les changements qui nécessitent un processus neuf.

Paramètres

string

requis

L’ID de l’application. Vous le trouverez dans l’URL du dashboard de votre application.

string

requis

Le chemin où le fichier doit être créé. Exemple : /test.txt

string

requis

Le contenu du fichier à créer.

Réponse

string

Indique si l’appel a réussi. success en cas de succès, error sinon.

{
    "status": "success"
}

Erreurs courantes

Code	HTTP	Signification
`INVALID_PATH`	400	Le champ `path` a échoué la validation.
`INVALID_CONTENT`	400	`content` est manquant ou vide.
`INVALID_DISPLAY_NAME` / `INVALID_DESCRIPTION` / `INVALID_MEMORY` / `INVALID_AUTORESTART` / `INVALID_SUBDOMAIN`	400	Un champ analysé depuis une écriture `squarecloud.app`/`squarecloud.config` a échoué la validation.
`CANNOT_SET_SUBDOMAIN`	400	La configuration analysée tentait de définir un sous-domaine que le plan ou le compte ne peut pas utiliser.
`BLOCKED_PATH`	403	L’appelant n’a pas la permission workspace nécessaire pour écrire dans un fichier restreint.
`SAVE_FAILED`	500	La mise à jour de configuration analysée n’a pas pu être persistée.

Déplacer un fichierDéplacer un fichier dans votre application.

Créer/Modifier un fichier

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

​Paramètres

​Réponse

​Erreurs courantes

Paramètres

Réponse

Erreurs courantes