Secrets

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 secrets

GET /v1/secrets

The workspace’s secrets by name, with the environments that have a value and the hosts each value may be sent to — never the values.

TypeScript

await reminix.secrets.list();

Python

reminix.secrets.list()

CLI

reminix secrets list

curl

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

Save a secret

PUT /v1/secrets/{name}

Saves the secret’s value in the request’s environment: creates it, or replaces the value and its hosts (rotation).

TypeScript

await reminix.secrets.set("ADMIN_KEY", {
  value: "<value>",
  hosts: [
    "api.yourapp.com",
  ],
});

Python

reminix.secrets.set(
    "ADMIN_KEY",
    value="<value>",
    hosts=["api.yourapp.com"],
)

CLI

reminix secrets set \
  ADMIN_KEY \
  --value '<value>' \
  --hosts '["api.yourapp.com"]'

curl

curl -X PUT "https://api.reminix.com/v1/secrets/ADMIN_KEY" \
  -H "Authorization: Bearer $REMINIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"value":"<value>","hosts":["api.yourapp.com"]}'

Field	Description
namestring, path, required
valuestring, required	The secret itself.
hostsarray, required
allowEnvboolean	Let scripts read it as a plain value. Default false — attached to requests only.

More about this endpoint

The value is encrypted and never returned by any call. hosts are the ONLY hosts that value is ever sent to — a script cannot send it anywhere else. Workspace owners and admins, or a workspace API key.

Delete a secret

DELETE /v1/secrets/{name}

Deletes it and its value in every environment; runs of scripts that use it fail until it is saved again.

TypeScript

await reminix.secrets.delete("ADMIN_KEY");

Python

reminix.secrets.delete("ADMIN_KEY")

CLI

reminix secrets delete ADMIN_KEY --yes

curl

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

Field	Description
namestring, path, required

More about this endpoint

Workspace owners and admins, or a workspace API key.

Remove a secret’s value from an environment

DELETE /v1/secrets/{name}/values/{environment}

Removes the value in that environment only; the secret and its other values stay.

TypeScript

await reminix.secrets.unset("ADMIN_KEY", "staging");

Python

reminix.secrets.unset("ADMIN_KEY", "staging")

CLI

reminix secrets unset ADMIN_KEY staging --yes

curl

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

Field	Description
namestring, path, required
environmentstring, path, required

More about this endpoint

Runs there that use it fail until a value is saved again. Workspace owners and admins, or a workspace API key.