hoop

Get gateway server information including version, auth method, license info, and feature flags

Canonical way to restrict which user groups can access a connection — matches the webapp 'Access Control' page.

Remove the access_control binding for a connection. After this call,

Get the list of user groups allowed to access a given connection via the access_control plugin

List all connections currently bound to the access_control plugin with their allowed user groups

List all access request rules for the organization with optional pagination

Get a single access request rule by name

Create an approval / just-in-time access workflow rule for one or more connections — matches the webapp 'Access Request' page.

Update an existing access request rule by name. Requires admin access

Delete an access request rule by name. Requires admin access. This action is irreversible

List attributes for the organization. Attributes are tags that group connections, access-request/guardrail/data-masking rules, and access-control groups.

Get a single attribute by name, including all of its associations (connections, rules, access-control groups).

Create a new attribute, optionally associating it with connections, rules, and access-control groups in the same call. Requires admin access.

Update an attribute's description and/or its associations. Requires admin access.

Delete an attribute by name. Requires admin access. This action is irreversible and removes all of the attribute's associations.

List all connections accessible to the authenticated user, with optional filters by agent, type, subtype, tag_selector, or search query

Get a single connection by its name or ID

Create a new connection. Requires admin access.

Update an existing connection by name. Requires admin access. Only provided fields are updated

Delete a connection by name. Requires admin access. This action is irreversible

List all data masking rules configured for the organization

Get a single data masking rule by its ID

Create a new data masking rule with entity type detection configuration

Update an existing data masking rule by ID

Delete a data masking rule by ID. This action is irreversible

Run a one-shot command or query against a Hoop connection on behalf of the authenticated user.

List all guardrail rules configured for the organization

Get a single guardrail rule by its ID or name

Create a new guardrail rule with input/output configurations and connection associations

Update an existing guardrail rule by ID

Delete a guardrail rule by ID. This action is irreversible

Get the authenticated user's profile: email, name, user_id, org_id,

List all reviews (access requests) for the organization

Get a single review by its ID or session ID

Update a review status (approve, reject, or revoke). Requires membership in a reviewer group

Execute a query that was blocked on an approved one-time review. Runs the originally

Long-poll a review until it reaches a terminal status (APPROVED, REJECTED, REVOKED,

List all runbook rules configured for the organization

Get a single runbook rule by its ID

Create a new runbook rule with user groups, connections, and allowed runbooks

Update an existing runbook rule by ID

Delete a runbook rule by ID. This action is irreversible

List databases available on a Hoop database connection (Postgres, MySQL, MSSQL, MongoDB).

List tables in a given database on a Hoop database connection.

List columns of a specific table on a Hoop database connection, with types.

Get session details and metadata by ID. Returns metadata only, not session content or binary data

Get the input script and stdout/stderr output of a session.

Get Hoop's AI analysis for a session: risk level, title, explanation, recommended action.

Long-poll until Hoop's AI analysis for a session is available, or the timeout elapses.

List all user groups in the organization

Create a user group, optionally binding it to connections and/or existing attributes in the same call.

Delete a user group by name. Cannot delete the admin group. This action is irreversible

List all users in the organization

Get a single user by their email address

Review the current user's recent sessions to judge whether the behavior under analysis is routine or anomalous.

Select when the input is safe to execute: non-destructive, scoped, and low operational/security impact.

Select when the input could cause performance issues, service disruption, sensitive exposure, or risky-but-not-clearly-destructive changes.

Select when the input is destructive, irreversible, escalates privileges, exfiltrates data, disables defenses, or resembles exploit/persistence behavior.