Organization
Your organization's profile, email domains, IP allowlist, setup progress, data region, retention windows, SIEM export, staging org, HIPAA warnings, schedule and outcome scan intervals, NodeLinks and their storage, settings, and deleting the organization. These endpoints act on the caller's own organization.
List data regions
Returns the regions an organization may pick and a readable label for every AWS region code. Open to any signed-in user.
Get what deleting the organization needs
Returns what deleting the caller's own organization asks for: its `name`, to type back, and `needs_code`, true when the caller has two-factor verification set up. Requires the Org Owner role (403 for an Org Admin).
Delete own organization
Deletes the caller's own organization: a paid plan ends now with no refund, every node and running task stops, and every member loses access. `name` must match the organization's name (else 422); a caller with two-factor verification also sends a current `code` or recovery code (else 403). Requires the Org Owner role and returns 204.
List NodeLink storage
Lists the organization's NodeLink storages (EFS file systems), each with its AWS facts, `status` and how many NodeLinks use it. Requires permission to view credentials.
List cloud NodeLink storage choices
Lists the clouds whose NodeLink storage a cloud connection places (GCP Filestore, Azure Files), on the organization's plan: each with `min_size_note`, its minimum size and monthly bill, and the organization's `connections` on it the caller can reach. Requires permission to edit credentials.
List existing cloud storage on a connection
Lists what a cloud connection's account has in its region to use as **Existing** NodeLink storage (a Filestore instance, an Azure Files NFS share), each saying whether it is `usable` and, if not, the `problem`. Returns 403 while the plan has that cloud off and 502 with the cloud's message when it refuses the lookup. Requires permission to edit credentials.
List existing EFS file systems
Lists the EFS file systems, access points and mount targets one of the organization's AWS credentials can see in a region, for **Use existing**. Each access point says whether it is `usable` (owner 3000:3000) and, if not, the `problem`. Requires permission to edit credentials; returns 502 with AWS's message when AWS refuses the lookup.
Delete NodeLink storage
Deletes a NodeLink storage no NodeLink uses (409 otherwise; Jaah-managed storage is refused); without `delete_in_cloud` only Jaah's record goes and the file system or instance stays in the cloud, still billed. With it, storage Jaah created (422 for storage it did not) is deleted in the cloud with its files: an EFS file system with its mount targets and security group, or a Filestore instance. Returns 204 once gone, or 202 with the storage `deleting` and `last_error` naming any refusal while the cloud finishes (a repeat call retries); requires permission to edit credentials.
Get NodeLink storage
Returns one NodeLink storage with its AWS facts, `status` and how many NodeLinks use it. Requires permission to view credentials.
Update NodeLink storage
Renames a NodeLink storage, changes its AWS credential, changes the allowed CIDR of storage Jaah creates, or sets the mount target of existing storage (an empty value clears it). Returns 409 for a name in use. Requires permission to edit credentials.
Check NodeLink storage routing
Checks, live from AWS and read-only, whether the storage's mount targets can be routed to: `warning` says why not when they sit inside this environment's own routed network but in another AWS account, and is null otherwise. Returns 409 before a file system exists and 502 when AWS fails. Requires permission to edit credentials.
Get the NodeLink file-system policy
Reads the storage's file-system policy live from AWS, read-only: `policy` is the JSON document as AWS holds it, null when the file system has none. Returns 409 before a file system exists and 502 when AWS fails. Requires permission to edit credentials.
Refresh NodeLink storage from AWS
Re-reads a NodeLink storage's facts from AWS: the file system's ARN, and for storage set up with Use existing, its mount target. Returns the storage; 409 before a file system exists, 422 when AWS no longer has it and 502 when AWS fails. Requires permission to edit credentials.
Repair the NodeLink file-system policy
Rewrites the storage's file-system policy so it admits every live NodeLink's access point on it. Returns the storage with `access_point_count`, how many access points the policy now admits; 409 until a NodeLink on it has an access point and 502 when AWS fails. Requires permission to edit credentials.
List NodeLinks
Lists the organization's NodeLinks, the shared folders nodes mount. Each has its mount path template (`{jaah-home}/โฆ`, resolved on each node), its storage, `status`, `last_error` and the ids of the nodes that mount it. Requires permission to view credentials; only the operator may pass `org_id` to list another organization's, or `all_orgs` to list every organization's, each row then naming its `org`.
Create a NodeLink
Creates a NodeLink with a name, optional description and mount path (default `{jaah-home}/nodelink/<slug>`), `pending` until its storage is set and it is provisioned. Returns it with status 201. Returns 409 for a name in use or an overlapping path, 403 while the plan does not include NodeLink, and needs permission to edit credentials.
Get Jaah-managed storage availability
Says whether a NodeLink can use Jaah-managed storage: `available` is true when every node it is attached to (or, with none attached or no `nodelink_id`, every Linux node of the organization) runs on a machine the Jaah operator runs, all in one `location`, and that location's storage is ready. `reason` says why not. Requires permission to view credentials.
List NodeLink mounts
Lists, in one read, every node attached to each of the organization's NodeLinks with its node name (null once the node is deleted) and its `mount`: `mounted`, `not_mounted`, `needs_permission` (a Mac needs Full Disk Access granted), `unknown` or `not_set_up` (the node has never reported), plus `mount_reason`. Requires permission to view credentials.
Share subscriptions between nodes
Creates a NodeLink named `name` (default `Subscriptions`) at `{jaah-home}/auth/.shared` on `storage`, attaches every Linux node of the organization the caller may attach, or only those of them in `node_ids` (`skipped` lists the rest with a reason), and requests its provisioning, which finishes without another call; a step that fails undoes the create. `consent` must be true, confirming the caller's model provider allows one subscription on several devices, and is recorded in the audit log. Returns 201 with the new NodeLink, or 200 with the organization's existing one at that path and nothing changed; requires permission to edit credentials.
Preview the nodes a share attaches
Lists, without changing anything, the nodes **Share subscriptions** would attach for `storage` (`targets`) and the ones it would skip, each with a reason (`skipped`). Requires permission to edit credentials.
Delete a NodeLink
Deletes a NodeLink or retries a delete in progress: nodes unmount it first, its files stay in the file system, an access point it took from **Use existing** stays in AWS, and storage no NodeLink uses any more is removed from Jaah, unless Jaah created it in the cloud: that stays, still billed, until it is deleted with `delete_store`. Returns 204 once it is gone, or the NodeLink still `deleting` with `last_error` naming any node still holding it after ten minutes or what AWS refused. Requires permission to edit credentials.
Get a NodeLink
Returns one NodeLink with its access point, root folder, whether the file-system policy admits it (`in_policy`) and whether its path sits outside `{jaah-home}/nodelink/` (`shadows_existing`). While it is being deleted, it also lists the nodes it still waits on. Requires permission to view credentials.
Update a NodeLink
Renames a NodeLink, changes its description or moves its mount path, and a new path is re-mounted on every node that mounts it. Returns 409 for a name in use or an overlapping path. Requires permission to edit credentials.
Delete a NodeLink without waiting
Deletes a NodeLink without waiting for the nodes still holding it, which lose access when its access point is removed. Returns 204 once it is gone. Requires permission to edit credentials.
Set a NodeLink's nodes
Sets exactly which of the organization's nodes mount the NodeLink, and each node added or removed mounts or unmounts it straight away. A node of another organization returns 404; adding needs the plan to include NodeLink, while removing always works. Requires the Org Owner or Org Admin role for each node changed.
Provision a NodeLink
Provisions the NodeLink, safe to repeat: storage Jaah creates is built first, then its access point is admitted in the file-system policy, and it returns with its `status`: `ready`, `provisioning` (call again) or `failed` with AWS's message in `last_error`. Returns 409 while another change to the same storage is running or while it is being deleted. Requires permission to edit credentials.
Set a NodeLink's storage
Chooses where a NodeLink lives before its access point exists: one of the organization's storages (`store_id`), new storage Jaah creates (`create`), an existing file system (`existing`) or Jaah-managed storage (`managed`, which starts provisioning at once), plus optionally an existing access point (`access_point_id`, never with `managed`), each existing choice checked against AWS (422 names a mismatch). Returns the NodeLink, or 409 once it has an access point or when Jaah-managed storage is not available. Requires permission to edit credentials and reach to the AWS credential, which Jaah-managed storage does not need.
Get pipeline guardrails
Lists your org's three pipeline rules (Production needs approval, No automatic production, Production pressed by maintainers): each one's mode (off, warn or block), the approvals the first one asks for, who changed it last and when, and the projects whose saved pipeline breaks it today.
Set pipeline guardrail
Sets one org pipeline rule's mode (off, warn or block) and, for Production needs approval, how many approvals the step into production needs (1 to 5). Requires Org Owner or Org Admin. No saved pipeline changes; the rule applies from each project's next save.
List pipeline templates
Lists your org's pipeline templates by name: each one's stage chain, how many projects are linked to it, its state (never published, published, or draft changes) and its published version.
Create pipeline template
Creates a pipeline template, never published. Its draft is the stages and steps sent, else the Standard pipeline, with lock marks saying which fields a linked project may not change. Requires Org Owner or Org Admin; a name already used in your org is refused with 409.
Delete pipeline template
Deletes a pipeline template and its published versions. Requires Org Owner or Org Admin; refused with 409 `template_linked`, naming how many, while projects are linked to it.
Get pipeline template
Gets one pipeline template: its draft (stages, steps and lock marks), its published version, its state and the projects linked to it.
Update pipeline template
Renames or describes a pipeline template, or saves its draft. The draft is checked like a pipeline save (422) and reaches no project until it is published. Requires Org Owner or Org Admin.
Apply pipeline template
Update again: applies a pipeline template's published version to every linked project still on an older one, each as its own save; a project its pipeline save refuses stays on its version and is listed with the reason. Requires Org Owner or Org Admin; 409 before the first publish.
Publish pipeline template
Publishes a pipeline template's draft as its next version and updates the linked projects; a project its pipeline save refuses stays on its version and is listed with the reason. Requires Org Owner or Org Admin; a draft breaking an org pipeline rule set to Block is refused with 422 `guardrail`, and a draft equal to the published version with 409.
Preview pipeline template publish
Shows what publishing a pipeline template's draft would do, without writing anything: each change from the published version (stages added, removed, renamed or moved, each field's old and new value, each lock change), the linked projects it would update, and the org pipeline rules set to Block the template breaks.
Get setup status
Returns the company setup checklist for the caller's organization: whether it is shown and each step's status. Only an Org Owner or Org Admin of a customer organization sees the steps; anyone else gets `visible` false.
Get staging
Returns the caller's organization staging link: its staging org, or the parent it belongs to. Returns 403 while the plan leaves Staging org out. Requires the Org Owner or Org Admin role.
Create staging
Creates the caller's organization staging org: a linked organization on the same plan and bill, whose Owners and Admins follow the parent's. Returns 409 when the organization already has one or is one, and 403 while the plan leaves Staging org out. Requires the Org Owner or Org Admin role.
Sync staging admins
Gives the caller's organization staging org the organization's Owners and Admins again: it adds each one it lacks and removes each copied binding whose holder is no longer one; the same sync runs after every change to them. Returns 404 when the organization has no staging org, 409 from the staging org itself, and 403 while the plan leaves Staging org out. Requires the Org Owner or Org Admin role.
Get organization
Returns one organization with its slug, name, description, enabled state, member count and default role. Requires the Org Owner or Org Admin role, and only the caller's own organization is readable; any other returns 404.
Update organization
Updates only the organization fields sent; omitted fields stay unchanged. Requires the Org Owner or Org Admin role, which may change only the caller's own organization's default role, SSO settings, MicroVM size, Run jobs as and intelligent routing; renaming, describing, enabling or disabling the organization, or changing its isolation, two-factor or HIPAA settings, returns 403 and nothing is saved.
Get minimum schedule period
Returns the shortest interval, in seconds, at which any schedule in the organization may run (`effective`), with the Jaah-set minimum the organization may not go below (`upstream`) and the organization's own value (`own`). Requires the Org Owner or Org Admin role.
Set minimum schedule period
Sets, or clears with `null`, the organization's own minimum schedule interval `own`, in seconds, between the Jaah-set minimum (`upstream`) and 86400; a value outside that range returns 422. Existing schedules are not edited: one running faster is throttled when it fires. Requires the Org Owner or Org Admin role.
Get data region
Returns the organization's data region (`region`, null until chosen), the region its data uses now, the regions it may pick, what stays in the control-plane region, and `locked`: why the region can no longer change, or null. Requires the Org Owner or Org Admin role and Data residency on the plan (else 403).
Set data region
Sets the organization's data region: new cloud connections, NodeLink storage, session transcripts and task files are created there. Refused with 422 for a region not offered, with 409 naming the data once the organization has any in another region, and with 403 without the Org Owner or Org Admin role or Data residency on the plan.
List organization domains
Lists the email domains registered to the organization, alphabetically, with who added each and when. People with an address on these domains may join the organization. Requires the Org Owner or Org Admin role.
Acknowledge HIPAA warning
Records that the organization accepts a HIPAA warning for one integration (`surface`) whose vendor has no BAA with Jaah. Repeating it keeps the first record and returns 204; an unknown surface returns 422, and an organization with HIPAA off returns 409. Requires the Org Owner or Org Admin role.
Get IP ranges
Returns the organization's IP allowlist (each range in CIDR form with its label, who last changed it and when) and `your_ip`, the address the API sees for the caller. An empty list allows every address. Requires the Org Owner or Org Admin role and the IP allowlist on the plan (else 403).
Set IP ranges
Replaces the organization's IP allowlist with `ranges`, each a `cidr` (IPv4 or IPv6; a bare address is one host) and an optional `label`, and returns it; an empty list turns it off. With any range saved, its people may use the console and API only from inside one, while node and runner traffic is never blocked. Refused with 422 for an invalid or duplicate range or a list that leaves out the caller's own address, and with 403 without the Org Owner or Org Admin role or the IP allowlist on the plan.
Get outcome scan interval
Returns how often, in minutes, each project of the organization is scanned for reverts and fixes: the organization's own value (`own`, null when unset), the Jaah default (`global`) and the one in force (`effective`), with the allowed range. Requires the Org Owner or Org Admin role.
Set outcome scan interval
Sets the organization's outcome scan interval in minutes (`own`, between `minimum` and `maximum`; out of range returns 422), or clears it with null so the Jaah default applies. A project's own interval still wins. Requires the Org Owner or Org Admin role.
Get retention
Returns the organization's own retention windows for `transcripts`, `events` and `artifacts`: each with `days` (null = the platform default), `default_days`, and the allowed `min_days` and `max_days`. Requires the Org Owner or Org Admin role and Retention on the plan (else 403).
Set retention
Sets the organization's retention windows in days for `transcripts` (session transcripts), `events` (activity events; security events are kept at least 365 days) and `artifacts` (task artifacts); null keeps the platform default; a window can only be shorter than the platform's. The nightly retention sweep then deletes the organization's older data. Refused with 422 naming the allowed range for a value outside it, and with 403 without the Org Owner or Org Admin role or Retention on the plan.
Delete SIEM export
Removes the organization's SIEM export destination; nothing more is sent. Returns 204, also when none was saved. Requires the Org Owner or Org Admin role (else 403); allowed when the plan no longer includes SIEM export.
Get SIEM export
Returns the organization's SIEM export destination, or `destination: null` when none is saved: its `url`, `auth_mode` (`hmac` or `header`), `header_name`, `enabled`, `secret_set` (the secret itself is never returned), the latest delivery (`last_attempt_at`, `last_success_at`, `last_status`, `last_error`), `pending` (events not delivered yet, counted up to `pending_cap` + 1), `settling` (those under two minutes old, not sent yet) and `retention_warning` when a failure outlasted the activity retention. Requires the Org Owner or Org Admin role (else 403); allowed when the plan no longer includes SIEM export, so a saved destination can be found and removed.
Set SIEM export
Creates or replaces the organization's SIEM export destination: an `https://` `url` on a public address, `auth_mode` `hmac` (each POST carries `X-Jaah-Signature: sha256=<hex HMAC-SHA256 of the body>`) or `header` (the `secret` sent as the value of `header_name`), the `secret` (required on create or when `auth_mode` changes; omitted keeps the stored one), and `enabled`. Every minute the organization's new activity events (those its Audit page shows) are POSTed as a JSON array (`id`, `org_id`, `created_at`, `kind`, `action_type`, `actor`, `summary`, `path`, `method`, `status`, `data`), at least once: a non-2xx answer is retried the next minute, so dedupe on `id`. Refused with 422 naming what to fix for a non-https or private URL, a reserved header or a short secret, and with 403 without the Org Owner or Org Admin role or SIEM export on the plan.
Send SIEM test event
Posts one test event (`id` 0, `kind` `siem_test`) to the saved SIEM export destination and returns `ok`, the HTTP `status` it answered and the `error` when it failed; the delivery cursor does not move. Refused with 409 when no destination is saved, with 429 within 10 seconds of the organization's last test event, and with 403 without the Org Owner or Org Admin role or SIEM export on the plan.
Get settings
Returns the organization-level settings that apply to the caller's organization with their resolved values, plus the app title and whether the caller may edit them. Requires permission to view system settings.