IBM DataPower Operations Dashboard v1.0.22.x

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

In this page:

POST Quick Setup

 /op/api/v2/installation/quickSetup

Description:

This API configures Probe Settings on a gateway for all domains or a specific domain that has a matching gateway peering configured.

Required Roles:

  • OpDashAdminRole

URI:

/op/api/v2/installation/quickSetup

Request:

The request should use the POST 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 default product view.

String

  • IDG

  • APIC

defaultTheme

Required

The default theme.

String

  • dark

  • light

  • elegant

webConsoleUrl

Required

The web console URL.

String

activationKey

Required

The activation key zip file encoded as Base64.

String

Example:

{
    "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:

{
    "resultCode": "SUCCESS",
    "resultMessage": "Quick setup finished successfully",
    "result": {
        "defaultProductView": "IDG"
    }
}
  • No labels