# Hoop.dev - Automated Access and Data Protection ## Docs - [Getting Started](https://hoopdev-feat-new-runbook-parameters.mintlify.site/introduction/getting-started.md): Secure gateway access to your infrastructure with AI-powered security - [Live Data Masking](https://hoopdev-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.mintlify.site/learn/features/access-requests/action.md): Require approval for individual commands before they execute - [Just-in-Time Access Requests](https://hoopdev-feat-new-runbook-parameters.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-feat-new-runbook-parameters.mintlify.site/learn/features/access-control.md): Control who can access which connections with group-based permissions - [Attribute-Based Access Control](https://hoopdev-feat-new-runbook-parameters.mintlify.site/learn/features/abac.md): Apply policies to groups of resource roles using attributes instead of listing every resource role - [Guardrails](https://hoopdev-feat-new-runbook-parameters.mintlify.site/learn/features/guardrails.md): Block dangerous queries before they execute with pattern-based rules - [Runbooks](https://hoopdev-feat-new-runbook-parameters.mintlify.site/learn/features/runbooks.md): Create reusable, parameterized templates for common operations - [Secrets Management](https://hoopdev-feat-new-runbook-parameters.mintlify.site/learn/features/secrets-manager.md): Securely inject credentials into connections without exposing them to users - [Session Recording](https://hoopdev-feat-new-runbook-parameters.mintlify.site/learn/features/session-recording.md): Record and playback terminal sessions and entire databases connections. - [Parallel Mode](https://hoopdev-feat-new-runbook-parameters.mintlify.site/learn/features/parallel-mode.md): Execute commands across multiple resource roles simultaneously - [Web App Overview](https://hoopdev-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.mintlify.site/clients/webapp/managing-access.md): Learn how to control and organize access to your connections through user groups and permissions - [Monitoring Sessions](https://hoopdev-feat-new-runbook-parameters.mintlify.site/clients/webapp/monitoring-sessions.md): Learn how to track and audit connection usage through the Sessions interface - [Command Line](https://hoopdev-feat-new-runbook-parameters.mintlify.site/clients/cli.md): Install and configure the hoop.dev CLI to interact with your applications. - [Catalog](https://hoopdev-feat-new-runbook-parameters.mintlify.site/quickstart/overview.md): Setup your environment by selecting your resource type - [PostgreSQL](https://hoopdev-feat-new-runbook-parameters.mintlify.site/quickstart/databases/postgres.md): A powerful, open-source relational database system known for reliability, feature robustness, and performance. - [MySQL](https://hoopdev-feat-new-runbook-parameters.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-feat-new-runbook-parameters.mintlify.site/quickstart/databases/mongodb.md): A NoSQL document-oriented database that provides high scalability and flexibility for modern applications. - [DynamoDB](https://hoopdev-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.mintlify.site/quickstart/ai-and-llms/claude-code.md): Proxy Claude Code to ensure sensitive data won’t leak. - [AWS CLI](https://hoopdev-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.mintlify.site/quickstart/cloud-services/aws/aws-ssm.md): AWS SSM script permits managing EC2 instances using AWS SSM via Hoop - [Kubernetes](https://hoopdev-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.mintlify.site/quickstart/remote-desktop.md): Remote Desktop Protocol (RDP) allows accessing securely remote Windows instances via RDP protocol. - [Architecture](https://hoopdev-feat-new-runbook-parameters.mintlify.site/setup/architecture.md): Understand how Hoop's components fit together and how traffic flows through the system. - [Overview](https://hoopdev-feat-new-runbook-parameters.mintlify.site/setup/deployment/overview.md): See the options to try out hoop.dev - [Docker](https://hoopdev-feat-new-runbook-parameters.mintlify.site/setup/deployment/docker-compose.md): This deployment leverages `docker compose` to deploy Hoop on local or remote machines for solution assessment. - [Kubernetes](https://hoopdev-feat-new-runbook-parameters.mintlify.site/setup/deployment/kubernetes.md) - [Microsoft Presidio](https://hoopdev-feat-new-runbook-parameters.mintlify.site/setup/deployment/presidio.md) - [AWS](https://hoopdev-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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. - [Action Access Requests Configuration](https://hoopdev-feat-new-runbook-parameters.mintlify.site/setup/configuration/access-requests/action-configuration.md): Configure command-level approval workflows for your connections - [JIT Access Requests Configuration](https://hoopdev-feat-new-runbook-parameters.mintlify.site/setup/configuration/access-requests/jit-configuration.md): Configure time-based access controls for your connections - [Access Control Configuration](https://hoopdev-feat-new-runbook-parameters.mintlify.site/setup/configuration/access-control-configuration.md): Configure group-based access policies for your connections - [Guardrails Configuration](https://hoopdev-feat-new-runbook-parameters.mintlify.site/setup/configuration/guardrails-configuration.md): Create and manage pattern-based rules to block dangerous queries - [Runbooks](https://hoopdev-feat-new-runbook-parameters.mintlify.site/setup/configuration/runbooks-configuration.md) - [Secrets Manager](https://hoopdev-feat-new-runbook-parameters.mintlify.site/setup/configuration/secrets-manager-configuration.md): It enables integration with a known secrets manager, allowing the connection environment variable to be dynamically expanded for each connection. - [Aws Rds IAM Auth](https://hoopdev-feat-new-runbook-parameters.mintlify.site/setup/configuration/rds-iam-auth.md): It enables integration with AWS IAM Auth for RDS instances. - [Environment Variables](https://hoopdev-feat-new-runbook-parameters.mintlify.site/setup/configuration/env-vars.md): Describe how to configure the Hoop Gateway via environment variables - [Reverse Proxy](https://hoopdev-feat-new-runbook-parameters.mintlify.site/setup/configuration/reverse-proxy.md): Deploying Hoop Behind a Reverse Proxy - [Overview](https://hoopdev-feat-new-runbook-parameters.mintlify.site/setup/configuration/idp/get-started.md): Connect hoop.dev to your Identity Provider using OIDC or SAML 2.0 - [Auth0](https://hoopdev-feat-new-runbook-parameters.mintlify.site/setup/configuration/idp/auth0.md) - [Okta](https://hoopdev-feat-new-runbook-parameters.mintlify.site/setup/configuration/idp/okta.md) - [Google](https://hoopdev-feat-new-runbook-parameters.mintlify.site/setup/configuration/idp/google.md) - [Azure](https://hoopdev-feat-new-runbook-parameters.mintlify.site/setup/configuration/idp/azure.md) - [JumpCloud](https://hoopdev-feat-new-runbook-parameters.mintlify.site/setup/configuration/idp/jumpcloud.md) - [AWS Cognito](https://hoopdev-feat-new-runbook-parameters.mintlify.site/setup/configuration/idp/aws-cognito.md) - [OneLogin (SAML 2.0)](https://hoopdev-feat-new-runbook-parameters.mintlify.site/setup/configuration/idp/onelogin.md) - [API Key](https://hoopdev-feat-new-runbook-parameters.mintlify.site/setup/apis/api-key.md): Learn how the API Key feature works and how to use it - [Service Accounts](https://hoopdev-feat-new-runbook-parameters.mintlify.site/setup/apis/service-accounts.md): Configure service accounts by leveraging Oauth2 Client Credentials Grant Type - [Webhooks / SIEM](https://hoopdev-feat-new-runbook-parameters.mintlify.site/setup/apis/webhooks-siem.md): Forward session events to external systems using runbook hooks. - [Updating Hoop](https://hoopdev-feat-new-runbook-parameters.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-feat-new-runbook-parameters.mintlify.site/setup/license-management.md): Managing License for your Hoop Installation - [Agents](https://hoopdev-feat-new-runbook-parameters.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-feat-new-runbook-parameters.mintlify.site/concepts/resource-roles.md): The bridge between users and resources - [Slack](https://hoopdev-feat-new-runbook-parameters.mintlify.site/integrations/slack.md): Manage access requests directly from your Slack workspace. - [Teams](https://hoopdev-feat-new-runbook-parameters.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-feat-new-runbook-parameters.mintlify.site/integrations/jira.md): Automate change management and security workflows by integrating Jira with your infrastructure access requests. - [SIEM](https://hoopdev-feat-new-runbook-parameters.mintlify.site/integrations/siem.md): Forward session events to your SIEM or logging pipeline using runbook hooks. - [Svix](https://hoopdev-feat-new-runbook-parameters.mintlify.site/integrations/svix.md): Integrate with Svix to have wehbooks/SIEM properly configured. - [AWS Connect](https://hoopdev-feat-new-runbook-parameters.mintlify.site/integrations/aws.md): Database Resource Discovery and Automatic Connection Creation. - [Microsoft Presidio](https://hoopdev-feat-new-runbook-parameters.mintlify.site/integrations/ms-presidio.md): Enable sensitive data detection, masking, and guardrail enforcement using Microsoft Presidio. - [List Access Request Rules](https://hoopdev-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.mintlify.site/api-reference/access-request-rules/delete-access-request-rule.md): Delete an access request rule by name - [List Agent Keys](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/agents/list-agent-keys.md): List all agent keys - [Create Agent Key](https://hoopdev-feat-new-runbook-parameters.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-feat-new-runbook-parameters.mintlify.site/api-reference/agents/get-agent-key.md): Get an agent key by name or ID - [Delete Agent Key](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/agents/delete-agent-key.md): Remove an agent key. It will invalidate a running agent - [Get AI Session Analyzer Provider](https://hoopdev-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.mintlify.site/api-reference/ai/delete-ai-session-analyzer-rule.md): Delete an AI session analyzer rule - [Get AI Session Analyzer Rule by Connection](https://hoopdev-feat-new-runbook-parameters.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 Attributes](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/attributes/list-attributes.md): List attributes for the organization with optional pagination and search. - [Create Attribute](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/attributes/create-attribute.md): Create a new attribute for the organization. - [Get Attribute](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/attributes/get-attribute.md): Get an attribute by name or ID. - [Update Attribute](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/attributes/update-attribute.md): Rename an existing attribute. - [Delete Attribute](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/attributes/delete-attribute.md): Delete an attribute by name or ID. - [List security audit logs](https://hoopdev-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.mintlify.site/api-reference/authentication/saml-|-login.md): Returns the login url to perform the signin on the identity provider. - [OIDC | Signup](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/authentication/oidc-|-signup.md): Signup anonymous authenticated user. This endpoint is only used for multi tenant setups. - [List Connections](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/connections/list-connections.md): List all connections. - [Create Connection](https://hoopdev-feat-new-runbook-parameters.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-feat-new-runbook-parameters.mintlify.site/api-reference/connections/list-connection-tags.md): List all Connection Tags. - [Get Connection](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/connections/get-connection.md): Get resource by name or id - [Update Connection](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/connections/update-connection.md): Update a connection resource - [Patch Connection](https://hoopdev-feat-new-runbook-parameters.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-feat-new-runbook-parameters.mintlify.site/api-reference/connections/get-table-columns.md): Get columns from a specific table - [Create Connection Credentials](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/connections/create-connection-credentials.md): Create Connection Credentials - [List Databases](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/connections/list-databases.md): List all available databases for a database connection - [Update Data Masking Rule Connections](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/connections/update-data-masking-rule-connections.md): Update Data Masking Rule Connections - [List Database Tables](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/connections/list-database-tables.md): List tables from a database without column details - [Test Connection](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/connections/test-connection.md): Test resource by name or id (only for database connections, it will attempt a simple ping). - [Delete Connection](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/connections/delete-connection.md): Delete a connection resource. - [List Data Masking Rules](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/data-masking-rules/list-data-masking-rules.md): List Data Masking Rules - [Create Data Masking Rule](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/data-masking-rules/create-data-masking-rule.md): Create Data Masking Rule - [Get Data Masking Rule](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/data-masking-rules/get-data-masking-rule.md): Get Data Masking Rule - [Update Data Masking Rule](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/data-masking-rules/update-data-masking-rule.md): Update Data Masking Rule - [Delete Data Masking Rule](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/data-masking-rules/delete-data-masking-rule.md): Delete a Data Masking Rule resource. - [List DB Role Jobs](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/aws/list-db-role-jobs.md): List all db role jobs - [Create Database Role Job](https://hoopdev-feat-new-runbook-parameters.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-feat-new-runbook-parameters.mintlify.site/api-reference/aws/get-db-role-job.md): Get DB Role job by id - [Update IAM Access Key](https://hoopdev-feat-new-runbook-parameters.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-feat-new-runbook-parameters.mintlify.site/api-reference/aws/delete-iam-access-key.md): Remove IAM Access Key from memory - [Get Caller Identity](https://hoopdev-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.mintlify.site/api-reference/aws/list-database-instances.md): It list RDS Database Instances - [OpenAI Chat Completions](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/features/openai-chat-completions.md): Proxy to OpenAI chat completions `/vi/chat/completions` - [Feature Update](https://hoopdev-feat-new-runbook-parameters.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-feat-new-runbook-parameters.mintlify.site/api-reference/features/get-webhooks-dashboard.md): Get webhooks dashboard url - [List Guard Rail Rules](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/guard-rails/list-guard-rail-rules.md): List Guard Rail Rules - [Create Guard Rail Rules](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/guard-rails/create-guard-rail-rules.md): Create Guard Rail Rules - [Get Guard Rail Rules](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/guard-rails/get-guard-rail-rules.md): Get Guard Rail Rules - [Update Guard Rail Rules](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/guard-rails/update-guard-rail-rules.md): Update Guard Rail Rules - [Delete a Rule](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/guard-rails/delete-a-rule.md): Delete a Guard Rail Rule resource. - [HealthCheck](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/server-management/healthcheck.md): Reports if the service is working properly - [Update Org License](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/server-management/update-org-license.md): Upload a new license into the system - [Sign License](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/server-management/sign-license.md): Sign a new license for a customer. This route is for internal use only - [Get Public Server Info](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/server-management/get-public-server-info.md): Get public server information - [Get Authentication Configuration](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/server-management/get-authentication-configuration.md): Get authentication configuration - [Update Authentication Configuration](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/server-management/update-authentication-configuration.md): Update authentication configuration - [Generate API Key](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/server-management/generate-api-key.md): Generate a rollout api key - [Get Server Miscellaneous Configuration](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/server-management/get-server-miscellaneous-configuration.md): Get server miscellaneous configuration - [Update Server Miscellaneous Configuration](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/server-management/update-server-miscellaneous-configuration.md): Update server miscellaneous configuration - [Get Server Info](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/server-management/get-server-info.md): Get server information - [Get Jira Integration](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/jira/get-jira-integration.md): Get Jira integration for the organization - [Update Jira Integration](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/jira/update-jira-integration.md): Update the Jira integration for the organization - [Create Jira Integration](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/jira/create-jira-integration.md): Create a new Jira integration for the organization - [Get Asset Objects](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/jira/get-asset-objects.md): Get objects from the Jira Service Management (JSM) Assets API - [List Issue Templates](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/jira/list-issue-templates.md): List Issue Templates - [Create Issue Templates](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/jira/create-issue-templates.md): Create Issue Templates - [Get Issue Templates](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/jira/get-issue-templates.md): Get Issue Templates - [Update Issue Templates](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/jira/update-issue-templates.md): Update Issue Templates - [Delete Issue Templates](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/jira/delete-issue-templates.md): Delete Issue Templates - [Get Session Metrics](https://hoopdev-feat-new-runbook-parameters.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… - [Get Org Key](https://hoopdev-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.mintlify.site/api-reference/organization-management/revoke-org-key.md): Remove organization key - [List Plugins](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/plugins/list-plugins.md): List all Plugin resources - [Create Plugin](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/plugins/create-plugin.md): Create Plugin resource - [Get Plugin](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/plugins/get-plugin.md): Get a plugin resource by name - [Update Plugin](https://hoopdev-feat-new-runbook-parameters.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-feat-new-runbook-parameters.mintlify.site/api-reference/plugins/update-plugin-config.md): Update the Plugin resource top level configuration. - [Get Plugin Connection](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/plugins/get-plugin-connection.md): Get a plugin connection resource - [Upsert Plugin Connection](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/plugins/upsert-plugin-connection.md): Update or create a plugin connection resource - [Delete Plugin Connection](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/plugins/delete-plugin-connection.md): Delete a plugin connection resource. - [Runbook Exec](https://hoopdev-feat-new-runbook-parameters.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-feat-new-runbook-parameters.mintlify.site/api-reference/runbooks/list-runbooks-by-connection.md): List Runbooks templates by connection - [List Runbooks](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/runbooks/list-runbooks.md): List all Runbooks - [List Runbooks](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/runbooks/list-runbooks-1.md): List all Runbooks - [Get Runbook Configuration](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/runbooks/get-runbook-configuration.md): Get Runbook Configuration - [Update Runbook Configuration](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/runbooks/update-runbook-configuration.md): Update Runbook Configuration - [Create Runbook Configuration Entry](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/runbooks/create-runbook-configuration-entry.md): Create Runbook Configuration Entry - [Update Runbook Configuration Entry](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/runbooks/update-runbook-configuration-entry.md): Update Runbook Configuration Entry - [Delete Runbook Configuration Entry](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/runbooks/delete-runbook-configuration-entry.md): Delete a runbook configuration entry. - [Runbook Exec](https://hoopdev-feat-new-runbook-parameters.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-feat-new-runbook-parameters.mintlify.site/api-reference/runbooks/list-runbook-rules.md): List all Runbook Rules - [Create Runbook Rule](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/runbooks/create-runbook-rule.md): Create a new Runbook Rule - [Get Runbook Rule](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/runbooks/get-runbook-rule.md): Get a single Runbook Rule by ID - [Update Runbook Rule](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/runbooks/update-runbook-rule.md): Update an existing Runbook Rule by ID - [Delete Runbook Rule](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/runbooks/delete-runbook-rule.md): Delete a Runbook Rule by ID - [ProxyManager Connect](https://hoopdev-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.mintlify.site/api-reference/proxy-manager/proxymanager-status.md): Get the current status of the client - [Session Reports](https://hoopdev-feat-new-runbook-parameters.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-feat-new-runbook-parameters.mintlify.site/api-reference/resources/lists-resources.md): Lists all resources for the organization. - [Creates a resource](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/resources/creates-a-resource.md): Creates a resource for the organization. - [Gets a resource](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/resources/gets-a-resource.md): Gets a resource by ID for the organization. - [Updates a resource](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/resources/updates-a-resource.md): Updates a resource by ID for the organization. - [Deletes a resource](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/resources/deletes-a-resource.md): Deletes a resource by ID for the organization. - [Get Review List,](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/reviews/get-review-list.md): Get all reviews resource - [Get Review](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/reviews/get-review.md): Get review resource by the id or session id - [Update Review Status](https://hoopdev-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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. - [Search](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/search/search.md): Performs a search for connections and runbooks based on the provided criteria. - [List Service Accounts](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/user-management/list-service-accounts.md): List all service accounts - [Create Service Account](https://hoopdev-feat-new-runbook-parameters.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-feat-new-runbook-parameters.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-feat-new-runbook-parameters.mintlify.site/api-reference/user-management/get-userinfo.md): Get own user's information - [List Users](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/user-management/list-users.md): List all users - [Create User](https://hoopdev-feat-new-runbook-parameters.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-feat-new-runbook-parameters.mintlify.site/api-reference/user-management/list-user-groups.md): List all groups from all users - [Create User Group](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/user-management/create-user-group.md): Create a new user group - [Delete User Group](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/user-management/delete-user-group.md): Delete a user group - [Patch User Slack ID](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/user-management/patch-user-slack-id.md): Patch own user's slack id - [Get User](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/user-management/get-user.md): Get user by email or subject id - [Update User](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/user-management/update-user.md): Updates an existing user - [Delete User](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/user-management/delete-user.md): Delete a user. - [List Sessions](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/sessions/list-sessions.md): List session resources - [Exec](https://hoopdev-feat-new-runbook-parameters.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-feat-new-runbook-parameters.mintlify.site/api-reference/sessions/create-a-provisioned-session-using-api-key.md) - [Get Session](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/sessions/get-session.md): Get a session by id. This endpoint returns a conditional response - [Download Session](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/sessions/download-session.md): Download session by id - [Download Session Input Command](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/sessions/download-session-input-command.md): Download session input session by id - [Reviewed Exec](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/sessions/reviewed-exec.md): Run an execution in a reviewed session - [Kill Session](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/sessions/kill-session.md) - [Update Session Metadata](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/sessions/update-session-metadata.md) - [Get RDP session frames](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/sessions/get-rdp-session-frames.md): Returns paginated bitmap frames from an RDP session recording - [Stream Session Result](https://hoopdev-feat-new-runbook-parameters.mintlify.site/api-reference/sessions/stream-session-result.md): Returns the decoded output of a session as plain text with chunked transfer encoding - [Product updates](https://hoopdev-feat-new-runbook-parameters.mintlify.site/changelog.md): Track all updates, improvements, and fixes to our platform - [1.43.1](https://hoopdev-feat-new-runbook-parameters.mintlify.site/changelog/1.43.1.md): New runbooks v2 API with multi-repository support, connection-based access control, and improved execution capabilities. - [1.43.0](https://hoopdev-feat-new-runbook-parameters.mintlify.site/changelog/1.43.0.md): This release brings major upgrades to RDP access and TLS handling, making Hoop even more seamless and secure across your infrastructure. - [1.42.9](https://hoopdev-feat-new-runbook-parameters.mintlify.site/changelog/1.42.9.md): Data masking for MongoDB, RDP improvements, and a crucial fix for connection form persistence. This one's all about reliability and security. - [1.42.6](https://hoopdev-feat-new-runbook-parameters.mintlify.site/changelog/1.42.6.md): Bug fixes and user experience improvements for runbook management, including scrolling fixes and keyboard shortcuts. - [1.42.5](https://hoopdev-feat-new-runbook-parameters.mintlify.site/changelog/1.42.5.md): Terminal fixes and a solid foundation for what's coming next. We squashed navigation bugs and built out the resources infrastructure to power better connection management. - [1.42.4](https://hoopdev-feat-new-runbook-parameters.mintlify.site/changelog/1.42.4.md): Redis connection setup just got lighter. We removed mandatory authentication parameters to make local and development environments easier to configure. - [1.42.1](https://hoopdev-feat-new-runbook-parameters.mintlify.site/changelog/1.42.1.md): A quick patch fixing a critical issue with HTTP proxy environment variables. Sometimes the smallest fixes make the biggest difference. - [1.42.0](https://hoopdev-feat-new-runbook-parameters.mintlify.site/changelog/1.42.0.md): This release is all about clarity and speed. Runbooks now have a proper home, connection setup feels smoother with the new Resources Catalog, and the proxy got a tune-up for better performance. It’s a solid round of polish that sets the stage for what’s next. - [1.41.0](https://hoopdev-feat-new-runbook-parameters.mintlify.site/changelog/1.41.0.md): We're back with another patch update. We've got some new features, we killed some more bugs, and one of our engineers started doing something with cookies! - [1.40.1](https://hoopdev-feat-new-runbook-parameters.mintlify.site/changelog/1.40.1.md): This is the first of our patch update blogs. This is where we'll post small (but mighty) feature updates as well as documenting the bugs that we step on. ## OpenAPI Specs - [openapiv3](https://use.hoop.dev/api/openapiv3.json) ## Optional - [Community](https://github.com/hoophq/hoop/discussions) - [Blog](https://hoop.dev/blog)