Environments

Set up

TypeScript

npm install @reminix/sdk

import { createClient } from "@reminix/sdk";

const reminix = createClient(); // reads REMINIX_API_KEY

Python

pip install reminix

from reminix import Reminix

reminix = Reminix()  # reads REMINIX_API_KEY

CLI

npm install -g @reminix/cli
reminix login

curl

export REMINIX_API_KEY="<your API key>"

List environments

GET /v1/environments

The workspace’s environments, oldest first, with which is the default.

TypeScript

await reminix.environments.list();

Python

reminix.environments.list()

CLI

reminix environments list

curl

curl -X GET "https://api.reminix.com/v1/environments" \
  -H "Authorization: Bearer $REMINIX_API_KEY"

More about this endpoint

Name one with the X-Environment header to act in it.

Add an environment

POST /v1/environments

Adds an environment with no secret values yet — save them with X-Environment set to it.

TypeScript

await reminix.environments.create({
  name: "staging",
});

Python

reminix.environments.create(name="staging")

CLI

reminix environments create --name staging

curl

curl -X POST "https://api.reminix.com/v1/environments" \
  -H "Authorization: Bearer $REMINIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"staging"}'

Field	Description
namestring, required	Its name, unique in the workspace.
approvalPolicystring	Which runs here wait for a person's approval: none, agents (runs an agent starts) or always. A run uses the stricter of this and its script's policy. Default: none.
agentsAllowedboolean	Whether agents (MCP) may run scripts here, or schedule them to. Default: true.

More about this endpoint

Lowercase letters, digits and dashes. Owners and admins, or a workspace API key.

Get an environment

GET /v1/environments/{environment}

One environment, with what uses it: the secret values deleting it would delete, and the schedules and triggers that keep it from being deleted.

TypeScript

await reminix.environments.get("staging");

Python

reminix.environments.get("staging")

CLI

reminix environments get staging

curl

curl -X GET "https://api.reminix.com/v1/environments/staging" \
  -H "Authorization: Bearer $REMINIX_API_KEY"

Field	Description
environmentstring, path, required

Change an environment

PATCH /v1/environments/{environment}

Renames it, changes its rules, or makes it the workspace’s default (isDefault: true).

TypeScript

await reminix.environments.update("staging");

Python

reminix.environments.update("staging")

CLI

reminix environments update staging

curl

curl -X PATCH "https://api.reminix.com/v1/environments/staging" \
  -H "Authorization: Bearer $REMINIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Field	Description
environmentstring, path, required
namestring	Its name, unique in the workspace.
approvalPolicystring	Which runs here wait for a person's approval: none, agents (runs an agent starts) or always. A run uses the stricter of this and its script's policy.
agentsAllowedboolean	Whether agents (MCP) may run scripts here, or schedule them to.
isDefaultboolean	Make it the default. To change the default, make another one the default.

More about this endpoint

Runs keep the name they ran under. Owners and admins, or a workspace API key.

Delete an environment

DELETE /v1/environments/{environment}

Deletes it and every secret value it holds (GET it first to see how many).

TypeScript

await reminix.environments.delete("staging");

Python

reminix.environments.delete("staging")

CLI

reminix environments delete staging --yes

curl

curl -X DELETE "https://api.reminix.com/v1/environments/staging" \
  -H "Authorization: Bearer $REMINIX_API_KEY"

Field	Description
environmentstring, path, required

More about this endpoint

Refused for the only environment, the default, and one a schedule or trigger runs in. Owners and admins, or a workspace API key.