Agregar o editar variables de entorno

POST

apps

{app_id}

envs

Agregar o editar variables de entorno

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

import requests

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

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

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

print(response.text)

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

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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'envs' => [
        
    ]
  ]),
  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}")

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

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

{
  "status": "success",
  "response": {
    "TEST": "myTest"
  }
}

string

requerido

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

Requiere una clave de API con el scope envs:write. Escribir no da acceso de lectura: sin envs:read, la respuesta nunca incluye variables que la solicitud no envió. Usa este endpoint para agregar nuevas variables de entorno o actualizar algunas específicas sin tocar el resto. Las variables existentes que no se incluyan en el cuerpo de la solicitud permanecen intactas, lo que lo convierte en la opción más segura para cambios incrementales, como rotar una sola API key. Las aplicaciones estáticas no admiten variables de entorno y devuelven un error. El conjunto completo tiene un límite de 256 variables por aplicación, con un máximo de 1024 caracteres por clave y 4096 caracteres por valor (las comillas añadidas a su alrededor no cuentan). En aplicaciones compartidas en un workspace, quien llama necesita el rol admin o ser el propietario. Tu aplicación carga sus variables con un shell, así que un valor con espacios o caracteres de shell (como & o ;) se guarda entre comillas simples, como hace el dashboard, y se devuelve así; un valor que ya pusiste entre comillas se mantiene tal como lo enviaste. Una referencia a otra variable ($HOST, ${HOST}, sola o dentro de comillas dobles) sigue funcionando, mientras que la sustitución de comandos ($(...) o comillas invertidas) siempre se guarda como texto plano. Los nombres usan letras, dígitos, guiones bajos, puntos y guiones, y no empiezan con un dígito. Para reemplazar todo el conjunto de variables en lugar de fusionarlo, usa Sobrescribir Variables. Para eliminar claves específicas, consulta Eliminar variables, y para leer los valores actuales, consulta Listar Variables.

Parámetros

string

requerido

El ID de la aplicación.

object

requerido

La clave y el valor de las variables de entorno.

Respuesta

string

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

object

Todas las variables de entorno de la aplicación después del cambio. Una clave de API sin el scope envs:read recibe de vuelta solo las variables que envió en esta solicitud.

{
  "status": "success",
  "response": {
    "TEST": "myTest"
  }
}

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 objeto, o es un array, o un nombre de variable no es válido.
`TOO_MANY_ENV_VARS`	400	El conjunto combinado superaría las 256 variables de entorno.
`ENV_NAME_TOO_LONG`	400	Una clave de variable supera los 1024 caracteres.
`ENV_CONTENT_TOO_LONG`	400	Un valor de variable supera los 4096 caracteres.

Relacionado

CLI: squarecloud app env set
SDKs: api.apps.envs.set() (JavaScript), client.apps.envs.set() (Python), c.Apps.Envs.Set() (Go)

Agregar o editar variables de entorno

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

import requests

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

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

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

print(response.text)

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

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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'envs' => [
        
    ]
  ]),
  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}")

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

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

{
  "status": "success",
  "response": {
    "TEST": "myTest"
  }
}

Primeros pasos

Cuenta

Aplicaciones

Bases de datos

Workspaces

IA

Agregar o editar variables de entorno

Parámetros

Respuesta

Errores comunes

Relacionado

​Parámetros

​Respuesta

​Errores comunes

​Relacionado

Parámetros

Respuesta

Errores comunes

Relacionado