# Hoop.dev - Automated Access and Data Protection ## Docs - [Container Images](https://hoopdev-doc-container-images.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. - [HealthCheck](https://hoopdev-doc-container-images.mintlify.site/api-reference/server-management/healthcheck.md): Reports if the service is working properly - [Register MCP OAuth Client](https://hoopdev-doc-container-images.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-doc-container-images.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-doc-container-images.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-doc-container-images.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-doc-container-images.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-doc-container-images.mintlify.site/api-reference/server-management/update-org-license.md): Upload a new license into the system - [Sign License](https://hoopdev-doc-container-images.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 Protection Profile](https://hoopdev-doc-container-images.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-doc-container-images.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-doc-container-images.mintlify.site/api-reference/server-management/get-public-server-info.md): Get public server information - [Get Authentication Configuration](https://hoopdev-doc-container-images.mintlify.site/api-reference/server-management/get-authentication-configuration.md): Get authentication configuration - [Update Authentication Configuration](https://hoopdev-doc-container-images.mintlify.site/api-reference/server-management/update-authentication-configuration.md): Update authentication configuration - [Generate API Key](https://hoopdev-doc-container-images.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-doc-container-images.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-doc-container-images.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-doc-container-images.mintlify.site/api-reference/server-management/get-server-miscellaneous-configuration.md): Get server miscellaneous configuration - [Update Server Miscellaneous Configuration](https://hoopdev-doc-container-images.mintlify.site/api-reference/server-management/update-server-miscellaneous-configuration.md): Update server miscellaneous configuration - [Get Server Info](https://hoopdev-doc-container-images.mintlify.site/api-reference/server-management/get-server-info.md): Get server information - [Delete Access Request Rule](https://hoopdev-doc-container-images.mintlify.site/api-reference/access-request-rules/delete-access-request-rule.md): Delete an access request rule by name - [List Agent Keys](https://hoopdev-doc-container-images.mintlify.site/api-reference/agents/list-agent-keys.md): List all agent keys - [Create Agent Key](https://hoopdev-doc-container-images.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-doc-container-images.mintlify.site/api-reference/agents/get-agent-key.md): Get an agent key by name or ID - [Delete Agent Key](https://hoopdev-doc-container-images.mintlify.site/api-reference/agents/delete-agent-key.md): Remove an agent key. It will invalidate a running agent - [List AI Agents](https://hoopdev-doc-container-images.mintlify.site/api-reference/ai-agents/list-ai-agents.md): List all AI Agents for the organization - [Create AI Agent](https://hoopdev-doc-container-images.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-doc-container-images.mintlify.site/api-reference/ai-agents/get-ai-agent.md): Get an AI Agent by name or ID - [Update AI Agent](https://hoopdev-doc-container-images.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-doc-container-images.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-doc-container-images.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-doc-container-images.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-doc-container-images.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-doc-container-images.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-doc-container-images.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-doc-container-images.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-doc-container-images.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-doc-container-images.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-doc-container-images.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-doc-container-images.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-doc-container-images.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-doc-container-images.mintlify.site/api-reference/api-keys/list-api-keys.md): List all API keys for the organization - [Create API Key](https://hoopdev-doc-container-images.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-doc-container-images.mintlify.site/api-reference/api-keys/get-api-key.md): Get an API key by name or ID - [Update API Key](https://hoopdev-doc-container-images.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-doc-container-images.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-doc-container-images.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-doc-container-images.mintlify.site/api-reference/attributes/list-attributes.md): List attributes for the organization with optional pagination and search. - [Create Attribute](https://hoopdev-doc-container-images.mintlify.site/api-reference/attributes/create-attribute.md): Create a new attribute for the organization. - [Get Attribute](https://hoopdev-doc-container-images.mintlify.site/api-reference/attributes/get-attribute.md): Get an attribute by name or ID. - [Update Attribute](https://hoopdev-doc-container-images.mintlify.site/api-reference/attributes/update-attribute.md): Rename an existing attribute. - [Delete Attribute](https://hoopdev-doc-container-images.mintlify.site/api-reference/attributes/delete-attribute.md): Delete an attribute by name or ID. - [List security audit logs](https://hoopdev-doc-container-images.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-doc-container-images.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-doc-container-images.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-doc-container-images.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-doc-container-images.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-doc-container-images.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-doc-container-images.mintlify.site/api-reference/authentication/saml-|-login.md): Returns the login url to perform the signin on the identity provider. - [OIDC | Signup](https://hoopdev-doc-container-images.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-doc-container-images.mintlify.site/api-reference/connections/list-connections.md): List all connections. - [Create Connection](https://hoopdev-doc-container-images.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-doc-container-images.mintlify.site/api-reference/connections/list-connection-tags.md): List all Connection Tags. - [Get Connection](https://hoopdev-doc-container-images.mintlify.site/api-reference/connections/get-connection.md): Get resource by name or id - [Update Connection](https://hoopdev-doc-container-images.mintlify.site/api-reference/connections/update-connection.md): Update a connection resource - [Delete Connection](https://hoopdev-doc-container-images.mintlify.site/api-reference/connections/delete-connection.md): Delete a connection resource. - [Patch Connection](https://hoopdev-doc-container-images.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-doc-container-images.mintlify.site/api-reference/connections/get-table-columns.md): Get columns from a specific table - [Get Active Connection Credentials](https://hoopdev-doc-container-images.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-doc-container-images.mintlify.site/api-reference/connections/create-connection-credentials.md): Create Connection Credentials - [Close Connection Credentials Session](https://hoopdev-doc-container-images.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-doc-container-images.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-doc-container-images.mintlify.site/api-reference/connections/resume-connection-credentials-request.md): Resume a connection credentials request after review approval - [List Databases](https://hoopdev-doc-container-images.mintlify.site/api-reference/connections/list-databases.md): List all available databases for a database connection - [Update Data Masking Rule Connections](https://hoopdev-doc-container-images.mintlify.site/api-reference/connections/update-data-masking-rule-connections.md): Update Data Masking Rule Connections - [Get Federation Configuration for a Connection](https://hoopdev-doc-container-images.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-doc-container-images.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-doc-container-images.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-doc-container-images.mintlify.site/api-reference/connections/list-database-tables.md): List tables from a database without column details - [Test Connection](https://hoopdev-doc-container-images.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-doc-container-images.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-doc-container-images.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-doc-container-images.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-doc-container-images.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-doc-container-images.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-doc-container-images.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-doc-container-images.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-doc-container-images.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-doc-container-images.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-doc-container-images.mintlify.site/api-reference/data-masking-rules/list-data-masking-rules.md): List Data Masking Rules - [Create Data Masking Rule](https://hoopdev-doc-container-images.mintlify.site/api-reference/data-masking-rules/create-data-masking-rule.md): Create Data Masking Rule - [Get Data Masking Rule](https://hoopdev-doc-container-images.mintlify.site/api-reference/data-masking-rules/get-data-masking-rule.md): Get Data Masking Rule - [Update Data Masking Rule](https://hoopdev-doc-container-images.mintlify.site/api-reference/data-masking-rules/update-data-masking-rule.md): Update Data Masking Rule - [Delete Data Masking Rule](https://hoopdev-doc-container-images.mintlify.site/api-reference/data-masking-rules/delete-data-masking-rule.md): Delete a Data Masking Rule resource. - [List DB Role Jobs](https://hoopdev-doc-container-images.mintlify.site/api-reference/aws/list-db-role-jobs.md): List all db role jobs - [Create Database Role Job](https://hoopdev-doc-container-images.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-doc-container-images.mintlify.site/api-reference/aws/get-db-role-job.md): Get DB Role job by id - [Update IAM Access Key](https://hoopdev-doc-container-images.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-doc-container-images.mintlify.site/api-reference/aws/delete-iam-access-key.md): Remove IAM Access Key from memory - [Get Caller Identity](https://hoopdev-doc-container-images.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-doc-container-images.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-doc-container-images.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-doc-container-images.mintlify.site/api-reference/aws/list-database-instances.md): It list RDS Database Instances - [List Feature Flags](https://hoopdev-doc-container-images.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-doc-container-images.mintlify.site/api-reference/feature-flags/update-feature-flag.md): Enable or disable a feature flag for the organization - [OpenAI Chat Completions](https://hoopdev-doc-container-images.mintlify.site/api-reference/features/openai-chat-completions.md): Proxy to OpenAI chat completions `/vi/chat/completions` - [Feature Update](https://hoopdev-doc-container-images.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-doc-container-images.mintlify.site/api-reference/features/get-webhooks-dashboard.md): Get webhooks dashboard url - [List Guard Rail Rules](https://hoopdev-doc-container-images.mintlify.site/api-reference/guard-rails/list-guard-rail-rules.md): List Guard Rail Rules - [Create Guard Rail Rules](https://hoopdev-doc-container-images.mintlify.site/api-reference/guard-rails/create-guard-rail-rules.md): Create Guard Rail Rules - [Get Guard Rail Rules](https://hoopdev-doc-container-images.mintlify.site/api-reference/guard-rails/get-guard-rail-rules.md): Get Guard Rail Rules - [Update Guard Rail Rules](https://hoopdev-doc-container-images.mintlify.site/api-reference/guard-rails/update-guard-rail-rules.md): Update Guard Rail Rules - [Delete a Rule](https://hoopdev-doc-container-images.mintlify.site/api-reference/guard-rails/delete-a-rule.md): Delete a Guard Rail Rule resource. - [Get Jira Integration](https://hoopdev-doc-container-images.mintlify.site/api-reference/jira/get-jira-integration.md): Get Jira integration for the organization - [Update Jira Integration](https://hoopdev-doc-container-images.mintlify.site/api-reference/jira/update-jira-integration.md): Update the Jira integration for the organization - [Create Jira Integration](https://hoopdev-doc-container-images.mintlify.site/api-reference/jira/create-jira-integration.md): Create a new Jira integration for the organization - [Get Asset Objects](https://hoopdev-doc-container-images.mintlify.site/api-reference/jira/get-asset-objects.md): Get objects from the Jira Service Management (JSM) Assets API - [List Issue Templates](https://hoopdev-doc-container-images.mintlify.site/api-reference/jira/list-issue-templates.md): List Issue Templates - [Create Issue Templates](https://hoopdev-doc-container-images.mintlify.site/api-reference/jira/create-issue-templates.md): Create Issue Templates - [Get Issue Templates](https://hoopdev-doc-container-images.mintlify.site/api-reference/jira/get-issue-templates.md): Get Issue Templates - [Update Issue Templates](https://hoopdev-doc-container-images.mintlify.site/api-reference/jira/update-issue-templates.md): Update Issue Templates - [Delete Issue Templates](https://hoopdev-doc-container-images.mintlify.site/api-reference/jira/delete-issue-templates.md): Delete Issue Templates - [List Machine Identities](https://hoopdev-doc-container-images.mintlify.site/api-reference/machine-identities/list-machine-identities.md): List all machine identities (non-human identities) - [Create Machine Identity](https://hoopdev-doc-container-images.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-doc-container-images.mintlify.site/api-reference/machine-identities/get-machine-identity.md): Get a machine identity by name - [Update Machine Identity](https://hoopdev-doc-container-images.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-doc-container-images.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-doc-container-images.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-doc-container-images.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-doc-container-images.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-doc-container-images.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-doc-container-images.mintlify.site/api-reference/user-management/list-service-accounts.md): List all service accounts - [Create Service Account](https://hoopdev-doc-container-images.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-doc-container-images.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-doc-container-images.mintlify.site/api-reference/user-management/get-userinfo.md): Get own user's information - [List Users](https://hoopdev-doc-container-images.mintlify.site/api-reference/user-management/list-users.md): List all users - [Create User](https://hoopdev-doc-container-images.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-doc-container-images.mintlify.site/api-reference/user-management/list-user-groups.md): List all groups from all users - [Create User Group](https://hoopdev-doc-container-images.mintlify.site/api-reference/user-management/create-user-group.md): Create a new user group - [Delete User Group](https://hoopdev-doc-container-images.mintlify.site/api-reference/user-management/delete-user-group.md): Delete a user group - [Patch User Slack ID](https://hoopdev-doc-container-images.mintlify.site/api-reference/user-management/patch-user-slack-id.md): Patch own user's slack id - [Get User](https://hoopdev-doc-container-images.mintlify.site/api-reference/user-management/get-user.md): Get user by email or subject id - [Update User](https://hoopdev-doc-container-images.mintlify.site/api-reference/user-management/update-user.md): Updates an existing user - [Delete User](https://hoopdev-doc-container-images.mintlify.site/api-reference/user-management/delete-user.md): Delete a user. - [Get Org Key](https://hoopdev-doc-container-images.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-doc-container-images.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-doc-container-images.mintlify.site/api-reference/organization-management/revoke-org-key.md): Remove organization key - [List Plugins](https://hoopdev-doc-container-images.mintlify.site/api-reference/plugins/list-plugins.md): List all Plugin resources - [Create Plugin](https://hoopdev-doc-container-images.mintlify.site/api-reference/plugins/create-plugin.md): Create Plugin resource - [Get Plugin](https://hoopdev-doc-container-images.mintlify.site/api-reference/plugins/get-plugin.md): Get a plugin resource by name - [Update Plugin](https://hoopdev-doc-container-images.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-doc-container-images.mintlify.site/api-reference/plugins/update-plugin-config.md): Update the Plugin resource top level configuration. - [Get Plugin Connection](https://hoopdev-doc-container-images.mintlify.site/api-reference/plugins/get-plugin-connection.md): Get a plugin connection resource - [Upsert Plugin Connection](https://hoopdev-doc-container-images.mintlify.site/api-reference/plugins/upsert-plugin-connection.md): Update or create a plugin connection resource - [Delete Plugin Connection](https://hoopdev-doc-container-images.mintlify.site/api-reference/plugins/delete-plugin-connection.md): Delete a plugin connection resource. - [Runbook Exec](https://hoopdev-doc-container-images.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-doc-container-images.mintlify.site/api-reference/runbooks/list-runbooks-by-connection.md): List Runbooks templates by connection - [List Runbooks](https://hoopdev-doc-container-images.mintlify.site/api-reference/runbooks/list-runbooks.md): List all Runbooks - [List Runbooks](https://hoopdev-doc-container-images.mintlify.site/api-reference/runbooks/list-runbooks-1.md): List all Runbooks - [Get Runbook Configuration](https://hoopdev-doc-container-images.mintlify.site/api-reference/runbooks/get-runbook-configuration.md): Get Runbook Configuration - [Update Runbook Configuration](https://hoopdev-doc-container-images.mintlify.site/api-reference/runbooks/update-runbook-configuration.md): Update Runbook Configuration - [Create Runbook Configuration Entry](https://hoopdev-doc-container-images.mintlify.site/api-reference/runbooks/create-runbook-configuration-entry.md): Create Runbook Configuration Entry - [Update Runbook Configuration Entry](https://hoopdev-doc-container-images.mintlify.site/api-reference/runbooks/update-runbook-configuration-entry.md): Update Runbook Configuration Entry - [Delete Runbook Configuration Entry](https://hoopdev-doc-container-images.mintlify.site/api-reference/runbooks/delete-runbook-configuration-entry.md): Delete a runbook configuration entry. - [Create Runbook File](https://hoopdev-doc-container-images.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-doc-container-images.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-doc-container-images.mintlify.site/api-reference/runbooks/list-runbook-rules.md): List all Runbook Rules - [Create Runbook Rule](https://hoopdev-doc-container-images.mintlify.site/api-reference/runbooks/create-runbook-rule.md): Create a new Runbook Rule - [Get Runbook Rule](https://hoopdev-doc-container-images.mintlify.site/api-reference/runbooks/get-runbook-rule.md): Get a single Runbook Rule by ID - [Update Runbook Rule](https://hoopdev-doc-container-images.mintlify.site/api-reference/runbooks/update-runbook-rule.md): Update an existing Runbook Rule by ID - [Delete Runbook Rule](https://hoopdev-doc-container-images.mintlify.site/api-reference/runbooks/delete-runbook-rule.md): Delete a Runbook Rule by ID - [ProxyManager Connect](https://hoopdev-doc-container-images.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-doc-container-images.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-doc-container-images.mintlify.site/api-reference/proxy-manager/proxymanager-status.md): Get the current status of the client - [Session Reports](https://hoopdev-doc-container-images.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-doc-container-images.mintlify.site/api-reference/resources/lists-resources.md): Lists all resources for the organization. - [Creates a resource](https://hoopdev-doc-container-images.mintlify.site/api-reference/resources/creates-a-resource.md): Creates a resource for the organization. - [Applies a batch of resource plans](https://hoopdev-doc-container-images.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-doc-container-images.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-doc-container-images.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-doc-container-images.mintlify.site/api-reference/resources/gets-a-resource.md): Gets a resource by ID for the organization. - [Updates a resource](https://hoopdev-doc-container-images.mintlify.site/api-reference/resources/updates-a-resource.md): Updates a resource by ID for the organization. - [Deletes a resource](https://hoopdev-doc-container-images.mintlify.site/api-reference/resources/deletes-a-resource.md): Deletes a resource by ID for the organization. - [Applies a resource plan](https://hoopdev-doc-container-images.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-doc-container-images.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-doc-container-images.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-doc-container-images.mintlify.site/api-reference/reviews/get-review-list.md): Get all reviews resource - [Get Review](https://hoopdev-doc-container-images.mintlify.site/api-reference/reviews/get-review.md): Get review resource by the id or session id - [Update Review Status](https://hoopdev-doc-container-images.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-doc-container-images.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-doc-container-images.mintlify.site/api-reference/rulepacks/list-rulepacks.md): List rulepacks for the organization with optional pagination and search. - [Get Rulepack](https://hoopdev-doc-container-images.mintlify.site/api-reference/rulepacks/get-rulepack.md): Get a rulepack by its UUID. - [Apply Rulepack to Connections](https://hoopdev-doc-container-images.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-doc-container-images.mintlify.site/api-reference/search/search.md): Performs a search for connections and runbooks based on the provided criteria. - [List Server Logs](https://hoopdev-doc-container-images.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-doc-container-images.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-doc-container-images.mintlify.site/api-reference/sessions/list-sessions.md): List session resources - [Exec](https://hoopdev-doc-container-images.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-doc-container-images.mintlify.site/api-reference/sessions/create-a-provisioned-session-using-api-key.md) - [Retry RDP PII analysis](https://hoopdev-doc-container-images.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-doc-container-images.mintlify.site/api-reference/sessions/get-session.md): Get a session by id. This endpoint returns a conditional response - [Download Session](https://hoopdev-doc-container-images.mintlify.site/api-reference/sessions/download-session.md): Download session by id - [Download Session Input Command](https://hoopdev-doc-container-images.mintlify.site/api-reference/sessions/download-session-input-command.md): Download session input session by id - [Reviewed Exec](https://hoopdev-doc-container-images.mintlify.site/api-reference/sessions/reviewed-exec.md): Run an execution in a reviewed session - [Kill Session](https://hoopdev-doc-container-images.mintlify.site/api-reference/sessions/kill-session.md) - [Update Session Metadata](https://hoopdev-doc-container-images.mintlify.site/api-reference/sessions/update-session-metadata.md) - [Get RDP session PII detections](https://hoopdev-doc-container-images.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-doc-container-images.mintlify.site/api-reference/sessions/get-rdp-session-frames.md): Returns paginated bitmap frames from an RDP session recording - [Stream Session Result](https://hoopdev-doc-container-images.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-doc-container-images.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 SPIFFE Mappings](https://hoopdev-doc-container-images.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-doc-container-images.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-doc-container-images.mintlify.site/api-reference/spiffe/update-spiffe-mapping.md): Update an existing SPIFFE-ID to agent mapping. - [Delete SPIFFE Mapping](https://hoopdev-doc-container-images.mintlify.site/api-reference/spiffe/delete-spiffe-mapping.md): Remove a SPIFFE-ID to agent mapping. ## Optional - [Community](https://github.com/hoophq/hoop/discussions) - [Blog](https://hoop.dev/blog)