Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In this page:

...

Expand
title/op/api/v2/installation/quickSetup

Description:

This API configures quick setup.

Required Roles:

  • OpDashAdminRole

URI:

/op/api/v2/installation/quickSetup

Request:

The request should use the

Status
colourYellow
titlePOST
method with the following fields in its body:

Name

Required/Optional

Description

Type

Available Options

newLocalAdminPassword

Required

The local admin password

String

defaultProductView

Required

The Determines the default product view, defined by the main type of monitored transactions.

String

  • IDG

  • APIC

defaultTheme

Required

The Determines the default theme for all users.

String

  • dark

  • light

  • elegant

webConsoleUrl

Required

The web console URL.

String

activationKey

Required

The activation key zip file encoded as Base64.

String

Example:

Code Block
{
    "newLocalAdminPassword": "<password>",
    "defaultProductView": "IDG",
    "defaultTheme": "dark",
    "webConsoleUrl": "https://<DPOD-host>",
    "activationKey": "eyJrZXkiOiJxeVgyZFY3eUQ3UjJkMko5NFgwVkdiYTRPN1FqZG5Ve..."
}

Successful Response:

The response includes the following fields in its body:

Name

Description

Type

Available Options

defaultProductView

The default product view.

String

Example:

Code Block
languagejson
{
    "resultCode": "SUCCESS",
    "resultMessage": "Quick setup finished successfully",
    "result": {
        "defaultProductView": "IDG"
    }
}