API reference
Every endpoint of the Reminix API, by area. Each one shows the same call in TypeScript, Python, the CLI and curl, with its fields.
- To try a call in your browser, use the interactive reference.
- For tools that read OpenAPI, the document is at https://api.reminix.com/v1/openapi.json.
- Before your first call, see Authentication and Errors and rate limits.
Scripts
Section titled “Scripts”- Archive a script:
reminix.scripts.archive() - Create a script:
reminix.scripts.create() - Get a script:
reminix.scripts.get() - List scripts:
reminix.scripts.list() - Restore an archived script:
reminix.scripts.restore() - Change a script:
reminix.scripts.update()
- Cancel a run:
reminix.runs.cancel() - Run a script:
reminix.runs.create() - Get a run:
reminix.runs.get() - List runs:
reminix.runs.list() - Get a run’s log:
reminix.runs.logs()
Versions
Section titled “Versions”- Upload a version:
reminix.scriptVersions.create() - List a script’s versions:
reminix.scriptVersions.list() - Publish a version:
reminix.scriptVersions.publish() - Test-run a version:
reminix.scriptVersions.run()
Schedules
Section titled “Schedules”- Schedule a script:
reminix.schedules.create() - Delete a schedule:
reminix.schedules.delete() - List a script’s schedules:
reminix.schedules.list() - Change a schedule:
reminix.schedules.update()
Triggers
Section titled “Triggers”- Run a script on an event:
reminix.triggers.create() - Delete a trigger:
reminix.triggers.delete() - List a script’s triggers:
reminix.triggers.list() - Change a trigger:
reminix.triggers.update()
- Download a file:
reminix.files.download() - Get a file:
reminix.files.get() - List files:
reminix.files.list() - Upload a file:
reminix.files.upload()
Environments
Section titled “Environments”- Add an environment:
reminix.environments.create() - Delete an environment:
reminix.environments.delete() - Get an environment:
reminix.environments.get() - List environments:
reminix.environments.list() - Change an environment:
reminix.environments.update()
Secrets
Section titled “Secrets”- Delete a secret:
reminix.secrets.delete() - List secrets:
reminix.secrets.list() - Save a secret:
reminix.secrets.set() - Remove a secret’s value from an environment:
reminix.secrets.unset()
Script settings
Section titled “Script settings”- Get the workspace’s script settings:
reminix.scriptSettings.get() - Change the workspace’s script settings:
reminix.scriptSettings.update()
Workspace
Section titled “Workspace”- Get the current workspace:
reminix.workspace.get() - List pending invitations:
reminix.workspace.invitations.list() - List workspace members:
reminix.workspace.members.list() - List teams:
reminix.workspace.teams.list() - Get your plan’s usage this period:
reminix.workspace.usage()
Webhooks
Section titled “Webhooks”- List event types:
reminix.workspace.eventTypes.list() - List an endpoint’s deliveries:
reminix.workspace.webhookDeliveries.list() - Redeliver an event:
reminix.workspace.webhookDeliveries.redeliver() - Add a webhook endpoint:
reminix.workspace.webhookEndpoints.create() - Remove a webhook endpoint:
reminix.workspace.webhookEndpoints.delete() - Re-enable a webhook endpoint:
reminix.workspace.webhookEndpoints.enable() - Get a webhook endpoint:
reminix.workspace.webhookEndpoints.get() - List webhook endpoints:
reminix.workspace.webhookEndpoints.list() - Send a test event:
reminix.workspace.webhookEndpoints.test()
Approvals
Section titled “Approvals”- List the actions you can ask approval for:
reminix.workspace.approvalActions.list() - Ask a person to approve an action:
reminix.workspace.approvalRequests.create() - Check an approval request:
reminix.workspace.approvalRequests.get() - Redeem an approved request:
reminix.workspace.approvalRequests.redeem()
Audit events
Section titled “Audit events”- List workspace audit events:
reminix.workspace.auditEvents.list()
Personal access tokens
Section titled “Personal access tokens”- Get the current user:
reminix.user.me() - Revoke the token making this request:
reminix.user.revokeToken()