Eliminar variables - Square Cloud

DELETE

apps

{app_id}

envs

Eliminar variables

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

import requests

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

payload = { "envs": ["<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({envs: ['<string>']})
};

fetch('https://api.squarecloud.app/v2/apps/{app_id}/envs', 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}/envs",
  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([
    'envs' => [
        '<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}/envs"

	payload := strings.NewReader("{\n  \"envs\": [\n    \"<string>\"\n  ]\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}/envs")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"envs\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"envs\": [\n    \"<string>\"\n  ]\n}"

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

{
  "status": "success",
  "response": {
    "REMAINING": "secret"
  }
}

string

requerido

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

Elimina una o más variables de entorno por clave, dejando intactas todas las demás. Las claves que no existen actualmente se ignoran de forma silenciosa, por lo que es seguro llamarlo con una lista que combine nombres válidos y ya eliminados. Las aplicaciones estáticas no admiten variables de entorno y devuelven un error. En aplicaciones compartidas en un workspace, quien llama necesita el rol de Administrador o ser el propietario. La respuesta devuelve el conjunto completo de variables restantes, por lo que puedes confirmar la eliminación sin necesidad de una llamada separada a Listar Variables. Para volver a agregar variables o reemplazar todo el conjunto, consulta Agregar/Editar Variables y Sobrescribir Variables.

Parámetros

string

requerido

El ID de la aplicación.

string[]

requerido

El array que contiene las claves a eliminar.

Respuesta

string

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

object

La clave y el valor de todas las variables de entorno restantes.

{
  "status": "success",
  "response": {
    "REMAINING": "secret"
  }
}

Errores comunes

Código	HTTP	Significado
`STATIC_APP_ENV_NOT_SUPPORTED`	400	La aplicación es estática; las aplicaciones estáticas no admiten variables de entorno.
`INVALID_ENV_CONTENT`	400	`envs` falta, no es un array, o está vacío.
`ENV_NAME_TOO_LONG`	400	Una clave en `envs` no es una cadena o supera los 1024 caracteres.

Leer archivoLee un archivo de tu aplicación.

Eliminar variables

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

import requests

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

payload = { "envs": ["<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({envs: ['<string>']})
};

fetch('https://api.squarecloud.app/v2/apps/{app_id}/envs', 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}/envs",
  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([
    'envs' => [
        '<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}/envs"

	payload := strings.NewReader("{\n  \"envs\": [\n    \"<string>\"\n  ]\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}/envs")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"envs\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"envs\": [\n    \"<string>\"\n  ]\n}"

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

{
  "status": "success",
  "response": {
    "REMAINING": "secret"
  }
}

​Parámetros

​Respuesta

​Errores comunes

Parámetros

Respuesta

Errores comunes