Skip to content
vScope Support Page

The Basics

Every licensed vScope instance includes an open REST API, enabling you to extract or update data within vScope. With the vScope API, you can extend and customize vScope’s functionality to better align with your organization’s IT workflows.

Getting Started

You can access the API documentation specific to your vScope server at:

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

The documentation provides details on all available GET, PUT, DELETE, and POST methods. Note that while you cannot add new data directly to vScope’s data model, PUT and POST methods can be used to update tags or manage targets.

Access Using API Tokens

To secure API access, use tokens that are linked to specific permissions:

  1. Navigate to Settings > API Tokens in vScope.
  2. Assign permissions by selecting the user associated with the token.
  3. Set an expiry date to limit the token’s validity, enhancing security.

API tokens provide controlled access to data, ensuring that only authorized users and applications can interact with vScope.