Excluir arquivo - Square Cloud

DELETE

apps

{app_id}

files

Excluir arquivo

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

import requests

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

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

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

print(response.text)

const options = {
  method: 'DELETE',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({path: '<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 => "DELETE",
  CURLOPT_POSTFIELDS => json_encode([
    'path' => '<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}")

	req, _ := http.NewRequest("DELETE", 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.delete("https://api.squarecloud.app/v2/apps/{app_id}/files")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"path\": \"<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::Delete.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"path\": \"<string>\"\n}"

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.

Excluir arquivo remove um único arquivo de uma aplicação em execução pelo caminho, sem afetar o restante da árvore de arquivos ou reiniciar o processo. Use-o para limpar arquivos gerados, logs antigos ou uploads perdidos sem precisar reimplantar. A exclusão acontece diretamente no armazenamento da aplicação no nó do cluster, então ela tem efeito imediato; não há como desfazer, exceto restaurando a partir de um snapshot anterior. Para remover uma aplicação inteira em vez de um arquivo, veja Excluir aplicação. Para renomear ou mover um arquivo em vez de excluí-lo, use Mover arquivo. Em aplicações compartilhadas em workspace, quem chama precisa da função Mantenedor ou Administrador. Membros sem a permissão de arquivos restritos não podem excluir arquivos da lista de exclusão (como .env ou .env.production); a requisição é rejeitada primeiro com PERMISSION_DENIED.

Parâmetros

app_id

string

obrigatório

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

path

string

obrigatório

O caminho do arquivo a ser excluído.

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_PATH`	400	O campo `path` falhou na validação (travessia, caracteres inválidos ou muito longo).
`DELETE_FAILED`	400	O cluster não conseguiu excluir o arquivo.
`PERMISSION_DENIED`	403	Quem chama não tem a permissão de workspace para excluir um arquivo restrito.

Listar implantaçõesObter as últimas 10 implantações de uma aplicação nas últimas 24 horas.

Excluir arquivo

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

import requests

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

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

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

print(response.text)

const options = {
  method: 'DELETE',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({path: '<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 => "DELETE",
  CURLOPT_POSTFIELDS => json_encode([
    'path' => '<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}")

	req, _ := http.NewRequest("DELETE", 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.delete("https://api.squarecloud.app/v2/apps/{app_id}/files")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"path\": \"<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::Delete.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"path\": \"<string>\"\n}"

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

{
    "status": "success"
}

​Parâmetros

​Resposta

​Erros comuns

Parâmetros

Resposta

Erros comuns