# Docusnap365

## Getting Started

- [Welcome to Docusnap365](https://www.docusnap.com/docs/en/getting-started/overview.md): Your account is set up. Three ways to start.
- [Creating Your First Asset](https://www.docusnap.com/docs/en/getting-started/first-asset.md): Create an asset by hand in a few minutes and give it its ITAM data – your first managed asset, without a scan.
- [Scanning Your Network](https://www.docusnap.com/docs/en/getting-started/inventory.md): How Docusnap365 captures your network automatically – from the gateway to the first scan job.
- [Assessing NIS-2](https://www.docusnap.com/docs/en/getting-started/nis2.md): The quickest entry point: activate the NIS-2 regulation and assess your first objective – without an asset, without a scan.

### Basics

- [Tasks](https://www.docusnap.com/docs/en/getting-started/tasks.md): Tell derived tasks from manual ones, show planned tasks, and create, edit and complete tasks.
- [Manage Trash](https://www.docusnap.com/docs/en/getting-started/trash.md): Restore deleted entries or remove them permanently.
- [Search and Filter](https://www.docusnap.com/docs/en/getting-started/search-and-filter.md): Reach an entry through the global search and narrow the entire inventory with the environment filter.

### Architecture & Security

- [Architecture](https://www.docusnap.com/docs/en/getting-started/architecture.md): How Docusnap365 is built, what runs in your network, and where your data lives.
- [Security](https://www.docusnap.com/docs/en/getting-started/security.md): How credentials, transmission and your data are protected – and what you control yourself.
- [Understanding Roles and Permissions](https://www.docusnap.com/docs/en/getting-started/roles-and-permissions.md): How the role and module access determine what a user can see and change in Docusnap365.

## Scanning

- [Scanning Fundamentals](https://www.docusnap.com/docs/en/scan/understanding-scanning.md): How the gateway, scan modules, jobs and credentials work together, and what happens to the results of a scan.
- [Scan Reference](https://www.docusnap.com/docs/en/scan/reference.md): Credential types, target entries, module settings, status values, fixed sizes and terms for looking up.

### Tutorials

- [Tutorial: The First Scan](https://www.docusnap.com/docs/en/scan/tutorial-first-scan.md): From an empty tenant to a typed inventory: install the gateway, create credentials, scan Active Directory and Windows, type unknown systems.
- [Storing Credentials Locally](https://www.docusnap.com/docs/en/scan/tutorial-credentials.md): Store credentials encrypted on the gateway instead of in the central vault, so that the secret never leaves your own network.

### Docusnap Enterprise Gateway

- [Installing and Registering the Gateway](https://www.docusnap.com/docs/en/scan/gateway-install.md): Install the Docusnap Enterprise Gateway on a Windows host, sign in and bind it to your subscription – the prerequisite for every scan.
- [Setting the Storage Directory](https://www.docusnap.com/docs/en/scan/gateway-storage-directory.md): Give the gateway a directory for its scan scripts – and set the permission the gateway itself does not check.
- [Managing Gateways](https://www.docusnap.com/docs/en/scan/gateway.md): Check a gateway's state, configuration and diagnostic data, set logging and support access, restart a gateway or detach it from the tenant.
- [Reviewing and Exporting Logs](https://www.docusnap.com/docs/en/scan/gateway-logs.md): Read the log directly on the gateway machine, set the log level and file rotation, and export the complete set for support.

### Jobs

- [Creating a Scan Job](https://www.docusnap.com/docs/en/scan/create-inventory.md): Choose a module, set targets and credentials, and set a schedule – the wizard for every scan module without a guide of its own.
- [Managing Jobs](https://www.docusnap.com/docs/en/scan/manage-jobs.md): Watch jobs across three lists, read job details, pause or rerun jobs, or follow up a failed scan.
- [Assigning Unknown Systems](https://www.docusnap.com/docs/en/scan/unknown-systems.md): Review systems that were found but not typed, edit them in bulk and assign them to a type.

### Scan Modules

- [Scan Modules – Overview](https://www.docusnap.com/docs/en/scan/scan-modules.md): Which sources Docusnap365 can capture – the 27 scan modules by category, with the guides for ten of them and the details for the rest.
- [Scanning Active Directory](https://www.docusnap.com/docs/en/scan/active-directory.md): Capturing the directory itself – with domain and credentials, and with the decision on personal data and extended attributes.
- [Scanning Windows](https://www.docusnap.com/docs/en/scan/windows.md): Capturing Windows systems – through Active Directory or through targets you enter yourself – and choosing which components are collected.
- [Scanning the Network over SNMP](https://www.docusnap.com/docs/en/scan/snmp.md): Capturing targets over SNMP – with a community for SNMP v1 and v2 or with a user account for SNMPv3.
- [Scanning Cisco Meraki](https://www.docusnap.com/docs/en/scan/cisco-meraki.md): Capturing Cisco Meraki through an API key – no targets, no target columns, no module options.
- [Scanning Nutanix](https://www.docusnap.com/docs/en/scan/nutanix.md): Capturing Nutanix clusters – entering the targets yourself or having them searched for through Prism Central.
- [Scanning Microsoft 365](https://www.docusnap.com/docs/en/scan/microsoft-365.md): Capturing the Microsoft tenant through an Entra ID app registration – choose the app, verify access, watch the expiry dates.
- [Scanning Microsoft Intune](https://www.docusnap.com/docs/en/scan/microsoft-intune.md): Capturing the device management of the Microsoft tenant – through the same Entra ID app as Microsoft 365, but with a job of its own.
- [Scanning Storage](https://www.docusnap.com/docs/en/scan/storage.md): Capturing storage systems through an HTTP endpoint – with credentials of the type User Account.
- [Scanning NTFS Security](https://www.docusnap.com/docs/en/scan/ntfs-analysis.md): Capturing the shares and permissions of a file server through a reusable analysis package.
- [Capturing Files via File Import](https://www.docusnap.com/docs/en/scan/file-import.md): Reading existing export files from a folder path – without targets and without credentials.

## Inventory

- [Assets Fundamentals](https://www.docusnap.com/docs/en/assets/overview.md): What an asset is, the two sides of the inventory, where assets come from, and what attaches to them.

### Tutorials

- [Importing Assets from a Spreadsheet](https://www.docusnap.com/docs/en/assets/tutorial-import.md): Prepare a table of existing devices and import it as assets with type, organization and location.
- [Justifying Why a Server Is Critical](https://www.docusnap.com/docs/en/assets/tutorial-organization.md): Create department, person, application, process and business service, connect them to the technology and derive the protection need from that.

### Assets

- [Create assets](https://www.docusnap.com/docs/en/assets/create.md): Create one asset or several at once, individually or by CSV import.
- [Edit and delete assets](https://www.docusnap.com/docs/en/assets/edit.md): Edit a single asset, change several at once, and delete assets.
- [Lists and filters](https://www.docusnap.com/docs/en/assets/lists.md): How to search, filter, group, and export an assets list.

### Relationships

- [Relationships](https://www.docusnap.com/docs/en/assets/relations.md): What a relationship is, where it comes from, and where it shows up in Docusnap365.
- [Create and edit relationships](https://www.docusnap.com/docs/en/assets/relations-edit.md): Create, change, and delete a relationship from the tab or from the relation map.
- [Relation Types](https://www.docusnap.com/docs/en/assets/relation-types.md): Which kinds of relationships exist between assets and how they read in both directions.

### Data Captured

- [Systems](https://www.docusnap.com/docs/en/assets/systems.md): Windows, Linux and macOS – which types the scan modules for systems create and how their detail pages are structured.
- [Directory and Network Services](https://www.docusnap.com/docs/en/assets/directory-services.md): Active Directory, DNS, DHCP and DFS – which types these scan modules create and how their detail pages are structured.
- [Databases](https://www.docusnap.com/docs/en/assets/databases.md): Microsoft SQL Server, MySQL, MariaDB and Oracle – which types these scan modules create and how their detail pages are structured.
- [Virtualization](https://www.docusnap.com/docs/en/assets/virtualization.md): VMware, Hyper-V, Nutanix, Proxmox and Citrix Xen – which types these scan modules create and how their detail pages are structured.
- [Cloud and Identity](https://www.docusnap.com/docs/en/assets/cloud-identity.md): Microsoft 365, Entra ID and Intune – which types these scan modules create and how their detail pages are structured.
- [Network and Devices](https://www.docusnap.com/docs/en/assets/network-devices.md): SNMP devices, Cisco Meraki, IP phones, monitors and the shared network view – which types arise and how they are structured.
- [Storage, Backup, Permissions](https://www.docusnap.com/docs/en/assets/storage-backup.md): Storage, Veeam B&R and NTFS Security – which types these scan modules create and how their detail pages are structured.
- [Software and Integrations](https://www.docusnap.com/docs/en/assets/software-integrations.md): Installed software, bundled products and the seven ways data from foreign systems comes in.
- [Sites and Organization](https://www.docusnap.com/docs/en/assets/locations-organization.md): Organization and the remaining types you create yourself – no scan module produces them.

## ITAM

- [ITAM Fundamentals](https://www.docusnap.com/docs/en/itam/understanding-itam.md): What data ITAM keeps for an asset, where it comes from and how a person confirms it.
- [ITAM Reference](https://www.docusnap.com/docs/en/itam/reference.md): Status values, cost types and categories, criticality levels, and terms of the ITAM module.

### Tutorials

- [Making Scanned Systems Manageable](https://www.docusnap.com/docs/en/itam/tutorial-manage-assets.md): Turn scanned systems into validated assets: set owners, criticality and lifecycle — for many assets at once and one at a time.
- [Finding Unused Licenses](https://www.docusnap.com/docs/en/itam/tutorial-costs.md): Record a Microsoft 365 contract, assign the licenses to users and read off in the cost analysis how much is paid for unoccupied slots.

### Asset Management

- [Capturing ITAM Data](https://www.docusnap.com/docs/en/itam/manage-data.md): Maintain an asset's lifecycle, ownership, and criticality, and avoid the pitfalls of a phase change.
- [Validating Assets](https://www.docusnap.com/docs/en/itam/validate-assets.md): Walk an asset through the validation workflow, individually or for several assets at once.

### Warranties

- [Creating and Linking Warranties](https://www.docusnap.com/docs/en/itam/warranties.md): Create warranties, link them to coverages and assets, and keep track of their term.
- [Looking Up Warranties Automatically](https://www.docusnap.com/docs/en/itam/warranty-lookup.md): What is locked on automatically determined warranties and how you trigger a refresh.

### Costs

- [Capturing Costs](https://www.docusnap.com/docs/en/itam/capture-costs.md): Create a cost entry with positions, understand assignability to devices or users, and estimate the number of journal entries.
- [Editing Costs](https://www.docusnap.com/docs/en/itam/edit-costs.md): Change, duplicate, or delete positions of a cost entry, and know which fields can still be changed afterwards.
- [Assigning Costs to Assets](https://www.docusnap.com/docs/en/itam/cost-allocation.md): Distribute a cost position's free units across assets and finalize a billing period.
- [Analyzing Costs](https://www.docusnap.com/docs/en/itam/cost-analysis.md): Track cost development over several months and uncover unused budget.

## ISMS

- [ISMS Fundamentals](https://www.docusnap.com/docs/en/isms/understanding-isms.md): How risk management and compliance fit together, and what the ISMS tab on an asset connects.
- [ISMS Reference](https://www.docusnap.com/docs/en/isms/reference.md): Risk levels, treatment strategies, objective statuses, due dates, and terms of the ISMS module.

### Tutorials

- [Setting the Protection Need](https://www.docusnap.com/docs/en/isms/tutorial-protection-needs.md): Set the protection need for the systems behind one application and find it again in the risk wizard as the basis for the impact.
- [Carrying a Risk Through to Monitoring](https://www.docusnap.com/docs/en/isms/tutorial-risk.md): Provide threat and vulnerability, assess the risk, link a recurring control and carry out the phase changes up to monitoring.

### Risk Management

- [Risk Management Fundamentals](https://www.docusnap.com/docs/en/isms/understanding-risk-management.md): What a risk consists of, how the matrix assesses it and which lifecycle it goes through.
- [Determine Protection Needs](https://www.docusnap.com/docs/en/isms/protection-needs.md): Rate confidentiality, integrity, and availability for an asset and assign the responsible person.
- [Manage Threats and Vulnerabilities](https://www.docusnap.com/docs/en/isms/threats-vulnerabilities.md): Import threats from the catalog, create vulnerabilities, and assign both to a risk scenario.
- [Create and Assess Risks](https://www.docusnap.com/docs/en/isms/assess-risks.md): Capture a risk in the wizard, perform the assessment, and carry it through the phases of its lifecycle.
- [Manage Controls](https://www.docusnap.com/docs/en/isms/controls.md): Create controls, keep status and due dates in view, and edit several controls at once.
- [Documenting Evidence for Controls](https://www.docusnap.com/docs/en/isms/control-evidence.md): Back every execution of a control with a piece of evidence, and set recurrence and due date for recurring controls.

### Compliance

- [Understanding Compliance](https://www.docusnap.com/docs/en/isms/understanding-compliance.md): What a regulation consists of and when an objective counts as complete, applicable, or a gap.
- [Activate and Assess Regulations](https://www.docusnap.com/docs/en/isms/regulations.md): Activate regulations, assess their objectives individually or in bulk, and link controls and documents.
- [Check Compliance Status](https://www.docusnap.com/docs/en/isms/compliance.md): Read overall compliance, gaps, and the three-month trend on the compliance dashboard.

## Documentation

- [Documents Fundamentals](https://www.docusnap.com/docs/en/documents/overview.md): What a document is, its types and states, which roles carry the approval, and what it is used for.

### Tutorials

- [Approving a Document](https://www.docusnap.com/docs/en/documents/tutorial-approval.md): Create a controlled document, write it, set the roles, request approval and decide.
- [Producing Evidence for an Audit](https://www.docusnap.com/docs/en/documents/tutorial-audit-evidence.md): Assemble the record an auditor demands out of versions, reasons and decisions.

### Documents

- [Creating a Document](https://www.docusnap.com/docs/en/documents/create-document.md): Required fields, the decision for a controlled document, and the export settings in the create dialog.
- [Adding Content](https://www.docusnap.com/docs/en/documents/content.md): Creating and writing chapters, who may edit when, what editing an approved document costs, and how the export runs.

### Controlled Documents

- [Document Control](https://www.docusnap.com/docs/en/documents/document-control.md): Requesting and deciding on approval, the four-eyes principle under strict mode, and when the review cycle falls due.
- [History](https://www.docusnap.com/docs/en/documents/history.md): Looking up approved versions, comparing versions, and reviewing the full approval history — including rejected and withdrawn attempts.

### Maps

- [Understanding Maps](https://www.docusnap.com/docs/en/documents/plans.md): What a map is, how you open it, move around it and export it – the same for Topology, IP Networks and IP Segments.
- [Topology, IP Networks and IP Segments](https://www.docusnap.com/docs/en/documents/network-plans.md): What each of the three maps under Maps shows, and how the shared toolbar and legend work.

## Analysis

- [Analysis Fundamentals](https://www.docusnap.com/docs/en/analysis/overview.md): What the vulnerability analysis and the permission analysis evaluate, where their data comes from, and what the results are used for.

### Tutorials

- [Tutorial: From Vulnerability to Control](https://www.docusnap.com/docs/en/analysis/tutorial-vulnerability-to-control.md): Prioritize a critical CVE, assign it, back it with a control and close it after implementation.

### Vulnerability Analysis

- [CVE Analysis](https://www.docusnap.com/docs/en/analysis/cve.md): Prioritize known vulnerabilities, assign them to a person, reject them with a reason and back them with controls.

### Permission Analysis

- [Analyzing File System Permissions](https://www.docusnap.com/docs/en/analysis/file-system.md): Who can access what in the file system, where a right comes from, and where inheritance is broken – evaluated from the last scan.

### Insights

- [Insights](https://www.docusnap.com/docs/en/analysis/insights.md): Saved analyses across the inventory.

## AI Assistant

- [AI Assistant Fundamentals](https://www.docusnap.com/docs/en/assistant/overview.md): What the AI Assistant is for, which questions it answers, and where its limits lie.
- [Assistant Permissions and Data](https://www.docusnap.com/docs/en/assistant/permissions-and-data.md): What the AI Assistant may read and change, which formats you can export, and how your data is processed.
- [Assistant Quota](https://www.docusnap.com/docs/en/assistant/quota.md): How the AI Assistant's quota is calculated per billing period, and what happens when it runs out.
- [Having a Conversation](https://www.docusnap.com/docs/en/assistant/conversation.md): Ask a question, reuse a response, handle errors, and start a new chat.

## Settings

### Account

- [Subscription and Invoices](https://www.docusnap.com/docs/en/settings/subscription.md): Check usage limits, buy more quota, change the edition, download invoices, and cancel the subscription.
- [Users and Roles](https://www.docusnap.com/docs/en/settings/users.md): Invite users, assign roles, and reduce module access per module.
- [Support](https://www.docusnap.com/docs/en/settings/support-access.md): Grant and revoke temporary Docusnap support access to your subscription.

### Environment Data

- [Manage Environment Data](https://www.docusnap.com/docs/en/settings/environment-data.md): Create and manage organizations, domains, platforms, and locations as environment filters.

### Integrations

- [Manage API Keys](https://www.docusnap.com/docs/en/settings/api-access.md): Create API keys for external systems, set their access, regenerate them, and delete them.

### Adjustments

- [Customize the Data Model](https://www.docusnap.com/docs/en/settings/data-model.md): Create your own types and fields, hide standard fields, and control where a type is available.

### Settings

- [Risk Matrix, Currency, and Numbering](https://www.docusnap.com/docs/en/settings/general.md): Set the risk matrix's size and thresholds, the currency symbol, and the numbering prefix.
- [Set ITAM Validation and Strict Mode](https://www.docusnap.com/docs/en/settings/itam-settings.md): Set strict mode for validation and the validation cycle per criticality.
- [Set Risk Review Periods](https://www.docusnap.com/docs/en/settings/isms-settings.md): Set review periods for risks per criticality.
- [Set Strict Mode for Documents](https://www.docusnap.com/docs/en/settings/documents-settings.md): Enable four-eyes approval for editing and approving documents.

### Auditing

- [Tracking Changes in the Journal](https://www.docusnap.com/docs/en/settings/journal.md): Use the journal to trace who changed which record of the subscription, and when.

### Profile Settings

- [Personal Data](https://www.docusnap.com/docs/en/settings/profile.md): Manage name and profile picture.
- [Security](https://www.docusnap.com/docs/en/settings/security.md): Change the password, set up or reset two-factor authentication.
- [Appearance & Language](https://www.docusnap.com/docs/en/settings/appearance.md): Set color scheme, language, regional format and time zone for your own user.
- [Notifications](https://www.docusnap.com/docs/en/settings/notifications.md): Choose which notifications you receive by e-mail and in the app.

## MCP

- [MCP – Basics](https://www.docusnap.com/docs/en/api/mcp.md): How you connect Docusnap365 to your AI tool over MCP, whose permissions it works with, and which eight tools are available.

## Developer

### Basics

- [Understanding the REST API](https://www.docusnap.com/docs/en/api/overview.md): What the Docusnap365 REST API can do, how you authenticate, and how query, cursor and details fit together.
- [Data Model](https://www.docusnap.com/docs/en/api/data-model.md): How a type is built, how a field label points to a property in the schema, and which types are shipped.

### API Reference

#### Assets

- [List assets](https://www.docusnap.com/docs/api-reference/assets/list-assets.md): Returns assets page by page, at most 50 per page. No filtering — for filters, sorting and field selection use `POST /assets/query`.
- [Get an asset](https://www.docusnap.com/docs/api-reference/assets/get-an-asset.md): Returns one asset: core data, data of its type, quick view, ITAM and ISMS data. `select` restricts the fields.
- [Query assets](https://www.docusnap.com/docs/api-reference/assets/query-assets.md): Filters, sorts and selects fields; loads details on request (`expands`). Large results come page by page through a cursor.
- [Load asset details](https://www.docusnap.com/docs/api-reference/assets/load-asset-details.md): Loads the details of a named expand for one asset, page by page — data of the type, quick view, blocks or child assets. `cursor` comes from `incompleteExpands` of a previous response; without `cursor` the expand starts from the beginning.
- [Load the next page](https://www.docusnap.com/docs/api-reference/assets/load-the-next-page.md): Continues a query with the cursor of the last response — from the main query or from an expand.
- [Create an asset](https://www.docusnap.com/docs/api-reference/assets/create-an-asset.md): Creates an asset — or updates it if Docusnap365 already knows it by its identity. An `AssetBundle` is submitted: `schemaId` determines the type, `objectData` follows the type's data definition. More complete records are not overwritten by less complete sources.
- [Create several assets](https://www.docusnap.com/docs/api-reference/assets/create-several-assets.md): Like `POST /asset`, for up to **100** assets in one call and one transaction — known assets are updated.

## OpenAPI Specs

- [openapi.en](/docs/api-reference/openapi.en.yaml)

> The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages.

## Indexes

- [German (118 pages)](https://www.docusnap.com/docs/_llms/de.md): Documentation for German.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.