User-defined APIs tutorials

With the DataMiner User-Defined APIs module, you can create custom APIs to interact with DataMiner. The tutorials in this section will show you how to set up a custom API and how to use it.

Prerequisites

• A DataMiner System using DataMiner 10.3.6 or higher with Storage as a Service or self-hosted storage setup with indexing database, as well as HTTPS setup
• DataMiner Cube
• User-Defined APIs user permissions
• Automation user permissions
• Visual Studio 2019 or later with DataMiner Integration Studio 2.42+
• Postman

Tutorials

• Hello world
• Retrieving elements in alarm

Note

The Automation script solution that is created and used in the tutorials is available on GitHub. The API scripts can also be deployed directly to a DataMiner System connected to dataminer.services using the corresponding DataMiner Catalog item.

Tip

• You can also find some basic examples on the API script examples page.
• Is something not going right while you follow one of these tutorials? Check out our troubleshooting guide.