Update env var - Cargo | GTM Infrastructure for AI Agents

Update env var

curl --request PATCH \
  --url https://api.getcargo.io/v1/hosting/env-vars/{uuid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "value": "<string>",
  "isSecret": true
}
'

import requests

url = "https://api.getcargo.io/v1/hosting/env-vars/{uuid}"

payload = {
    "value": "<string>",
    "isSecret": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({value: '<string>', isSecret: true})
};

fetch('https://api.getcargo.io/v1/hosting/env-vars/{uuid}', 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.getcargo.io/v1/hosting/env-vars/{uuid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'value' => '<string>',
    'isSecret' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.getcargo.io/v1/hosting/env-vars/{uuid}"

	payload := strings.NewReader("{\n  \"value\": \"<string>\",\n  \"isSecret\": true\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.patch("https://api.getcargo.io/v1/hosting/env-vars/{uuid}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"value\": \"<string>\",\n  \"isSecret\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getcargo.io/v1/hosting/env-vars/{uuid}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"value\": \"<string>\",\n  \"isSecret\": true\n}"

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

{
  "envVar": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workspaceUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "key": "<string>",
    "value": "<string>",
    "isSecret": true,
    "userUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "deletedAt": "<string>",
    "kind": "app",
    "appUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

PATCH

hosting

env-vars

{uuid}

Update env var

curl --request PATCH \
  --url https://api.getcargo.io/v1/hosting/env-vars/{uuid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "value": "<string>",
  "isSecret": true
}
'

import requests

url = "https://api.getcargo.io/v1/hosting/env-vars/{uuid}"

payload = {
    "value": "<string>",
    "isSecret": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({value: '<string>', isSecret: true})
};

fetch('https://api.getcargo.io/v1/hosting/env-vars/{uuid}', 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.getcargo.io/v1/hosting/env-vars/{uuid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'value' => '<string>',
    'isSecret' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.getcargo.io/v1/hosting/env-vars/{uuid}"

	payload := strings.NewReader("{\n  \"value\": \"<string>\",\n  \"isSecret\": true\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.patch("https://api.getcargo.io/v1/hosting/env-vars/{uuid}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"value\": \"<string>\",\n  \"isSecret\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getcargo.io/v1/hosting/env-vars/{uuid}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"value\": \"<string>\",\n  \"isSecret\": true\n}"

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

{
  "envVar": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workspaceUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "key": "<string>",
    "value": "<string>",
    "isSecret": true,
    "userUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "deletedAt": "<string>",
    "kind": "app",
    "appUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

{
  "errorMessage": "<string>",
  "reason": "<string>"
}

Authorizations

Authorization

string

header

required

API token from cargo-ai login. Send as Authorization: Bearer <token>.

Headers

Idempotency-Key

string

Client-generated key that makes this write safe to retry. Reusing the same key with the same request returns the original response instead of creating a second record. Reusing it with a different request returns 422. A concurrent retry while the first request is still running returns 409. Keys expire after 24 hours. Not accepted on multipart file uploads. Optional: a request without one is processed as it always was.

Maximum string length: 255

Example:

"8e03978e-40d5-43e8-bc93-6894a57f9324"

Path Parameters

uuid

string<uuid>

required

Identifier of the environment variable to update.

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json

Request body schema.

value

string

required

Environment variable value.

Maximum string length: 8192

isSecret

boolean

required

Worker variables only. When true, the value is encrypted at rest and never returned by the API. App variables are compiled into the app's publicly served bundle, so they cannot be secret and true is rejected for them.

Response

Update env var

envVar

Environment variable · object

required

Updated environment variable.

Environment variable
Environment variable

Show child attributes