Listar variables de entorno

GET

apps

{app_id}

envs

Listar variables de entorno

curl --request GET \
  --url https://api.squarecloud.app/v2/apps/{app_id}/envs \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

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::Get.new(url)
request["Authorization"] = '<authorization>'

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:read. Devuelve las variables de entorno actuales de la aplicación como un objeto plano de clave-valor, leído directamente desde su archivo .env en el clúster. Si aún no se ha definido ninguna variable, la respuesta es exitosa con un objeto vacío en lugar de un error. Las aplicaciones estáticas no admiten variables de entorno y devuelven un error en su lugar. En aplicaciones compartidas en un workspace, quien llama necesita el rol admin o ser el propietario. Para agregar o actualizar variables, usa Agregar/Editar Variables; para reemplazar todo el conjunto, consulta Sobrescribir Variables.

Parámetros

string

requerido

El ID de la aplicación.

Respuesta

string

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

object

La clave y el valor de todas las variables de entorno que definiste.

{
  "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.
`READ_FAILED`	400	No se pudo leer el archivo `.env` desde el clúster.

Relacionado

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

Listar variables de entorno

curl --request GET \
  --url https://api.squarecloud.app/v2/apps/{app_id}/envs \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

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::Get.new(url)
request["Authorization"] = '<authorization>'

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

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

Primeros pasos

Cuenta

Aplicaciones

Bases de datos

Workspaces

IA

Listar variables de entorno

Parámetros

Respuesta

Errores comunes

Relacionado

​Parámetros

​Respuesta

​Errores comunes

​Relacionado

Parámetros

Respuesta

Errores comunes

Relacionado