REST API Credentials

This feature is not available in DWS Mode.

Third-party applications authenticate and access VoiceConsole REST APIs using dedicated credentials managed from the REST API Credentials screen under System Configuration Actions.

Contact Honeywell Customer Support for the VoiceConsole REST API Guide for details on working with these APIs.

The REST API Credentials option requires administrator privileges.

To create and reset credentials:

  1. Under Navigation, click System Configuration.

  2. Under System Configuration Actions, select REST API Credentials.
    The REST API Credentials page opens.

  3. Enter a username (8–50 characters; alphanumeric, hyphens -, and underscores _ only).

  4. Click Create Access.

    A password is generated and displayed once. Copy and securely store it immediately. The password is not retrievable in clear text after leaving the page.

Reset Access:

  1. Click Reset Access.

  2. In the confirmation modal, click Confirm.

Resetting access invalidates the existing password and permits username modification to generate new credentials.

REST API Credentials Parameters

The REST API Credentials screen displays the following information for each credential:

Credential Description
Username The username associated with the REST API credential.
Password The password associated with the REST API credential. VoiceConsole displays the password only during credential creation or reset.
Created On The date and time the credential was created.