# OASM - [Introduction](https://docs.oasm.io/index.md): Welcome to the Open Attack Surface Management Documentation - [Onboarding](https://docs.oasm.io/onboard.md): Set up your OASM workspace after first login - workspace settings, members, API keys, integrations, and your first discovery - [Core Concepts](https://docs.oasm.io/concepts.md): Understand the core concepts of OASM - the mental model behind the Open Attack Surface Management platform - [Architecture](https://docs.oasm.io/architecture.md): How OASM works at a high level - the web console, the core API, infrastructure, distributed workers, connector containers, and how a scan becomes part of your inventory - [Target](https://docs.oasm.io/target.md): Define scan targets — root domains, IP addresses, and CIDR ranges — for asset discovery - [Group](https://docs.oasm.io/group.md): Organize assets into named groups to scope discovery runs and automated workflows - [Asset](https://docs.oasm.io/asset.md): Learn about assets in OASM — the discovered services, technologies, and certificates that form your attack surface inventory - [Vulnerability](https://docs.oasm.io/vulnerability.md): Monitor, analyze, and manage detected security vulnerabilities across your attack surface - [Dashboard](https://docs.oasm.io/dashboard.md): Get an at-a-glance view of your attack surface - key metrics, vulnerability trends, and operational signals in one place - [Search](https://docs.oasm.io/search.md): Search across your entire workspace - assets, targets, vulnerabilities, services, and technologies - from one box - [Job Registry](https://docs.oasm.io/jobs.md): Central registry of every scan, discovery, and execution job across the workspace - [Reports](https://docs.oasm.io/reports.md): Generate structured security reports for management, audits, and compliance - [Notifications](https://docs.oasm.io/notifications.md): Stay informed about workspace events - new assets, new vulnerabilities, and analysis completions - in real time - [Chat Agent](https://docs.oasm.io/chat-agent.md): Query, analyze, and manage your attack surface with an AI-powered chat assistant in natural language - [Tools & Connectors](https://docs.oasm.io/tools.md): Browse the tool catalog, add connectors to your workspace, and configure them for scanning - [MCP Server](https://docs.oasm.io/settings/mcp.md): Connect external AI applications to your OASM workspace data via the Model Context Protocol - [Integrations](https://docs.oasm.io/integrations/overview.md): Connect third-party applications to pull assets in and push alerts out of your workspace - [AWS](https://docs.oasm.io/integrations/aws.md): Discover public-exposure AWS resources across accounts and regions, and add them to your attack surface - [Cloudflare](https://docs.oasm.io/integrations/cloudflare.md): Sync Cloudflare zones and DNS records into your attack surface as targets and assets - [Vercel](https://docs.oasm.io/integrations/vercel.md): Discover Vercel projects and their production domains as attack surface targets and assets - [Slack](https://docs.oasm.io/integrations/slack.md): Forward security alerts to a Slack channel using an incoming webhook - [Telegram](https://docs.oasm.io/integrations/telegram.md): Send security alerts to Telegram chats through a bot, with per-user pairing - [Webhook](https://docs.oasm.io/integrations/webhook.md): Forward security events as JSON to any HTTP endpoint you control - [Ticketing](https://docs.oasm.io/integrations/ticketing.md): Turn findings into tracked work items in Jira, Linear, or GitHub Issues - [Workspace](https://docs.oasm.io/workspace.md): Understand workspaces in OASM - isolated tenants for multi-tenant attack surface management - [Members](https://docs.oasm.io/members.md): Manage workspace members, invitations, and permission groups in OASM - [Permissions & Access Control](https://docs.oasm.io/permissions.md): Understand permission groups and how to control what members can view and change in OASM workspaces - [API keys](https://docs.oasm.io/api-keys.md): Manage the workspace API key for workers, MCP servers, and API clients in OASM - [Audit log](https://docs.oasm.io/audit-log.md): View and export workspace activity for compliance and incident investigation in OASM - [Worker](https://docs.oasm.io/worker.md): Connect and scale the distributed scanning workers that run security scans for your workspace - [Users and roles](https://docs.oasm.io/users-and-role.md): Manage user accounts, roles, and platform-wide access in OASM - [Brand name and logo](https://docs.oasm.io/brand-name-and-logo.md): Customize how your OASM instance is presented in the console with your own brand name and logo - [Deployment](https://docs.oasm.io/deployment.md): Deploy OASM in production from the oasm-docker repository — prerequisites, .env configuration, scaling, updates, and best practices - [Troubleshooting & FAQ](https://docs.oasm.io/troubleshooting.md): Resolve common OASM issues and find answers to frequently asked questions about the platform - [Developer Guide](https://docs.oasm.io/developer-guide.md): Set up the OASM development environment, run services from source, and manage the database, code generation, and environment variables - [Connectors](https://docs.oasm.io/connectors/overview.md): Package an external security tool behind a uniform contract so OASM can schedule it and collect findings - [Quickstart](https://docs.oasm.io/connectors/quickstart.md): Build a minimal connector end to end: module, manifest, adapter, wiring, and image - [Adapter](https://docs.oasm.io/connectors/adapter.md): The Validate and Execute methods every connector implements, plus the error convention the worker uses to decide retries - [Finding](https://docs.oasm.io/connectors/finding.md): The canonical output item every adapter emits — fields, validation rules, and severity mapping - [manifest.yaml](https://docs.oasm.io/connectors/manifest.md): Declare a connector — the required and optional fields, input and config schemas, and how the catalog is generated - [Inputs & config](https://docs.oasm.io/connectors/inputs-and-config.md): How per-run inputs and the tool config profile reach your adapter - [Build & test](https://docs.oasm.io/connectors/build-and-test.md): Task commands, testing rules, and how connectors are published - [Create multiple targets in bulk](https://docs.oasm.io/api-reference/targets/create-multiple-targets-in-bulk.md): Creates multiple security testing targets in a single request, skipping any duplicates that already exist in the workspace. Supports both DOMAIN (root domain) and CIDR (/24 range only) types. Returns detailed results including created targets and skipped values. - [Get all targets in a workspace](https://docs.oasm.io/api-reference/targets/get-all-targets-in-a-workspace.md): Fetches a comprehensive list of all registered security testing targets within the specified workspace for vulnerability management and assessment tracking. - [Export targets to CSV](https://docs.oasm.io/api-reference/targets/export-targets-to-csv.md): Exports all targets in a workspace to a CSV file containing value, type (DOMAIN or CIDR), last discovered date, and creation date for reporting and analysis purposes. - [Get a target by ID](https://docs.oasm.io/api-reference/targets/get-a-target-by-id.md): Fetches detailed information about a specific security testing target using its unique identifier, including configuration and assessment status. - [Update a target](https://docs.oasm.io/api-reference/targets/update-a-target.md): Modifies the configuration and properties of an existing security testing target, allowing for dynamic adjustments to assessment parameters. - [Delete a target permanently](https://docs.oasm.io/api-reference/targets/delete-a-target-permanently.md): Permanently deletes a security testing target and all its associated data (assets, vulnerabilities, jobs, and related records) from the specified workspace. - [Rescan a target](https://docs.oasm.io/api-reference/targets/rescan-a-target.md): Initiates a comprehensive security re-assessment of the specified target, triggering new vulnerability scans to identify potential security risks. - [Get Workspaces](https://docs.oasm.io/api-reference/workspaces/get-workspaces.md): Fetches a comprehensive list of security workspaces that the authenticated user has access to, providing multi-tenant organization capabilities. - [Create Workspace](https://docs.oasm.io/api-reference/workspaces/create-workspace.md): Establishes a new isolated security workspace for organizing and managing assets, targets, and vulnerabilities within a dedicated environment. - [Get workspace API key](https://docs.oasm.io/api-reference/workspaces/get-workspace-api-key.md): Retrieves the authentication API key for secure access to the specified workspace, enabling programmatic interactions with workspace resources. - [Get workspace configs](https://docs.oasm.io/api-reference/workspaces/get-workspace-configs.md): Retrieves the configuration settings for a specified workspace, including asset discovery and auto-enablement settings. - [Update workspace configs](https://docs.oasm.io/api-reference/workspaces/update-workspace-configs.md): Updates the configuration settings for a specified workspace, including asset discovery and auto-enablement options. - [Get Workspace By ID](https://docs.oasm.io/api-reference/workspaces/get-workspace-by-id.md): Fetches detailed information about a specific security workspace using its unique identifier, including all associated metadata and configuration. - [Delete Workspace](https://docs.oasm.io/api-reference/workspaces/delete-workspace.md): Permanently removes a security workspace and all its associated data, including assets, targets, vulnerabilities, and configurations. - [Update Workspace](https://docs.oasm.io/api-reference/workspaces/update-workspace.md): Modifies the configuration and metadata of an existing security workspace, allowing for dynamic adjustments to workspace settings and properties. - [Rotate API key](https://docs.oasm.io/api-reference/workspaces/rotate-api-key.md): Generates a new API key for the specified workspace, invalidating the previous key to enhance security and maintain authorized access. - [Archive/Unarchive Workspace](https://docs.oasm.io/api-reference/workspaces/archiveunarchive-workspace.md): Changes the archival status of a workspace, allowing for temporary deactivation or reactivation of workspace resources without permanent deletion. - [Get all workflow templates](https://docs.oasm.io/api-reference/workflows/get-all-workflow-templates.md): Retrieves a list of all available workflow templates in YAML format. - [Get many workflows](https://docs.oasm.io/api-reference/workflows/get-many-workflows.md): Retrieves a paginated list of workflows within the specified workspace. Supports filtering by name. - [Create workflow](https://docs.oasm.io/api-reference/workflows/create-workflow.md): Creates a new workflow with the provided data. - [Get workflow by ID](https://docs.oasm.io/api-reference/workflows/get-workflow-by-id.md): Retrieves a specific workflow by its ID within the specified workspace. - [Delete workflow](https://docs.oasm.io/api-reference/workflows/delete-workflow.md): Deletes a workflow by its ID. - [Update workflow](https://docs.oasm.io/api-reference/workflows/update-workflow.md): Updates an existing workflow with the provided data. - [Get apihealth](https://docs.oasm.io/api-reference/root/get-apihealth.md) - [Creates the first admin user in the system.](https://docs.oasm.io/api-reference/root/creates-the-first-admin-user-in-the-system.md): Creates the first admin user in the system. - [Get system metadata.](https://docs.oasm.io/api-reference/root/get-system-metadata.md): Returns metadata about the system state, like whether it has been initialized. - [Get the latest version.](https://docs.oasm.io/api-reference/root/get-the-latest-version.md): Returns the latest version information stored in Redis. - [Get system configuration](https://docs.oasm.io/api-reference/system-configs/get-system-configuration.md): Retrieves the current system configuration settings - [Update system configuration](https://docs.oasm.io/api-reference/system-configs/update-system-configuration.md): Updates the system configuration settings - [Remove system logo](https://docs.oasm.io/api-reference/system-configs/remove-system-logo.md): Removes the system logo and reverts to default avatar - [Get Jobs](https://docs.oasm.io/api-reference/jobsregistry/get-jobs.md): Retrieves a list of jobs that the user is a member of. - [Get Jobs Timeline](https://docs.oasm.io/api-reference/jobsregistry/get-jobs-timeline.md): Retrieves a timeline of jobs grouped by tool name and target. - [Retrieves the next job associated with the given worker that has not yet been started.](https://docs.oasm.io/api-reference/jobsregistry/retrieves-the-next-job-associated-with-the-given-worker-that-has-not-yet-been-started.md) - [Updates the result of a job with the given worker ID.](https://docs.oasm.io/api-reference/jobsregistry/updates-the-result-of-a-job-with-the-given-worker-id.md) - [Get Many Job Histories](https://docs.oasm.io/api-reference/jobsregistry/get-many-job-histories.md): Retrieves a list of job histories in the current workspace with their associated jobs, assets, and targets. - [Get Job History Detail](https://docs.oasm.io/api-reference/jobsregistry/get-job-history-detail.md): Retrieves a job history detail with its associated workflow and jobs. - [Re-run a job](https://docs.oasm.io/api-reference/jobsregistry/re-run-a-job.md): Reset job status to pending, clear workerId, and increment retry count - [Cancel a job](https://docs.oasm.io/api-reference/jobsregistry/cancel-a-job.md): Cancel a job by its ID in the specified workspace - [Delete a job](https://docs.oasm.io/api-reference/jobsregistry/delete-a-job.md): Delete a job by its ID in the specified workspace - [Get assets in target](https://docs.oasm.io/api-reference/assets/get-assets-in-target.md): Retrieves a list of assets associated with the given target. - [Get IP asset](https://docs.oasm.io/api-reference/assets/get-ip-asset.md): Retrieves a list of ip with number of assets. - [Get host asset](https://docs.oasm.io/api-reference/assets/get-host-asset.md): Retrieves a list of host with number of assets. - [Get ports and number of assets](https://docs.oasm.io/api-reference/assets/get-ports-and-number-of-assets.md): Retrieves a list of port with number of assets. - [Get technologies along with number of assets](https://docs.oasm.io/api-reference/assets/get-technologies-along-with-number-of-assets.md): Retrieves a list of technologies with number of assets. - [Get technologies along with number of assets](https://docs.oasm.io/api-reference/assets/get-technologies-along-with-number-of-assets-1.md): Retrieves a list of technologies with number of assets. - [Get TLS certificates](https://docs.oasm.io/api-reference/assets/get-tls-certificates.md): Retrieves a paginated list of TLS certificates with filtering and sorting support. - [Generate AI tags for a service](https://docs.oasm.io/api-reference/assets/generate-ai-tags-for-a-service.md): Analyzes the service data (HTTP responses, tech stack, TLS, etc.) using AI and generates descriptive tags. Replaces existing tags with AI-generated ones. - [Get asset by ID](https://docs.oasm.io/api-reference/assets/get-asset-by-id.md): Retrieves a single asset by its ID. - [Update asset by ID](https://docs.oasm.io/api-reference/assets/update-asset-by-id.md): Updates an asset by its ID. Only tags can be updated. - [Toggle asset enabled/disabled](https://docs.oasm.io/api-reference/assets/toggle-asset-enableddisabled.md): Toggle the enabled/disabled status of an asset. - [Export services to CSV](https://docs.oasm.io/api-reference/assets/export-services-to-csv.md): Exports all services in a workspace to a CSV file containing value, ports, technologies, and TLS information for reporting and analysis purposes. - [Worker alive](https://docs.oasm.io/api-reference/workers/worker-alive.md): Confirms the operational status of a security assessment worker node in the cluster. - [Worker join](https://docs.oasm.io/api-reference/workers/worker-join.md): Registers a new security assessment worker node to the distributed processing cluster. - [Get all workers with pagination and sorting.](https://docs.oasm.io/api-reference/workers/get-all-workers-with-pagination-and-sorting.md): Fetches a paginated list of all active security assessment workers in the cluster. - [Get tools](https://docs.oasm.io/api-reference/tools/get-tools.md): Fetches a paginated list of available security assessment tools in the system. - [Create a new tool](https://docs.oasm.io/api-reference/tools/create-a-new-tool.md): Registers a new security assessment tool in the system with specified configuration and capabilities. - [Add tool to workspace](https://docs.oasm.io/api-reference/tools/add-tool-to-workspace.md): Associates an existing security tool with a specific workspace for targeted assessments. - [Install tool](https://docs.oasm.io/api-reference/tools/install-tool.md): Installs a security tool to a specific workspace with duplicate checking to prevent conflicts. - [Uninstall tool](https://docs.oasm.io/api-reference/tools/uninstall-tool.md): Removes a security tool from a specific workspace by deleting its association record. - [Get built-in tools](https://docs.oasm.io/api-reference/tools/get-built-in-tools.md) - [Get installed tools for a workspace](https://docs.oasm.io/api-reference/tools/get-installed-tools-for-a-workspace.md): Fetches all security tools installed in a specific workspace, including built-in tools. - [Get tool by ID](https://docs.oasm.io/api-reference/tools/get-tool-by-id.md): Fetches detailed information about a specific security tool using its unique identifier. - [Get tool API key](https://docs.oasm.io/api-reference/tools/get-tool-api-key.md): Retrieves the authentication API key for accessing the specified security tool. - [Rotate tool API key](https://docs.oasm.io/api-reference/tools/rotate-tool-api-key.md): Regenerates a new API key for the specified security tool, invalidating the previous key. - [Search assets and targets](https://docs.oasm.io/api-reference/search/search-assets-and-targets.md): Search assets and targets - [Get search history](https://docs.oasm.io/api-reference/search/get-search-history.md): Get search history - [Delete all search history](https://docs.oasm.io/api-reference/search/delete-all-search-history.md): Delete all search history entries for the user - [Delete search history by ID](https://docs.oasm.io/api-reference/search/delete-search-history-by-id.md): Delete a specific search history entry by its ID - [Get workspace statistics](https://docs.oasm.io/api-reference/statistic/get-workspace-statistics.md): Retrieves statistics for a workspace including total targets, assets, vulnerabilities, and unique technologies. - [Get timeline statistics for a workspace](https://docs.oasm.io/api-reference/statistic/get-timeline-statistics-for-a-workspace.md): Retrieves statistics for a workspace over the last 3 months, showing trends and changes over time. - [Get issues timeline statistics for a workspace](https://docs.oasm.io/api-reference/statistic/get-issues-timeline-statistics-for-a-workspace.md): Retrieves issues timeline statistics for a workspace, showing the number of vulnerabilities over time. - [Get top 10 tags with the most assets in a workspace](https://docs.oasm.io/api-reference/statistic/get-top-10-tags-with-the-most-assets-in-a-workspace.md): Retrieves the top 10 tags with the most assets in a workspace. - [Get asset locations](https://docs.oasm.io/api-reference/statistic/get-asset-locations.md): Retrieves the top 10 countries by IP count for a workspace. Batches IP lookups to the geo IP service and aggregates results by country. - [Get TLS certificate statistics for a workspace](https://docs.oasm.io/api-reference/statistic/get-tls-certificate-statistics-for-a-workspace.md): Retrieves TLS certificate statistics grouped by expiration status using not_after field, and counts newly discovered certificates within the last 30 days. - [Get top 10 assets with the most vulnerabilities in a workspace](https://docs.oasm.io/api-reference/statistic/get-top-10-assets-with-the-most-vulnerabilities-in-a-workspace.md): Retrieves the top 10 assets with the most vulnerabilities in a workspace. - [Scan target](https://docs.oasm.io/api-reference/vulnerabilities/scan-target.md): Initiates a vulnerability scan for a specified target, identifying potential security risks and vulnerabilities. - [Get vulnerabilities](https://docs.oasm.io/api-reference/vulnerabilities/get-vulnerabilities.md): Retrieves a comprehensive list of security vulnerabilities identified across targets and assets, including detailed information about risks and remediation recommendations. - [Get vulnerabilities statistics](https://docs.oasm.io/api-reference/vulnerabilities/get-vulnerabilities-statistics.md): Provides aggregated statistical analysis of security vulnerabilities categorized by severity levels, enabling risk assessment and prioritization of remediation efforts. - [Get vulnerability by id](https://docs.oasm.io/api-reference/vulnerabilities/get-vulnerability-by-id.md): Retrieves detailed information about a specific security vulnerability identified within the system, including its attributes, associated assets, and remediation guidance. - [Analyze a vulnerability](https://docs.oasm.io/api-reference/vulnerabilities/analyze-a-vulnerability.md): Initiates an AI-powered analysis of a specific security vulnerability to provide detailed insights and recommendations. - [Delete vulnerability analysis result](https://docs.oasm.io/api-reference/vulnerabilities/delete-vulnerability-analysis-result.md): Removes the AI analysis result from a vulnerability and resets its status to not analyzed. - [Bulk dismiss vulnerabilities](https://docs.oasm.io/api-reference/vulnerabilities/bulk-dismiss-vulnerabilities.md): Dismisses multiple security vulnerabilities identified within the system, removing them from active tracking and analysis. - [Bulk reopen vulnerabilities](https://docs.oasm.io/api-reference/vulnerabilities/bulk-reopen-vulnerabilities.md): Reopens multiple security vulnerabilities identified within the system, restoring them to active tracking and analysis. - [Get agent modes](https://docs.oasm.io/api-reference/agents/get-agent-modes.md): Get all available modes for AI chat box and enabled workers - [Create LLM config](https://docs.oasm.io/api-reference/agents/create-llm-config.md): Create a new LLM provider configuration - [Get supported providers](https://docs.oasm.io/api-reference/agents/get-supported-providers.md): Get all supported LLM providers with their metadata - [Get connected providers](https://docs.oasm.io/api-reference/agents/get-connected-providers.md): Get all connected LLM provider configurations for the workspace - [List models for a provider config](https://docs.oasm.io/api-reference/agents/list-models-for-a-provider-config.md): Get available models for a specific LLM provider configuration - [Delete LLM config](https://docs.oasm.io/api-reference/agents/delete-llm-config.md): Delete an LLM configuration - [Update LLM config](https://docs.oasm.io/api-reference/agents/update-llm-config.md): Update an existing LLM configuration - [Set preferred LLM config](https://docs.oasm.io/api-reference/agents/set-preferred-llm-config.md): Set an LLM config as the preferred one for the workspace - [Get conversation detail](https://docs.oasm.io/api-reference/agents/get-conversation-detail.md): Get a single conversation with full details including todos - [Delete conversation](https://docs.oasm.io/api-reference/agents/delete-conversation.md): Delete a conversation and all its messages - [Update conversation](https://docs.oasm.io/api-reference/agents/update-conversation.md): Update a conversation title - [List conversations](https://docs.oasm.io/api-reference/agents/list-conversations.md): Get all conversations for the workspace - [Delete all conversations](https://docs.oasm.io/api-reference/agents/delete-all-conversations.md): Delete all conversations and their messages for the workspace - [Get messages](https://docs.oasm.io/api-reference/agents/get-messages.md): Get all messages in a conversation - [Send message (streaming)](https://docs.oasm.io/api-reference/agents/send-message-streaming.md): Send a message and receive a streaming response via SSE. If conversationId is not provided, a new conversation is created using the preferred LLM config. - [Delete message](https://docs.oasm.io/api-reference/agents/delete-message.md): Delete a specific message in a conversation - [Get MCP configs](https://docs.oasm.io/api-reference/agents/get-mcp-configs.md): Get all MCP server configurations for the workspace - [Upsert MCP server](https://docs.oasm.io/api-reference/agents/upsert-mcp-server.md): Add or update an MCP server configuration - [Delete MCP server](https://docs.oasm.io/api-reference/agents/delete-mcp-server.md): Remove an MCP server configuration - [Toggle MCP server](https://docs.oasm.io/api-reference/agents/toggle-mcp-server.md): Enable or disable an MCP server - [Ping MCP server](https://docs.oasm.io/api-reference/agents/ping-mcp-server.md): Check connectivity status of an MCP server - [Get workspace memory](https://docs.oasm.io/api-reference/agents/get-workspace-memory.md): Get long-term memory records for the workspace (paginated, per user) - [Delete workspace memory](https://docs.oasm.io/api-reference/agents/delete-workspace-memory.md): Delete a long-term memory record by ID - [List skills](https://docs.oasm.io/api-reference/agents/list-skills.md): Get all available skills (builtin + user) for the workspace - [Create skill](https://docs.oasm.io/api-reference/agents/create-skill.md): Create a new user skill for the workspace (workspace owner only) - [Delete skill](https://docs.oasm.io/api-reference/agents/delete-skill.md): Delete a user skill (workspace owner only) - [Update skill](https://docs.oasm.io/api-reference/agents/update-skill.md): Update a user skill (workspace owner only) - [Toggle skill](https://docs.oasm.io/api-reference/agents/toggle-skill.md): Enable or disable a user skill (workspace owner only) - [Get all notifications](https://docs.oasm.io/api-reference/notifications/get-all-notifications.md): Retrieve a paginated list of notifications for the current user - [Create a notification](https://docs.oasm.io/api-reference/notifications/create-a-notification.md): Create a new notification for a specific user or group of users - [Subscribe to notifications stream](https://docs.oasm.io/api-reference/notifications/subscribe-to-notifications-stream.md): Subscribe to a Server-Sent Events (SSE) stream for real-time notifications - [Get unread notifications count](https://docs.oasm.io/api-reference/notifications/get-unread-notifications-count.md): Get the total count of unread notifications for the current user - [Mark all notifications as read](https://docs.oasm.io/api-reference/notifications/mark-all-notifications-as-read.md): Mark all notifications as read for the current user - [Mark all notifications as unread](https://docs.oasm.io/api-reference/notifications/mark-all-notifications-as-unread.md): Mark all notifications as unread for the current user - [Mark a specific notification as read](https://docs.oasm.io/api-reference/notifications/mark-a-specific-notification-as-read.md): Mark a single notification as read by its ID - [Delete a notification](https://docs.oasm.io/api-reference/notifications/delete-a-notification.md): Delete a notification recipient record for the current user. The notification itself is preserved for other recipients. - [Get all integration schemas](https://docs.oasm.io/api-reference/integrations/get-all-integration-schemas.md): Returns the JSON Schema (Draft 2020-12) for all supported integration configurations. Used by the console to render dynamic forms. - [Get all integrations for a workspace](https://docs.oasm.io/api-reference/integrations/get-all-integrations-for-a-workspace.md): Returns a paginated list of integrations in the specified workspace. Supports search and filters. - [Create a new integration](https://docs.oasm.io/api-reference/integrations/create-a-new-integration.md): Connects a third-party application to the specified workspace. Config is validated against the JSON Schema for the given appType + category. - [Get an integration by ID](https://docs.oasm.io/api-reference/integrations/get-an-integration-by-id.md): Returns the configuration for a specific integration in the workspace. Sensitive fields are masked. - [Delete an integration](https://docs.oasm.io/api-reference/integrations/delete-an-integration.md): Permanently removes an integration from the specified workspace. - [Update an integration](https://docs.oasm.io/api-reference/integrations/update-an-integration.md): Updates the name, description, or config of an existing integration. If config is provided, it is validated against the JSON Schema. Empty body returns the current state unchanged. - [Test an integration](https://docs.oasm.io/api-reference/integrations/test-an-integration.md): Sends a test payload using the integration connector. The connector class is resolved by appType and the correct method is dispatched by category — no if/else chains. - [Create a Telegram pairing token](https://docs.oasm.io/api-reference/integrations/create-a-telegram-pairing-token.md): Generates a unique 48-char connect token for the given Telegram integration. The user sends this token to the bot via /start to pair their Telegram chat. - [Telegram bot webhook](https://docs.oasm.io/api-reference/integrations/telegram-bot-webhook.md): Receives incoming updates from Telegram via webhook. Each integration has a unique webhook URL including the integration ID. Parses /start messages to pair chats. - [List Telegram connects for an integration](https://docs.oasm.io/api-reference/integrations/list-telegram-connects-for-an-integration.md): Returns all Telegram chat connections (paired users) for the given integration. - [Disconnect a Telegram connect](https://docs.oasm.io/api-reference/integrations/disconnect-a-telegram-connect.md): Disconnects a specific Telegram chat from the integration. - [Subscribe to remote-execute stream](https://docs.oasm.io/api-reference/remote-execute/subscribe-to-remote-execute-stream.md): Server-Sent Events endpoint that streams commands published to the remote-execute channel for a specific sessionId in real-time. Each event is a JSON-encoded RemoteCommandPayload. - [Get all providers](https://docs.oasm.io/api-reference/providers/get-all-providers.md): Get all providers with pagination, filtered by owner - [Create a new provider](https://docs.oasm.io/api-reference/providers/create-a-new-provider.md): Create a new provider - [Get a provider by ID](https://docs.oasm.io/api-reference/providers/get-a-provider-by-id.md): Get detailed information about a specific provider - [Delete a provider](https://docs.oasm.io/api-reference/providers/delete-a-provider.md): Soft delete a provider by ID - [Update a provider](https://docs.oasm.io/api-reference/providers/update-a-provider.md): Update an existing provider by ID - [Get all templates](https://docs.oasm.io/api-reference/templates/get-all-templates.md): Retrieve all templates in a workspace - [Create a new templates](https://docs.oasm.io/api-reference/templates/create-a-new-templates.md): Create a new template with file stored in the storage - [Template upload](https://docs.oasm.io/api-reference/templates/template-upload.md): Upload a template to the storage - [Rename a template file](https://docs.oasm.io/api-reference/templates/rename-a-template-file.md): Rename the display filename of a template - [Get a template by ID](https://docs.oasm.io/api-reference/templates/get-a-template-by-id.md): Retrieve a template by its ID - [Delete a template](https://docs.oasm.io/api-reference/templates/delete-a-template.md): Delete a template and its associated file from storage - [Get all asset groups](https://docs.oasm.io/api-reference/asset-group/get-all-asset-groups.md): Retrieves all asset groups with optional filtering and pagination. - [Create asset group](https://docs.oasm.io/api-reference/asset-group/create-asset-group.md): Creates a new asset group. - [Get asset group by ID](https://docs.oasm.io/api-reference/asset-group/get-asset-group-by-id.md): Fetches a specific asset group by its unique identifier. - [Delete asset group](https://docs.oasm.io/api-reference/asset-group/delete-asset-group.md): Permanently removes an asset group. - [Update asset group](https://docs.oasm.io/api-reference/asset-group/update-asset-group.md): Updates an existing asset group by ID. - [Add multiple workflows to asset group](https://docs.oasm.io/api-reference/asset-group/add-multiple-workflows-to-asset-group.md): Associates multiple workflows with the specified asset group. - [Remove multiple workflows from asset group](https://docs.oasm.io/api-reference/asset-group/remove-multiple-workflows-from-asset-group.md): Disassociates multiple workflows from the asset group. - [Add multiple assets to asset group](https://docs.oasm.io/api-reference/asset-group/add-multiple-assets-to-asset-group.md): Associates multiple assets with the specified asset group. - [Remove multiple assets from asset group](https://docs.oasm.io/api-reference/asset-group/remove-multiple-assets-from-asset-group.md): Disassociates multiple assets from the asset group. - [Get assets by asset group ID](https://docs.oasm.io/api-reference/asset-group/get-assets-by-asset-group-id.md): Retrieves assets associated with a specific asset group with pagination. - [Get workflows by asset group ID](https://docs.oasm.io/api-reference/asset-group/get-workflows-by-asset-group-id.md): Retrieves workflows associated with a specific asset group with pagination. - [Get assets not in asset group](https://docs.oasm.io/api-reference/asset-group/get-assets-not-in-asset-group.md): Retrieves assets not associated with a specific asset group with pagination. - [Get workflows not in asset group (preinstalled in workspace)](https://docs.oasm.io/api-reference/asset-group/get-workflows-not-in-asset-group-preinstalled-in-workspace.md): Retrieves workflows not associated with a specific asset group but preinstalled in the workspace with pagination. - [Update asset group workflow relationship](https://docs.oasm.io/api-reference/asset-group/update-asset-group-workflow-relationship.md): Updates the relationship between an asset group and workflow, primarily to change the schedule. - [Runs the scheduler for a specific asset group workflow.](https://docs.oasm.io/api-reference/asset-group/runs-the-scheduler-for-a-specific-asset-group-workflow.md): Runs the scheduler for a specific asset group workflow. - [Get many internal networks](https://docs.oasm.io/api-reference/internalnetworks/get-many-internal-networks.md): Retrieves a paginated list of internal networks for the specified workspace. - [Create an internal network](https://docs.oasm.io/api-reference/internalnetworks/create-an-internal-network.md): Creates a new internal network for the specified workspace. Only the workspace owner can perform this action. - [Create targets from network interfaces](https://docs.oasm.io/api-reference/internalnetworks/create-targets-from-network-interfaces.md): Creates new targets from the CIDRs of the specified network interfaces. - [Get many network interfaces for an internal network](https://docs.oasm.io/api-reference/internalnetworks/get-many-network-interfaces-for-an-internal-network.md): Retrieves a paginated list of network interfaces for the specified internal network. - [Get an internal network by ID](https://docs.oasm.io/api-reference/internalnetworks/get-an-internal-network-by-id.md): Retrieves a single internal network by its ID. - [Delete an internal network](https://docs.oasm.io/api-reference/internalnetworks/delete-an-internal-network.md): Deletes an existing internal network. Only the workspace owner can perform this action. - [Update an internal network by ID](https://docs.oasm.io/api-reference/internalnetworks/update-an-internal-network-by-id.md): Updates the name of an existing internal network. Only the workspace owner can perform this action. - [List reports](https://docs.oasm.io/api-reference/reports/list-reports.md): Returns paginated list of reports for the current workspace. - [Get apireportspreviewsummary](https://docs.oasm.io/api-reference/reports/get-apireportspreviewsummary.md) - [Get apireportspreviewvulnerability](https://docs.oasm.io/api-reference/reports/get-apireportspreviewvulnerability.md) - [Generate summary PDF report](https://docs.oasm.io/api-reference/reports/generate-summary-pdf-report.md): Generates a summary (Attack Surface Discovery) PDF report. - [Generate vulnerability PDF report](https://docs.oasm.io/api-reference/reports/generate-vulnerability-pdf-report.md): Generates a vulnerability assessment PDF report. - [Delete report](https://docs.oasm.io/api-reference/reports/delete-report.md): Deletes a generated report PDF. - [Upload app logo to system bucket](https://docs.oasm.io/api-reference/storage/upload-app-logo-to-system-bucket.md) - [Upload a file to storage](https://docs.oasm.io/api-reference/storage/upload-a-file-to-storage.md) - [Download a file with time-limited token](https://docs.oasm.io/api-reference/storage/download-a-file-with-time-limited-token.md) - [Get a file from storage (public)](https://docs.oasm.io/api-reference/storage/get-a-file-from-storage-public.md) - [Get apimcp](https://docs.oasm.io/api-reference/mcp/get-apimcp.md) - [Post apimcpmessage](https://docs.oasm.io/api-reference/mcp/post-apimcpmessage.md) - [AGENTS](https://docs.oasm.io/AGENTS.md) - [Internal Networks](https://docs.oasm.io/internal-networks.md): Model and scan internal, non-internet-facing network ranges separately from your external attack surface - [Workflows](https://docs.oasm.io/workflows.md): Automate recurring security operations with versioned workflow definitions in OASM ## OpenAPI Specs - [openapi](/api-reference/openapi.json) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.