Environment variables

Pxxl returns names and metadata for stored secrets. It does not return secret values from list calls.

Variable input

string

required

Project receiving the variables.

array

required

Array of variable objects.

string

required

Environment variable name.

string

required

Value encrypted by Pxxl.

boolean

default:"true"

Marks the value as sensitive.

boolean

default:"false"

Applies the variables to every service in the project.

boolean

default:"false"

Removes remote keys missing from vars instead of merging.

Compare variables

Node.js
Go
Python
Rust

const vars = [
  { key: "API_URL", value: "https://api.example.com", isSecret: false },
  { key: "API_TOKEN", value: process.env.API_TOKEN!, isSecret: true },
];

const diff = await pxxl.env.diff("proj_123", vars);

input := map[string]any{"vars": []map[string]any{
  {"key": "API_URL", "value": "https://api.example.com", "isSecret": false},
}}
diff, err := client.DiffProjectEnv(ctx, "proj_123", false, input)

values = {"vars": [
    {"key": "API_URL", "value": "https://api.example.com", "isSecret": False}
]}
diff = client.diff_project_env("proj_123", values)

let values = json!({"vars": [
    {"key": "API_URL", "value": "https://api.example.com", "isSecret": false}
]});
let diff = client.diff_project_env("proj_123", false, values).await?;

Returns

{
  "success": true,
  "projectId": "proj_123",
  "scope": "project",
  "counts": { "same": 1, "changed": 1, "missingRemote": 0, "missingLocal": 0 },
  "diff": [
    {
      "key": "API_TOKEN",
      "status": "changed",
      "local": true,
      "remote": true,
      "same": false,
      "localHash": "sha256:...",
      "remoteHash": "sha256:..."
    }
  ]
}

Push variables

const result = await pxxl.env.push("proj_123", vars, {
  global: false,
  replace: false,
});

{
  "success": true,
  "projectId": "proj_123",
  "scope": "project",
  "created": 1,
  "updated": 1,
  "deleted": 0
}

Environment operations

Operation	Node.js	Parameters	Returns
List	`env.list(projectId, options?)`	`global?`	Variable names and metadata
Diff	`env.diff(projectId, vars, options?)`	`vars`, `global?`	Diff object shown above
Push	`env.push(projectId, vars, options?)`	`vars`, `global?`, `replace?`	Applied change counts

replace: true removes remote keys that are not in the submitted array. Run diff first.

SDK

CLI

API

Environment variables

Variable input

Compare variables

Push variables

Environment operations

​Variable input

​Compare variables

​Push variables

​Environment operations

Variable input

Compare variables

Push variables

Environment operations