| Align | ||
|---|---|---|
| ||
| Info |
|---|
Issues have been identified with the Invoke-RestMethod command in PowerShell version 5.1, which is included with Windows Server 2019 and 2022. It is advisable to use the latest version of PowerShell: https://aka.ms/powershell-release?tag=stable when accessing the DryvIQ API endpoints. |
Overview
It is possible to set up DryvIQ using the REST API. This page provides sample calls you will use.
Test Database Connection
POST /v1/admin/db/test {"provider":"sqlserver","connection":"Server=server;Database=dbname;Integrated Security=true;","embedded":"false"}
Set Database Connection
PATCH /v1/admin/db {"provider":"sqlserver","connection":"Server=server;Database=dbname;Integrated Security=true;","embedded":"false"}
Create and/or Update Database
POST /v1/admin/db/upgrade
Soft Reset
POST /v1/admin/restart
GET Reset and Application Status
GET /v1/admin/status
GET Service Configuration
GET /v1/admin/config
Activate License
POST /v1/licensing/activate?usage=true {"key":"myKey"}
Accept EULA
PATCH /v1/admin/config/acceptEula
Create Admin User
POST /v1/users {"login":"admin","password":"Passw0rd!"}