API Basics

The vScope REST API lets you read and update selected data and settings (e.g., tags, targets). Each vScope instance hosts its own API docs at:

https://[vscope-server-name]/apidoc

Key points

• Auth: bearer-like token via header token: <value>.
• Scope: read assets/tags/relations; limited updates (tags, targets) per exposed endpoints.
• Formats: JSON (primary); some endpoints support CSV/XLSX for exports.
• Permissions: token inherits permissions of the linked user.
• Rate/limits: follow your server capacity; no limits built-in the API.

How to create a token and export/import

• Token creation: see Fetching data via API.
• Import tags/targets: see Import tags via API and Import targets to discovery.

If /apidoc is unreachable, ensure the service is running and that you are signed in to vScope.