Supprimer des variables

DELETE

apps

{app_id}

envs

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

requis

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

Supprime une ou plusieurs variables d’environnement par clé, en laissant toutes les autres variables inchangées. Les clés qui n’existent pas actuellement sont ignorées silencieusement, il est donc sûr d’appeler cet endpoint avec une liste mêlant des noms valides et des noms déjà supprimés. Les applications statiques ne prennent pas en charge les variables d’environnement et renvoient une erreur. Sur les applications partagées en workspace, l’appelant doit avoir le rôle Administrator ou en être propriétaire. La réponse renvoie l’ensemble complet des variables restantes, ce qui permet de confirmer la suppression sans appel séparé à Lister les variables. Pour rajouter des variables ou remplacer l’ensemble complet, consultez Ajouter/Modifier des variables et Écraser les variables.

Paramètres

string

requis

L’ID de l’application.

string[]

requis

Le tableau contenant les clés à supprimer.

Réponse

string

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

object

La clé et la valeur de toutes les variables d’environnement restantes.

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

Erreurs courantes

Code	HTTP	Signification
`STATIC_APP_ENV_NOT_SUPPORTED`	400	L’application est statique ; les applications statiques ne prennent pas en charge les variables d’environnement.
`INVALID_ENV_CONTENT`	400	`envs` est manquant, n’est pas un tableau, ou est vide.
`ENV_NAME_TOO_LONG`	400	Une clé dans `envs` n’est pas une chaîne de caractères ou dépasse 1024 caractères.

Lire un fichierLire un fichier de votre application.

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

​Paramètres

​Réponse

​Erreurs courantes

Paramètres

Réponse

Erreurs courantes