API Reference
Getting Started
Core Concepts
Backend API — Guides
Frontend API — Guides
OAuth & OpenID Connect — Guides
Enterprise: SSO & SCIM — Guides
Webhooks — Guides
SDKs
Backend API (BAPI)
Frontend API (FAPI)
Dashboard API
Public API
SCIM
OIDC
Platform

Actions

AdminUpdated Sep 11, 2026

Actions

Dashboard API — authenticated by an Atlas console (platform-instance) session, not a key.

7 routes. Each row is one endpoint with its explanation and whether it honours the Idempotency-Key header.

Method & path

Idem

Explanation

GET /v1/dashboard/accounts/:accountId/instances/:instanceId/actions

List the instance Actions (tenant code that runs at auth-pipeline triggers). Secret values never returned.

POST /v1/dashboard/accounts/:accountId/instances/:instanceId/actions

Create an Action (name, trigger, code, secrets). Owner/admin only; secrets are write-only.

PATCH /v1/dashboard/accounts/:accountId/instances/:instanceId/actions/:id

Update an Action’s name, code, enabled state or secrets. Owner/admin only.

DELETE /v1/dashboard/accounts/:accountId/instances/:instanceId/actions/:id

Delete an Action; its trigger bindings cascade so it stops running everywhere. Owner/admin only.

POST /v1/dashboard/accounts/:accountId/instances/:instanceId/actions/:id/test

Dry-run an Action against a sample event in the sandbox; touches no real data. Owner/admin only.

GET /v1/dashboard/accounts/:accountId/instances/:instanceId/actions/bindings/:trigger

The ordered pipeline of Actions bound to a trigger (the flow).

PUT /v1/dashboard/accounts/:accountId/instances/:instanceId/actions/bindings/:trigger

Set the ordered pipeline of Actions for a trigger (reorder/add/remove). Owner/admin only.

Was this page helpful?