Skip to content
Nexadata Nexadata Docs

Troubleshooting Pigment Connection Issues

Setting up your Pigment connection in Nexadata is typically straightforward. However, you might encounter occasional errors during setup or usage. This guide covers common issues and how to resolve them quickly.

Common Issues and How to Fix Them

Section titled “Common Issues and How to Fix Them”

1. Invalid API Key Error

Section titled “1. Invalid API Key Error”

Problem: When clicking the Test button, you receive an “Unauthorized Pigment API Key” message.

Solution:

  • Double-check that you copied the entire key correctly from Pigment.

  • Make sure there are no extra spaces or characters when pasting the key.

  • Confirm that the key is active and has not been revoked or expired in Pigment.

  • Ensure you are using the correct key for the corresponding operation (Import, Export, Metadata, or Audit).

Tip: If needed, generate a new API key in Pigment and update your Nexadata connection.

2. Insufficient Permissions

Section titled “2. Insufficient Permissions”

Problem: The key passes the initial test but later fails during data operations with a “Permission Denied” error.

Solution:

  • Verify the API key’s permissions in Pigment.

  • Ensure the key has access to the required resources (e.g., views, lists, metrics, etc, audit logs, etc).

  • If permissions are too restricted, request broader access or create a new key with the correct scope.

3. Unable to Access Metadata

Section titled “3. Unable to Access Metadata”

Problem: Export and Import keys work, but the system cannot retrieve metadata (e.g., models or structures).

Solution:

  • Confirm that the Metadata Key is correctly configured and tested.

  • Make sure the metadata access feature is enabled for the associated Pigment API key.

4. Key Mismatch Across Operations

Section titled “4. Key Mismatch Across Operations”

Problem: Testing is successful for one key but fails for others.

Solution:

  • Ensure you are entering the correct key into the correct field:

    • Import Key → for uploading data into Pigment

    • Export Key → for extracting data out of Pigment

    • Metadata Key → for reading blocks, views, and other Pigment objects

    • Audit Key → for accessing audit logs

  • Mixing up keys can cause failures during specific operations, even if initial tests pass.

Additional Best Practices

Section titled “Additional Best Practices”

  • Rotate API keys regularly to maintain security best practices.

  • Store keys securely using a credential manager.

  • Document which keys are used for each connection to simplify future troubleshooting.

When to Contact Support

Section titled “When to Contact Support”

If you’ve tried the above steps and still encounter issues:

  • Collect any error messages you received.

  • Note which keys or operations are failing.

  • Provide the approximate time of failure (helpful for log tracing).

Then reach out to Nexadata Support with this information for faster resolution.