Overview

The API Access Key in zMan Director is used by zDM servers and zTC provisioning workflows to authenticate communication with zMan Director.

The Management Portal URL and Management Access Key are required when registering a zDM server to zMan Director and may also be used during zTC provisioning workflows.

---

Accessing the API Access Key

The Management Portal URL and Management Access Key can be accessed in zMan Director from:

Server Configuration > API Access Key

Administrators should copy the required access information from this page when registering zDM or configuring provisioning workflows.

---

Use During zDM Registration

When installing or registering a zDM server, the zDM setup process requires the zMan Director connection details.

Required values include:

• zMan Director URL
• zMan Director Access Key
• zDM IP address or FQDN

The zDM IP address or FQDN should be reachable by both zMan Director and the zTC devices that will be managed through that zDM server.

---

Use During zTC Provisioning

The API Access Key may also be used during provisioning workflows where the zTC device needs to connect to zMan Director through zDM.

Provisioning may be performed through:

• Auto provisioning
• Manual provisioning

For manual provisioning, the required provisioning information is entered directly on the zTC device.

---

Regenerating the Access Key

If the Management Access Key is regenerated, existing zDM servers and the zTC devices managed through those zDM servers may go offline.

After regenerating the key, affected zDM servers must be registered again using the updated access key.

---

Re-registering the Default zDM

If the default internal zDM server was installed with zMan Director, it may need to be re-registered and onboarded again after the API Access Key is regenerated.

To re-register and onboard the default zDM:

1. Log in to the zMan Director server using SSH as the root user.
2. Navigate to:

/home/vagrant/

3. Run the following commands one at a time:

./zwan/zdmserver/zdmsetup.sh
./zwan/zdmserver/onboard.sh

After the scripts complete successfully, the default zDM server should be re-registered and onboarded again.

---

Security Considerations

The API Access Key should be handled as a sensitive credential.

Administrators should:

• Limit access to authorized personnel
• Avoid sharing the key through unsecured channels
• Regenerate the key if exposure is suspected
• Re-register affected zDM servers after key regeneration

---

Notes

• zDM servers depend on the current API Access Key to communicate with zMan Director.
• Regenerating the API Access Key can interrupt zDM and zTC connectivity.
• Affected zDM servers must be updated or re-registered after key regeneration.
• The default internal zDM can be re-registered using the documented zDM setup and onboarding scripts.