# Hoop.dev - Automated Access and Data Protection ## Docs - [Overview](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/introduction/getting-started.md): Runtime control for agents - [Quickstart](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/introduction/quickstart.md): What to do with a running Sidecar - [Sidecar](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/core-concepts/sidecar.md): The engine. No external dependency, connected directly to the resource. - [Control Plane](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/core-concepts/control-plane.md): The brain of the operation. Centralizes Sidecars and delivers rule sets to all of them. - [Direct Access](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/features/direct-access.md): The straight-through path. Guardrails and Data Masking apply inline, with no model in the way. - [Agentic Access](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/features/agentic-access.md): Let a language model classify the statement, and let the risk level pick the tool. - [Data Masking](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/features/data-masking.md): Rewrite sensitive values in the response, in memory, before they reach the client. - [Guardrails](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/features/guardrails.md): An ordered deny list evaluated against every statement, before it reaches the resource. - [Overview](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/control-plane/install.md): Deploy the Control Plane in your own infrastructure with Docker Compose, Kubernetes or AWS. - [Docker Compose](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/control-plane/deployment/docker-compose.md): Stand up a Control Plane on a single host with docker compose. - [Kubernetes](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/control-plane/deployment/kubernetes.md): Deploy the Control Plane with the Helm chart, on any cloud provider. - [AWS](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/control-plane/deployment/aws.md): Deploy the Control Plane into your own AWS account with CloudFormation. - [Connect a Sidecar](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/control-plane/connect-sidecar.md): Issue a token, point a Sidecar at the Control Plane, and let it pull its configuration. - [Running the Sidecar](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/hoop-sidecar/get-started.md): Run the Sidecar from the CLI and put it behind your Envoy - [PostgreSQL](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/hoop-sidecar/protocols/postgres.md): What the pgwire codec decodes, terminates and masks on a postgres lane - [MySQL](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/hoop-sidecar/protocols/mysql.md): What the MySQL codec decodes, what it refuses, and how a mysql lane masks - [SQL Server](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/hoop-sidecar/protocols/mssql.md): What the TDS codec decodes on an mssql lane, and who terminates which TLS - [MongoDB](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/hoop-sidecar/protocols/mongodb.md): What the MongoDB codec decodes, how commands classify, and how a mongodb lane masks BSON - [gRPC](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/hoop-sidecar/protocols/grpc.md): The grpc lane: an in-process HTTP/2 endpoint that decodes, evaluates and re-encodes every RPC - [Spanner](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/hoop-sidecar/protocols/spanner.md): The spanner lane: the gRPC endpoint plus GoogleSQL extraction, so operation and table rules read the SQL inside each RPC - [BigQuery](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/hoop-sidecar/protocols/bigquery.md): Where the Sidecar fits in front of BigQuery: the Storage API on a grpc lane, and the REST plane's boundaries - [HTTP](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/hoop-sidecar/protocols/http.md): What the HTTP codec inspects beyond ext_authz, and how an http lane masks responses - [Config File Reference](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/hoop-sidecar/config-file.md): Every section of the Sidecar config file, and what startup refuses - [Guardrail Rules Reference](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/hoop-sidecar/policy-rules.md): Write a guardrail rule, pick deny or defer, and hand the judgement call to Rego - [AI Analyzer Reference](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/hoop-sidecar/risk-analysis.md): Classify statements with a language model and block on the risk it reports - [Architecture](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/hoop-sidecar/components.md): How a request flows through the Sidecar, and how to place it in a real deployment - [Kerberos and SQL Server](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/hoop-sidecar/kerberos.md): Inspect MSSQL and Postgres sessions where the user authenticates with a Kerberos ticket - [Overview](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/gateway/overview.md): The full Hoop platform: web app, agents, session recording, access requests and integrations. - [Live Data Masking](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/learn/features/live-data-masking.md): Automatically detect and mask sensitive data in query results without writing rules - [AI Session Analyzer](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/learn/features/ai-session-analyzer.md): Analyze terminal sessions in real time and enforce risk-based actions before execution - [Action Access Requests](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/learn/features/access-requests/action.md): Require approval for individual commands before they execute - [Just-in-Time Access Requests](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/learn/features/access-requests/jit.md): Grant temporary, time-limited access to resources with automatic expiration and approval workflows - [Access Control](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/learn/features/access-control.md): Control who can access which resource roles with group-based permissions - [Attribute-Based Access Control](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/learn/features/abac.md): Apply policies to groups of resource roles using attributes instead of listing every resource role - [Workflow Observability](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/learn/features/workflow-observability.md): See exactly what AI agents, scripts, and CI/CD jobs did in Hoop, attributed to named identities and grouped by workflow run - [Guardrails](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/learn/features/guardrails.md): Block dangerous queries before they execute with pattern-based rules - [Runbooks](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/learn/features/runbooks.md): Create reusable, parameterized templates for common operations - [Event Routing](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/learn/features/event-routing.md): Automatically dispatch a runbook whenever a platform event fires, with full audit and approval coverage. - [Secrets Management](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/learn/features/secrets-manager.md): Securely inject credentials into resource roles without exposing them to users - [Session Recording](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/learn/features/session-recording.md): Record and playback terminal sessions and entire database resource roles. - [Parallel Mode](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/learn/features/parallel-mode.md): Execute commands across multiple resource roles simultaneously - [MCP Server](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/learn/features/mcp-server.md): Connect AI agents to Hoop with the built-in Model Context Protocol server — every action stays under the same authorization, masking, guardrails, and review controls as a human session - [Resource Provisioning Hub](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/learn/features/resource-provisioning.md): Bulk-provision and manage PostgreSQL roles across every database connected to Hoop — with a plan/apply dry-run workflow and full audit trail. - [IAM Federation for GCP](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/learn/features/iam-federation-gcp.md): Mint per-user OAuth tokens for BigQuery and other GCP resources instead of sharing a single service-account key. - [Bastion SSH](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/learn/features/ssh.md): Use standard SSH clients to access Hoop resources with certificate-based authentication. - [Web App Overview](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/clients/webapp/overview.md): Get started with Hoop.dev's powerful web interface for managing secure infrastructure access - [Creating Resource Roles](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/clients/webapp/creating-resource-roles.md): Learn how to set up secure connections to your resources through the Hoop.dev web interface - [Managing Access](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/clients/webapp/managing-access.md): Learn how to control and organize access to your resource roles through user groups and permissions - [Monitoring Sessions](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/clients/webapp/monitoring-sessions.md): Learn how to track and audit resource role usage through the Sessions interface - [Command Line](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/clients/cli.md): Install and configure the hoop.dev CLI to interact with your applications. - [hoop versions](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/clients/cli-versions.md): Manage hoop CLI versions: sync to the connected gateway, upgrade to the latest release, or install any specific version side-by-side. - [hoop resources](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/clients/cli-resources.md): Manage and provision PostgreSQL roles from the command line using hoop resources plan, apply, and health. - [hoop admin federation](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/clients/cli-federation.md): Manage per-connection IAM federation from the CLI: get, set, delete, and dry-run policies plus admin credentials. - [Hoop Shell Plugins (hsh)](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/clients/hsh.md): Use ssh and kubectl natively — hsh transparently routes them through your Hoop gateway. - [Hoop Tunnel](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/clients/hsh-tunnel.md): Reach any Hoop-managed database or TCP service by name — psql -h pg-prod.hoop — with authentication, review, and audit still enforced by the gateway. - [Catalog](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/quickstart/overview.md): Setup your environment by selecting your resource type - [PostgreSQL](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/quickstart/databases/postgres.md): A powerful, open-source relational database system known for reliability, feature robustness, and performance. - [MySQL](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/quickstart/databases/mysql.md): The world's most popular open-source relational database, offering proven performance, reliability, and ease-of-use. - [MongoDB](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/quickstart/databases/mongodb.md): A NoSQL document-oriented database that provides high scalability and flexibility for modern applications. - [DynamoDB](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/quickstart/databases/dynamodb.md): Amazon DynamoDB is a fully managed NoSQL database service that provides fast and predictable performance with seamless scalability. - [Oracle](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/quickstart/databases/oracle.md): A multi-model database management system designed for enterprise grid computing and high-performance applications. - [Microsoft SQL Server](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/quickstart/databases/mssql.md): A relational database management system developed by Microsoft, offering comprehensive data management and business intelligence capabilities. - [Apache Cassandra](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/quickstart/databases/apache-cassandra.md): A highly scalable, distributed NoSQL database designed for handling large amounts of data across many servers. - [BigQuery](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/quickstart/databases/bigquery.md): A fully managed, serverless data warehouse that enables super-fast SQL queries using Google's infrastructure. - [Redis](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/quickstart/databases/redis.md): An in-memory data structure store, used as a database, cache, and message broker with support for various data types. - [Claude Code](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/quickstart/ai-and-llms/claude-code.md): Proxy Claude Code to ensure sensitive data won’t leak. - [MCP](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/quickstart/ai-and-llms/mcp.md): Proxy MCP to ensure sensitive data won't leak. - [MCP Gateway](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/quickstart/ai-and-llms/mcp-gateway.md): Protocol-aware MCP proxy with tool-level policy and audit. - [MCP Server Catalog](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/quickstart/ai-and-llms/mcp-servers.md): Every MCP server hoop can proxy, how each one authenticates, and how to configure a server that is not in the list. - [Connecting an MCP Client](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/quickstart/ai-and-llms/mcp-connect.md): Point Claude Code, Cursor or any MCP client at an MCP Gateway connection: the endpoint, the token, and both ways to run a stdio server. - [AWS CLI](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/quickstart/cloud-services/aws/aws-cli.md): The AWS Command Line Interface (CLI) is a unified tool to manage your AWS services from the command line. - [AWS CloudWatch](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/quickstart/cloud-services/aws/aws-cloudwatch.md): A monitoring and observability service that provides data and actionable insights for AWS, hybrid, and on-premises applications and infrastructure resources. - [AWS ECS](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/quickstart/cloud-services/aws/aws-ecs.md): Amazon Elastic Container Service (ECS) is a fully managed container orchestration service that helps you easily deploy, manage, and scale containerized applications. - [AWS SSM](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/quickstart/cloud-services/aws/aws-ssm.md): AWS SSM script permits managing EC2 instances using AWS SSM via Hoop - [Kubernetes](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/quickstart/cloud-services/kubernetes/kubernetes.md): Manage Kubernetes resources through kubectl commands or native API access. This integration supports both CLI-based workflows and direct interaction with the Kubernetes API for full cluster control. - [Kubernetes EKS](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/quickstart/cloud-services/kubernetes/kubernetes-eks.md): Manage Kubernetes resources through kubectl commands or native API access. This integration supports both CLI-based workflows and direct interaction with the Kubernetes API for full cluster control. - [Git](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/quickstart/cloud-services/git.md): Access git servers securely through Hoop using SSH. This integration enables secure git operations, repository management, and git server resource access through the Hoop proxy with complete audit trails and access controls. Works with GitHub, GitLab, Gitea, Forgejo, and any SSH-based git server. - [GitHub](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/quickstart/cloud-services/github.md): Access GitHub resources securely through Hoop using SSH. This integration enables secure git operations, repository management, and GitHub resource access through the Hoop proxy with complete audit trails and access controls. - [Web Applications and APIs](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/quickstart/web-applications/webapps-and-apis.md): Web applications and APIs that provide HTTP/HTTPS endpoints for various services, applications, and data access interfaces. - [HTTP Proxy](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/quickstart/web-applications/http-proxy.md): Access HTTP/HTTPS endpoints securely through Hoop.dev with intelligent traffic monitoring, automated request/response logging, and comprehensive access controls. - [Grafana](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/quickstart/web-applications/grafana-proxy.md): Access your Grafana monitoring and visualization platform securely through Hoop.dev with comprehensive audit trails, session recording, and intelligent traffic monitoring. - [Kibana](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/quickstart/web-applications/kibana-proxy.md): Access your Kibana analytics and visualization platform securely through Hoop.dev with comprehensive audit trails, session recording, and intelligent traffic monitoring. - [Ruby on Rails](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/quickstart/development-environments/ruby-on-rails.md): A web application framework written in Ruby that follows the MVC pattern, providing tools for rapid web development. - [Python Scripts](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/quickstart/development-environments/python/python-scripts.md): A versatile, high-level programming language perfect for scripting, automation, data analysis, and application development. - [Django](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/quickstart/development-environments/python/django-admin.md): A high-level Python web framework that encourages rapid development and clean, pragmatic design with built-in admin interface. - [PHP Artisan](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/quickstart/development-environments/php-artisan.md): Laravel Artisan is the command-line interface included with Laravel, providing helpful commands for application development. - [Elixir IEx](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/quickstart/development-environments/elixir-IEx.md): A dynamic, functional language designed for building maintainable and scalable applications, running on the Erlang Virtual Machine. - [Clojure](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/quickstart/development-environments/clojure.md): A dynamic, general-purpose programming language that combines interactive development with efficient infrastructure for multithreaded programming. - [Node.js](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/quickstart/development-environments/nodejs.md): A JavaScript runtime built on Chrome's V8 engine, enabling server-side JavaScript development with high performance. - [Secure Shell (SSH)](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/quickstart/ssh.md): A cryptographic network protocol for operating network services securely over an unsecured network, commonly used for remote command-line login. - [Remote Desktop (RDP)](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/quickstart/remote-desktop.md): Remote Desktop Protocol (RDP) allows accessing securely remote Windows instances via RDP protocol. - [Architecture](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/architecture.md): Understand how Hoop's components fit together and how traffic flows through the system. - [Overview](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/deployment/overview.md): See the options to try out hoop.dev - [Docker](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/deployment/docker-compose.md): This deployment leverages `docker compose` to deploy Hoop on local or remote machines for solution assessment. - [Container Images](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/deployment/container-images.md): The container images Hoop publishes, what each one contains, and how to build your own from the released binaries. - [Kubernetes](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/deployment/kubernetes.md) - [Microsoft Presidio](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/deployment/presidio.md) - [Alcatraz](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/deployment/alcatraz.md) - [SPIFFE Agent Identity](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/deployment/spiffe.md) - [AWS](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/deployment/AWS.md): This deployment leverages AWS CloudFormation to automatically create resources and set up the Hoop in your own AWS account. - [Get Started](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/live-data-masking/get-started.md): Set up and know better about hoop.dev's Live Data Masking - [Supported Fields](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/live-data-masking/fields.md): Get to know all the fields that you can use to mask data in your organization. - [AI Session Analyzer Configuration](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/ai-session-analyzer-configuration.md): Configure an AI provider and risk rules to analyze ad-hoc terminal sessions in real time - [AI Session Analyzer for HTTP Proxy](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/ai-session-analyzer-configuration-http-proxy.md): Configure an AI provider and risk rules to analyze HTTP Proxy traffic per request, in real time - [Action Access Requests Configuration](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/access-requests/action-configuration.md): Configure command-level approval workflows for your resource roles - [JIT Access Requests Configuration](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/access-requests/jit-configuration.md): Configure time-based access controls for your resource roles - [Access Control Configuration](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/access-control-configuration.md): Configure group-based access policies for your resource roles - [ABAC Configuration](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/abac-configuration.md): Create attributes and scope feature policies by attribute instead of listing every resource role - [Guardrails Configuration](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/guardrails-configuration.md): Create and manage pattern-based rules to block dangerous queries - [SQL Guardrail Recipes](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/guardrails-sql-recipes.md): Tested regex recipes for complex SQL: tautologies, subqueries, CTEs, joins, and missing WHERE clauses - [MongoDB Guardrail Recipes](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/guardrails-mongodb-recipes.md): Patterns for MongoDB connections: drops, unscoped deletes, pipeline writes, and server-side JavaScript — for native and Web App access - [Guardrails for HTTP Proxy](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/guardrails-http.md): Route traffic from a Python service (httpx, bearer tokens) through Hoop to an HTTPS backend, with access control, method restriction, path filtering, header inspection, and payload inspection. - [Runbooks Configuration](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/runbooks-configuration.md) - [Event Routing Configuration](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/event-routing-configuration.md): Enable Event Routing, create subscriptions that dispatch runbooks on platform events, and audit dispatch history. - [MCP Server Configuration](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/mcp-server-configuration.md): Connect an MCP client to Hoop's gateway, enable OAuth, and run your first tool calls - [Resource Provisioning Configuration](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/resource-provisioning-configuration.md): Build a database inventory, configure admin credentials, and provision PostgreSQL roles with a plan/apply workflow — in the Web App or via the CLI. - [IAM Federation for GCP Configuration](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/iam-federation-gcp-configuration.md): Grant the gcloud permissions Hoop needs to mint per-user OAuth tokens for BigQuery and other GCP resources. - [Secrets Manager Configuration](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/secrets-manager-configuration.md): It enables integration with a known secrets manager, allowing the resource role environment variable to be dynamically expanded for each resource role. - [Aws Rds IAM Auth](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/rds-iam-auth.md): It enables integration with AWS IAM Auth for RDS instances. - [Environment Variables](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/env-vars.md): Describe how to configure the Hoop Gateway via environment variables - [Reverse Proxy](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/reverse-proxy.md): Deploying Hoop Behind a Reverse Proxy - [Overview](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/idp/get-started.md): Connect hoop.dev to your Identity Provider using OIDC or SAML 2.0 - [Auth0](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/idp/auth0.md) - [Okta](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/idp/okta.md) - [Google](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/idp/google.md) - [Azure](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/idp/azure.md) - [JumpCloud](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/idp/jumpcloud.md) - [AWS Cognito](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/idp/aws-cognito.md) - [OneLogin (SAML 2.0)](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/idp/onelogin.md) - [Keycloak](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/configuration/idp/keycloak.md): Connect hoop.dev to Keycloak using OpenID Connect (OIDC). - [API Keys](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/apis/api-key.md): Create, rotate, and revoke API keys for headless access to the Hoop Gateway - [Service Accounts](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/apis/service-accounts.md): Configure service accounts by leveraging Oauth2 Client Credentials Grant Type - [Webhooks / SIEM](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/apis/webhooks-siem.md): Forward session events to external systems using runbook hooks. - [Updating Hoop](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/updating.md): Guidance and best practices for updating Hoop components, including version alignment, compatibility considerations, and post-update troubleshooting. - [License Management](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/setup/license-management.md): Managing License for your Hoop Installation - [Agents](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/concepts/agents.md): The agent links your private infrastructure to Hoop, acting as a proxy between your network and the central gateway. - [Resource Roles](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/concepts/resource-roles.md): The bridge between users and resources - [Slack](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/integrations/slack.md): Manage access requests directly from your Slack workspace. - [Teams](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/integrations/teams.md): Hoop.dev can integrate with Microsoft Teams, sending messages to a channel when a particular event happens. - [Jira](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/integrations/jira.md): Automate change management and security workflows by integrating Jira with your infrastructure access requests. - [SIEM](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/integrations/siem.md): Forward session events to your SIEM or logging pipeline using runbook hooks. - [Svix](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/integrations/svix.md): Integrate with Svix to have wehbooks/SIEM properly configured. - [AWS Connect](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/integrations/aws.md): Database Resource Discovery and Automatic Resource Role Creation. - [Microsoft Presidio](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/integrations/ms-presidio.md): Enable sensitive data detection, masking, and guardrail enforcement using Microsoft Presidio. - [Get MCP OAuth Authorization Server Metadata](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/server-management/get-mcp-oauth-authorization-server-metadata.md): RFC 8414 authorization-server metadata mirroring the configured IdP, with registration_endpoint pointing at the gateway's RFC 7591 registration shim. Served unauthenticated at the gateway root (outside the /api base path) as /.well-known/oauth-authorization-server and /.well-known/openid-configurati… - [HealthCheck](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/server-management/healthcheck.md): Reports if the service is working properly - [Register MCP OAuth Client](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/server-management/register-mcp-oauth-client.md): RFC 7591 Dynamic Client Registration shim for IdPs without native DCR support: accepts any registration request and answers with the statically pre-registered OAuth client, echoing the caller's client metadata. Served unauthenticated per RFC 7591. Returns 404 unless MCP OAuth is enabled with a stati… - [Get Organization Analytics Mode](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/server-management/get-organization-analytics-mode.md): Get the analytics privacy mode of the caller's organization - [Update Organization Analytics Mode](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/server-management/update-organization-analytics-mode.md): Update the analytics privacy mode of the caller's organization - [Get Organization Hide Role Info](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/server-management/get-organization-hide-role-info.md): Get whether the caller's organization blocks reading connection/role secrets (envvars) through the API - [Update Organization Hide Role Info](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/server-management/update-organization-hide-role-info.md): Toggle whether the caller's organization blocks reading connection/role secrets (envvars) through the API - [Update Org License](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/server-management/update-org-license.md): Upload a new license into the system - [Sign License](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/server-management/sign-license.md): Sign a new license for a customer. This route is for internal use only - [Get Organization Onboarding Status](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/server-management/get-organization-onboarding-status.md): Get the setup checklist state for the caller's organization. Each step latches the first time it is satisfied, so a check never reverts. Once every check passes, `show_setup_checklist` on /userinfo turns false — the signal to stop calling this endpoint. - [Get Organization Protection Profile](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/server-management/get-organization-protection-profile.md): Get the organization's default protection profile. A null profile means manual configuration. - [Update Organization Protection Profile](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/server-management/update-organization-protection-profile.md): Select the organization's default protection profile. The backend materializes the profile's managed rules and attribute and tags every connection. Passing a null profile switches to manual configuration and deletes all Hoop-managed protection rules. - [Get Public Server Info](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/server-management/get-public-server-info.md): Get public server information - [Get Authentication Configuration](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/server-management/get-authentication-configuration.md): Get authentication configuration - [Update Authentication Configuration](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/server-management/update-authentication-configuration.md): Update authentication configuration - [Generate API Key](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/server-management/generate-api-key.md): Generate a rollout api key - [Get MCP OAuth 2.1 Resource Server Configuration](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/server-management/get-mcp-oauth-21-resource-server-configuration.md): Returns the per-org MCP OAuth Resource Server settings. When disabled (default), /mcp accepts Hoop-issued bearer tokens only. - [Update MCP OAuth 2.1 Resource Server Configuration](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/server-management/update-mcp-oauth-21-resource-server-configuration.md): Enable, disable, or reconfigure the OAuth 2.1 Resource Server profile for the /mcp endpoint. - [Get Server Miscellaneous Configuration](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/server-management/get-server-miscellaneous-configuration.md): Get server miscellaneous configuration - [Update Server Miscellaneous Configuration](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/server-management/update-server-miscellaneous-configuration.md): Update server miscellaneous configuration - [Get Server Info](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/server-management/get-server-info.md): Get server information - [List Access Request Rules](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/access-request-rules/list-access-request-rules.md): List all access request rules for the organization with pagination - [Create Access Request Rule](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/access-request-rules/create-access-request-rule.md): Create a new access request rule for the organization - [Get Access Request Rule](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/access-request-rules/get-access-request-rule.md): Get an access request rule by ID - [Update Access Request Rule](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/access-request-rules/update-access-request-rule.md): Update an access request rule by ID - [Delete Access Request Rule](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/access-request-rules/delete-access-request-rule.md): Delete an access request rule by name - [List Agent Keys](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/agents/list-agent-keys.md): List all agent keys - [Create Agent Key](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/agents/create-agent-key.md): Create an agent key in a DSN format: `grpc(s)://:@:?mode=standard|embedded`. This key is used to deploy agents and expose internal resources from your infra-structure - [Get Agent Key](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/agents/get-agent-key.md): Get an agent key by name or ID - [Delete Agent Key](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/agents/delete-agent-key.md): Remove an agent key. It will invalidate a running agent - [List AI Agents](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/ai-agents/list-ai-agents.md): List all AI Agents for the organization - [Create AI Agent](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/ai-agents/create-ai-agent.md): Generate a new AI Agent. The raw key is returned only once in the response and cannot be retrieved after creation. - [Get AI Agent](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/ai-agents/get-ai-agent.md): Get an AI Agent by name or ID - [Update AI Agent](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/ai-agents/update-ai-agent.md): Update an AI Agent's name and/or groups. Works for both active and revoked agents. - [Revoke AI Agent](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/ai-agents/revoke-ai-agent.md): Revoke an AI Agent (soft delete). The agent status is set to revoked. - [Reactivate AI Agent](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/ai-agents/reactivate-ai-agent.md): Reactivate a revoked AI Agent. Sets status back to active and clears deactivation metadata. - [Get AI Session Analyzer Provider](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/ai/get-ai-session-analyzer-provider.md): Get the AI provider configured for the session analyzer feature in the organization - [Upsert AI Session Analyzer Provider](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/ai/upsert-ai-session-analyzer-provider.md): Create or update the AI provider for the session analyzer feature in the organization (one per org) - [Delete AI Session Analyzer Provider](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/ai/delete-ai-session-analyzer-provider.md): Delete the AI provider configured for the session analyzer feature in the organization - [List AI Session Analyzer Rules](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/ai/list-ai-session-analyzer-rules.md): List all AI session analyzer rules for the organization, optionally filtered by connection names - [Create AI Session Analyzer Rule](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/ai/create-ai-session-analyzer-rule.md): Create a new AI session analyzer rule - [Get AI Session Analyzer Rule](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/ai/get-ai-session-analyzer-rule.md): Get an AI session analyzer rule by name - [Update AI Session Analyzer Rule](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/ai/update-ai-session-analyzer-rule.md): Update an existing AI session analyzer rule - [Delete AI Session Analyzer Rule](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/ai/delete-ai-session-analyzer-rule.md): Delete an AI session analyzer rule - [Get AI Session Analyzer System Prompt](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/ai/get-ai-session-analyzer-system-prompt.md): Returns the read-only system prompt that the gateway prepends before any custom_prompt configured on a rule - [Get AI Session Analyzer Rule by Connection](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/ai/get-ai-session-analyzer-rule-by-connection.md): Get the AI session analyzer rule configured for a specific connection - [List API Keys](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/api-keys/list-api-keys.md): List all API keys for the organization - [Create API Key](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/api-keys/create-api-key.md): Generate a new API key. The raw key is returned only once in the response and cannot be retrieved after creation. - [Get API Key](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/api-keys/get-api-key.md): Get an API key by name or ID - [Update API Key](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/api-keys/update-api-key.md): Update an API key's name and/or groups. Works for both active and revoked keys. - [Revoke API Key](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/api-keys/revoke-api-key.md): Revoke an API key (soft delete). The key status is set to revoked. - [Reactivate API Key](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/api-keys/reactivate-api-key.md): Reactivate a revoked API key. Sets status back to active and clears deactivation metadata. - [List Attributes](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/attributes/list-attributes.md): List attributes for the organization with optional pagination and search. - [Create Attribute](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/attributes/create-attribute.md): Create a new attribute for the organization. - [Get Attribute](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/attributes/get-attribute.md): Get an attribute by name or ID. - [Update Attribute](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/attributes/update-attribute.md): Rename an existing attribute. - [Delete Attribute](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/attributes/delete-attribute.md): Delete an attribute by name or ID. - [List security audit logs](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/audit-logs/list-security-audit-logs.md): Lists security audit log entries for the organization. Only admins can access this API. Supports filtering by actor, resource type, action, HTTP method, HTTP status, client IP, path, outcome, and date range. Results are ordered by created_at descending. - [OIDC | Login Callback](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/authentication/oidc-|-login-callback.md): Exchanges and validates the authorization code for an access token after being redirect by the external provider. A success authentication will redirect the user back to the default redirect url provided in the /login route. - [Local | Login](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/authentication/local-|-login.md): Generate a new access token to interact with the API that expires in 12 hours. - [Local | Register User](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/authentication/local-|-register-user.md): It registers a new user in the system with the provided email and password. Additionall users are only registered when they are invited by an existing admin user. - [OIDC | Login](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/authentication/oidc-|-login.md): Returns the login url to perform the signin on the identity provider - [SAML | Login Callback](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/authentication/saml-|-login-callback.md): It redirects the user to the redirect URL with a JWT access token on success. A success authentication will redirect the user back to the default redirect url provided in the /saml/login route. In case of error it will include the query string error= when redirecting. - [SAML | Login](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/authentication/saml-|-login.md): Returns the login url to perform the signin on the identity provider. - [OIDC | Signup](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/authentication/oidc-|-signup.md): Signup anonymous authenticated user. This endpoint is only used for multi tenant setups. - [List Active Connection Credentials](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/connections/list-active-connection-credentials.md): Returns the authenticated user's active (non-revoked, non-expired) credentials, AT MOST ONE PER CONNECTION. Several rows can be live for the same connection — issuing reuses the existing credential while resuming an approved review mints a parallel one — so the list resolves them the same way the re… - [List Connections](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/connections/list-connections.md): List all connections. - [Create Connection](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/connections/create-connection.md): The connection resource allows exposing internal services from your internal infra structure to users. - [List Connection Tags](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/connections/list-connection-tags.md): List all Connection Tags. - [Get Connection](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/connections/get-connection.md): Get resource by name or id - [Update Connection](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/connections/update-connection.md): Update a connection resource - [Delete Connection](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/connections/delete-connection.md): Delete a connection resource. - [Patch Connection](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/connections/patch-connection.md): Partial update of a connection resource. Only provided fields will be updated. - [Get Table Columns](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/connections/get-table-columns.md): Get columns from a specific table - [Get Active Connection Credentials](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/connections/get-active-connection-credentials.md): Returns the current active, non-expired credentials for the authenticated user on the given connection without creating a new session. Returns 404 if no active credentials exist or they have expired. - [Create Connection Credentials](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/connections/create-connection-credentials.md): Create Connection Credentials - [Close Connection Credentials Session](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/connections/close-connection-credentials-session.md): Ends the current audit session for a credential and tears down any active proxy connections, but keeps the credential itself usable. The stored token is preserved so the next credential request for the same (user, connection) pair returns the same value. For explicit token invalidation use the revok… - [Revoke Connection Credentials](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/connections/revoke-connection-credentials.md): Revokes a connection credential, invalidating the stored token and disconnecting any active sessions. The next credential request for the same (user, connection) pair will issue a fresh token. - [Resume Connection Credentials Request](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/connections/resume-connection-credentials-request.md): Resume a connection credentials request after review approval - [List Databases](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/connections/list-databases.md): List all available databases for a database connection - [Update Data Masking Rule Connections](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/connections/update-data-masking-rule-connections.md): Update Data Masking Rule Connections - [Get Federation Configuration for a Connection](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/connections/get-federation-configuration-for-a-connection.md): Returns the IAM federation configuration for a connection. The admin credentials are never returned in plaintext; only a presence indicator is included. - [Upsert Federation Configuration for a Connection](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/connections/upsert-federation-configuration-for-a-connection.md): Creates or updates the IAM federation configuration for a connection. AdminCredentialsJSON is write-only; omit on update to preserve the stored value. - [Delete Federation Configuration for a Connection](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/connections/delete-federation-configuration-for-a-connection.md): Removes the IAM federation configuration for a connection. Subsequent sessions on this connection revert to the static connection envs. - [List Database Tables](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/connections/list-database-tables.md): List tables from a database without column details - [Test Connection](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/connections/test-connection.md): Test resource by name or id (only for database connections, it will attempt a simple ping). - [List MCP Server Catalog](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/connections/list-mcp-server-catalog.md): List the built-in catalog of publicly hosted remote MCP servers. Used by the connection create page to pre-fill an `mcpproxy` connection's endpoint, transport and auth mode from a picker. - [Start the OAuth login flow for an MCP connection](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/connections/start-the-oauth-login-flow-for-an-mcp-connection.md): Discovers the MCP server's authorization server (RFC 9728 / RFC 8414), optionally performs Dynamic Client Registration (RFC 7591) when no client credentials are supplied, and returns the authorization URL for the admin's browser to complete an Authorization Code + PKCE login. The browser is redirect… - [OAuth callback for MCP connection login](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/connections/oauth-callback-for-mcp-connection-login.md): The upstream authorization server's redirect target. Validates the state issued by the authorize endpoint, exchanges the authorization code for an access token, stores it on the flow row, and redirects the browser back to the connection create page with mcp_oauth=success|error and the flow_id. This… - [Retrieve the token obtained by an MCP OAuth login](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/connections/retrieve-the-token-obtained-by-an-mcp-oauth-login.md): Returns the access token obtained by a completed MCP OAuth login so the connection create page can freeze it into the connection's HEADER_AUTHORIZATION configuration. The token is returned at most once: the flow row is deleted on read. - [Report the user's per-user federation connection status](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/federation/report-the-users-per-user-federation-connection-status.md): Reports, for the authenticated user, whether they have connected a per-user account (e.g. their Google account for gcp_oauth) to a connection. Clients use this to decide whether to prompt the user to connect before running. Access is scoped to connections the user is allowed to run. - [Disconnect a user's Google account from a connection](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/federation/disconnect-a-users-google-account-from-a-connection.md): Deletes the authenticated user's stored Google refresh token for a gcp_oauth-federated connection. Subsequent sessions fail until the user re-consents. - [Start the Google OAuth consent flow for a connection](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/federation/start-the-google-oauth-consent-flow-for-a-connection.md): Returns the Google consent URL for the authenticated user to connect their Google account to a gcp_oauth-federated connection. The browser should be redirected to the returned URL; Google redirects back to the gateway callback, which stores the resulting refresh token. - [Google OAuth callback for connection federation](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/federation/google-oauth-callback-for-connection-federation.md): Google's OAuth redirect target. Validates the state issued by the authorize endpoint, exchanges the authorization code for a refresh token, stores it for the user/connection, and redirects the browser back to the application with federation_oauth=success|error. This endpoint is unauthenticated but s… - [Test a Federation Configuration End-to-End](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/federation/test-a-federation-configuration-end-to-end.md): Resolves the candidate federation configuration against a synthetic user AND dispatches a one-shot smoke probe (the caller-supplied test_script, e.g. "SELECT 1") to the agent identified in the request body. Persisted state is never read or written: the entire candidate connection + federation pair l… - [List Data Masking Rules](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/data-masking-rules/list-data-masking-rules.md): List Data Masking Rules - [Create Data Masking Rule](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/data-masking-rules/create-data-masking-rule.md): Create Data Masking Rule - [Get Data Masking Rule](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/data-masking-rules/get-data-masking-rule.md): Get Data Masking Rule - [Update Data Masking Rule](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/data-masking-rules/update-data-masking-rule.md): Update Data Masking Rule - [Delete Data Masking Rule](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/data-masking-rules/delete-data-masking-rule.md): Delete a Data Masking Rule resource. - [List DB Role Jobs](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/aws/list-db-role-jobs.md): List all db role jobs - [Create Database Role Job](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/aws/create-database-role-job.md): It creates a job that performs the provisioning of default database roles - [Get DB Role Job](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/aws/get-db-role-job.md): Get DB Role job by id - [Update IAM Access Key](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/aws/update-iam-access-key.md): Update IAM Access Key or set a region when using IAM instance role - [Delete IAM Access Key](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/aws/delete-iam-access-key.md): Remove IAM Access Key from memory - [Get Caller Identity](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/aws/get-caller-identity.md): It obtain the aws identity of the instance role or credentials - [List AWS Accounts](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/aws/list-aws-accounts.md): It list all AWS accounts associated with the access key credentials - [Create RDS Root Password](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/aws/create-rds-root-password.md): It creates password for RDS instances that is used to reset the root password when executing the database role job. The password are used only once and expire after 30 minutes. - [List Database Instances](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/aws/list-database-instances.md): It list RDS Database Instances - [List Feature Flags](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/feature-flags/list-feature-flags.md): List all feature flags from the catalog with their per-org state - [Update Feature Flag](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/feature-flags/update-feature-flag.md): Enable or disable a feature flag for the organization - [OpenAI Chat Completions](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/features/openai-chat-completions.md): Proxy to OpenAI chat completions `/vi/chat/completions` - [Feature Update](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/features/feature-update.md): Updates a feature configuration. It will report if this feature is available in the user info endpoint. - [Get Webhooks Dashboard](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/features/get-webhooks-dashboard.md): Get webhooks dashboard url - [List Guard Rail Rules](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/guard-rails/list-guard-rail-rules.md): List Guard Rail Rules - [Create Guard Rail Rules](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/guard-rails/create-guard-rail-rules.md): Create Guard Rail Rules - [Get Guard Rail Rules](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/guard-rails/get-guard-rail-rules.md): Get Guard Rail Rules - [Update Guard Rail Rules](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/guard-rails/update-guard-rail-rules.md): Update Guard Rail Rules - [Delete a Rule](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/guard-rails/delete-a-rule.md): Delete a Guard Rail Rule resource. - [Get Jira Integration](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/jira/get-jira-integration.md): Get Jira integration for the organization - [Update Jira Integration](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/jira/update-jira-integration.md): Update the Jira integration for the organization - [Create Jira Integration](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/jira/create-jira-integration.md): Create a new Jira integration for the organization - [Get Asset Field Configurations](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/jira/get-asset-field-configurations.md): Get the AQL configuration of Jira Service Management (JSM) Assets custom fields. These are the object scope and dependent-field (issue scope) filters Jira's own portal applies; they drive the CMDB dropdown cascade. Fields without any configured filter are omitted. - [Get Asset Objects](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/jira/get-asset-objects.md): Get objects from the Jira Service Management (JSM) Assets API - [List Issue Templates](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/jira/list-issue-templates.md): List Issue Templates - [Create Issue Templates](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/jira/create-issue-templates.md): Create Issue Templates - [Get Issue Templates](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/jira/get-issue-templates.md): Get Issue Templates - [Update Issue Templates](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/jira/update-issue-templates.md): Update Issue Templates - [Delete Issue Templates](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/jira/delete-issue-templates.md): Delete Issue Templates - [List Machine Identities](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/machine-identities/list-machine-identities.md): List all machine identities (non-human identities) - [Create Machine Identity](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/machine-identities/create-machine-identity.md): Create a machine identity (non-human identity) with native credentials for each connection - [Get Machine Identity](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/machine-identities/get-machine-identity.md): Get a machine identity by name - [Update Machine Identity](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/machine-identities/update-machine-identity.md): Update a machine identity. Adding connections provisions new credentials; removing connections revokes them. - [Delete Machine Identity](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/machine-identities/delete-machine-identity.md): Delete a machine identity and revoke all associated credentials - [List Machine Identity Credentials](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/machine-identities/list-machine-identity-credentials.md): List full credential details for a machine identity including connection strings and secret keys - [Rotate Machine Identity Credential](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/machine-identities/rotate-machine-identity-credential.md): Rotate (regenerate) a credential for a specific connection. The old credential is revoked and a new one is returned. - [Get Session Metrics](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/session-metrics/get-session-metrics.md): Query session metrics data with advanced filtering. Supports AND/OR logic for combining filters. Filter by resource types (connection_type), resource subtypes (connection_subtype), resources (connection_name), Presidio data types (info_type), masked/unmasked status, date ranges, session dates, and s… - [Handle Organization Invitation](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/user-management/handle-organization-invitation.md): Accept or decline a pending organization invitation. On accept, the current user is migrated to the invited org and the old auto-created org is removed if empty. On decline, the invitation is dismissed permanently. - [List Service Accounts](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/user-management/list-service-accounts.md): List all service accounts - [Create Service Account](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/user-management/create-service-account.md): Create a service account that is associated with a identity provider client - [Update Service Account](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/user-management/update-service-account.md): Update a service account that is associated with a identity provider client - [Get UserInfo](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/user-management/get-userinfo.md): Get own user's information - [List Users](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/user-management/list-users.md): List all users - [Create User](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/user-management/create-user.md): Creating a user will pre configure user definitions like display name, profile picture, groups and the slack id - [List User Groups](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/user-management/list-user-groups.md): List every group name known to the organization: the ones bound to users, service accounts, API keys and AI agents, plus the ones referenced by the access_control plugin. Sorted alphabetically. - [Create User Group](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/user-management/create-user-group.md): Create a new user group - [Delete User Group](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/user-management/delete-user-group.md): Delete a user group - [Answer Signup Origin Survey](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/user-management/answer-signup-origin-survey.md): Record how the authenticated user heard about Hoop. Each user may answer only once; a second attempt returns 409. - [Patch User Slack ID](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/user-management/patch-user-slack-id.md): Patch own user's slack id - [Get User](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/user-management/get-user.md): Get user by email or subject id - [Update User](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/user-management/update-user.md): Updates an existing user - [Delete User](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/user-management/delete-user.md): Delete a user. - [Get Org Key](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/organization-management/get-org-key.md): Get the organization key to run with `hoop run` command line - [Create Org Key](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/organization-management/create-org-key.md): Create the organization key to run with `hoop run` command line. - [Revoke Org Key](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/organization-management/revoke-org-key.md): Remove organization key - [List Plugins](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/plugins/list-plugins.md): List all Plugin resources - [Create Plugin](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/plugins/create-plugin.md): Create Plugin resource - [Get Plugin](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/plugins/get-plugin.md): Get a plugin resource by name - [Update Plugin](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/plugins/update-plugin.md): Update Plugin resource. The `config` and `name` attributes are immutable for this endpoint. - [Update Plugin Config](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/plugins/update-plugin-config.md): Update the Plugin resource top level configuration. - [Get Plugin Connection](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/plugins/get-plugin-connection.md): Get a plugin connection resource - [Upsert Plugin Connection](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/plugins/upsert-plugin-connection.md): Update or create a plugin connection resource - [Delete Plugin Connection](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/plugins/delete-plugin-connection.md): Delete a plugin connection resource. - [Runbook Exec](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/runbooks/runbook-exec.md): Start a execution using a Runbook as input. If the connection has a JIRA issue template configured, it will create a JIRA issue. - [List Runbooks By Connection](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/runbooks/list-runbooks-by-connection.md): List Runbooks templates by connection - [List Runbooks](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/runbooks/list-runbooks.md): List all Runbooks - [List Runbooks](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/runbooks/list-runbooks-1.md): List all Runbooks - [Get Runbook Configuration](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/runbooks/get-runbook-configuration.md): Get Runbook Configuration - [Update Runbook Configuration](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/runbooks/update-runbook-configuration.md): Update Runbook Configuration - [Create Runbook Configuration Entry](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/runbooks/create-runbook-configuration-entry.md): Create Runbook Configuration Entry - [Update Runbook Configuration Entry](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/runbooks/update-runbook-configuration-entry.md): Update Runbook Configuration Entry - [Delete Runbook Configuration Entry](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/runbooks/delete-runbook-configuration-entry.md): Delete a runbook configuration entry. - [Create Runbook File](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/runbooks/create-runbook-file.md): Commit a new file (or overwrite an existing one) to the git repository associated with the given configuration ID. - [Runbook Exec](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/runbooks/runbook-exec-1.md): Start a execution using a Runbook as input. If the connection has a JIRA issue template configured, it will create a JIRA issue. - [List Runbook Rules](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/runbooks/list-runbook-rules.md): List all Runbook Rules - [Create Runbook Rule](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/runbooks/create-runbook-rule.md): Create a new Runbook Rule - [Get Runbook Rule](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/runbooks/get-runbook-rule.md): Get a single Runbook Rule by ID - [Update Runbook Rule](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/runbooks/update-runbook-rule.md): Update an existing Runbook Rule by ID - [Delete Runbook Rule](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/runbooks/delete-runbook-rule.md): Delete a Runbook Rule by ID - [ProxyManager Connect](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/proxy-manager/proxymanager-connect.md): Send a connect request to the client. A successful response indicates the client has stablished a connection. If the connection resource has the review enabled, it returns a successful response containing the link of the review in the `Localtion` header. - [ProxyManager Disconnect](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/proxy-manager/proxymanager-disconnect.md): Send a disconnect request. The transport layer will disconnect the connected client asynchronously - [ProxyManager Status](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/proxy-manager/proxymanager-status.md): Get the current status of the client - [Get Compliance Report](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/reports/get-compliance-report.md): Computes the compliance report with an overall score, category summaries, actionable items and per-framework control evaluations. - [Session Reports](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/reports/session-reports.md): The report payload groups sessions by info types and by a custom field (`group_by`) provided by the client. The items returns data containing the sum of redact fields performed by a given info type aggregated by the `group_by` attribute. - [Lists resources](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/resources/lists-resources.md): Lists all resources for the organization. - [Creates a resource](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/resources/creates-a-resource.md): Creates a resource for the organization. - [Applies a batch of resource plans](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/resources/applies-a-batch-of-resource-plans.md): Applies a batch of previously created resource plans. Each item references a plan session by SID and the target resource name. All items are processed concurrently and the response is returned once all have completed. Per-item failures are embedded in the results with status "failed" rather than ret… - [Tests connectivity for multiple resources](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/resources/tests-connectivity-for-multiple-resources.md): Performs concurrent connectivity tests for the given resources. Each execution has a 10-second timeout. - [Creates a batch of resource plans](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/resources/creates-a-batch-of-resource-plans.md): Validates provisioning plans for a batch of resources by computing the diff between the desired and current role state for each resource. Each item is session-audited and receives its own plan ID (SID) that can be referenced when applying. All items are processed concurrently and the response is ret… - [Gets a resource](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/resources/gets-a-resource.md): Gets a resource by ID for the organization. - [Updates a resource](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/resources/updates-a-resource.md): Updates a resource by ID for the organization. - [Deletes a resource](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/resources/deletes-a-resource.md): Deletes a resource by ID for the organization. - [Applies a resource plan](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/resources/applies-a-resource-plan.md): Applies a previously created provisioning plan to a single resource. The plan session referenced by SID must have been created by the plan endpoint. On success, the resulting role and its credentials are synced as a connection. - [Tests connectivity for a resource](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/resources/tests-connectivity-for-a-resource.md): Performs a connectivity test against the resource's master credentials to verify network connectivity. Uses a minimal query (e.g. SELECT 1) to confirm the host is reachable and the master user can authenticate. - [Creates a resource plan](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/resources/creates-a-resource-plan.md): Validates a provisioning plan for a single resource by computing the diff between the desired and current role state. The plan is session-audited and returns a plan ID (SID) that can be referenced when applying. - [Get Review List,](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/reviews/get-review-list.md): Get all reviews resource - [Get Review](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/reviews/get-review.md): Get review resource by the id or session id - [Update Review Status](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/reviews/update-review-status.md): Update the status of a review resource by its resource ID or session ID. This endpoint is used to approve, reject, or revoke reviews for session execution requests. - [Update Review Status By Sid](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/reviews/update-review-status-by-sid.md): Update the status of a review resource by its resource ID or session ID. This endpoint is used to approve, reject, or revoke reviews for session execution requests. - [List Rulepacks](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/rulepacks/list-rulepacks.md): List rulepacks for the organization with optional pagination and search. - [Get Rulepack](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/rulepacks/get-rulepack.md): Get a rulepack by its UUID. - [Apply Rulepack to Connections](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/rulepacks/apply-rulepack-to-connections.md): Replace the set of connections this rulepack is applied to. After the call, the rulepack is attached to exactly the supplied connections (additions and removals as needed). Non-rulepack attributes on each affected connection are preserved. Pass an empty array to remove the rulepack from all connecti… - [Search](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/search/search.md): Performs a search for connections and runbooks based on the provided criteria. - [List Server Logs](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/server-logs/list-server-logs.md): Tail of recent in-memory runtime logs from the gateway process and connected agents - [Stream Server Logs](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/server-logs/stream-server-logs.md): Streams gateway and agent runtime logs in real-time via SSE. Sends a backlog of recent entries on connect, then each new entry as it is captured. - [List Sessions](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/sessions/list-sessions.md): List session resources - [Exec](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/sessions/exec.md): This endpoint performs ad-hoc executions. It will wait 50 seconds for a sucessful response (200), otherwise return an Accepted status code (202) meaning the execution will be held asynchronously. The outcome could be obtained later on by fetching the resource using the attribute `id`. - [Create a provisioned session using API Key](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/sessions/create-a-provisioned-session-using-api-key.md) - [Retry RDP PII analysis](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/sessions/retry-rdp-pii-analysis.md): Resets a failed RDP analysis job to pending so the worker pool can re-claim it. - [Get Session](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/sessions/get-session.md): Get a session by id. This endpoint returns a conditional response - [Download Session](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/sessions/download-session.md): Download session by id - [Download Session Input Command](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/sessions/download-session-input-command.md): Download session input session by id - [Reviewed Exec](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/sessions/reviewed-exec.md): Run an execution in a reviewed session - [Kill Session](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/sessions/kill-session.md) - [Update Session Metadata](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/sessions/update-session-metadata.md) - [Get RDP session PII detections](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/sessions/get-rdp-session-pii-detections.md): Returns PII entity detections with screen-space coordinates for an RDP session recording - [Get RDP session frames](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/sessions/get-rdp-session-frames.md): Returns paginated bitmap frames from an RDP session recording - [Stream Session Result](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/sessions/stream-session-result.md): Returns the decoded output of a session as plain text with chunked transfer encoding - [Stream Session Events](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/sessions/stream-session-events.md): Streams audit events for an open session in real-time via SSE. Each event is published as it is appended to the WAL. No catch-up is sent for events that occurred before the subscription. - [List Sidecars](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/sidecars/list-sidecars.md): List all sidecars for the organization - [Create Sidecar](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/sidecars/create-sidecar.md): Register a sidecar. The token is returned only once in this response and cannot be recovered. - [Sidecar Configuration](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/sidecars/sidecar-configuration.md): Authenticated with the hoop-sidecar-token header. Returns the configuration the sidecar must serve. Unlike the handshake it records nothing, so a poll never overwrites what the sidecar last reported about itself. - [Sidecar Handshake](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/sidecars/sidecar-handshake.md): Authenticated with the hoop-sidecar-token header. Records the reported version and returns the configuration the sidecar must serve. - [Get Sidecar](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/sidecars/get-sidecar.md): Get a sidecar by name or ID - [Update Sidecar](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/sidecars/update-sidecar.md): Replace the configuration a sidecar serves. The sidecar picks it up on its next heartbeat. - [Delete Sidecar](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/sidecars/delete-sidecar.md): Delete a sidecar. The token stops working immediately. - [List SPIFFE Mappings](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/spiffe/list-spiffe-mappings.md): List all SPIFFE-ID to agent mappings in the caller's organization. - [Create SPIFFE Mapping](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/spiffe/create-spiffe-mapping.md): Map a SPIFFE identity (exact URI or URI prefix) onto a Hoop agent. - [Update SPIFFE Mapping](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/spiffe/update-spiffe-mapping.md): Update an existing SPIFFE-ID to agent mapping. - [Delete SPIFFE Mapping](https://hoopdev-docs-control-plane-owns-listeners.mintlify.site/api-reference/spiffe/delete-spiffe-mapping.md): Remove a SPIFFE-ID to agent mapping. ## OpenAPI Specs - [openapiv3](https://use.hoop.dev/api/openapiv3.json) ## Optional - [Community](https://github.com/hoophq/hoop/discussions) - [Blog](https://hoop.dev/blog)