Skip to main content

​
Overview

Edit existing connections to update expired credentials, change connection parameters, or modify authentication settings. Editing preserves all resource configurations and collection history.

​
Access Requirements

To edit connections, you must:
  • Be logged into the Entegrata Admin Portal
  • Have administrative privileges for your instance
  • Have the updated credentials or configuration details

​
When to Edit a Connection

Common scenarios for editing connections:
  • Expired credentials - Password or API keys have expired or changed
  • Updated endpoints - Host, port, or API endpoint has changed
  • Authentication method change - Switching from SQL to Windows authentication
  • Secret expiration update - Extending credential expiration dates
  • Connection parameter changes - Database name, organization ID, etc.
Changing connection parameters (like database name or API endpoint) may affect existing resource configurations.

​
Editing Connection Details

​
Step 1: Navigate to Connection

  1. Go to Collectors in the main navigation
  2. Click on the connection you want to edit
Click connection to view details

​
Step 2: Access Edit Interface

From the connection’s Resources page, click the Edit Connection or settings icon. The connection configuration form opens with current settings pre-filled.

​
Step 3: Update Fields

Modify any of the following fields:
The previously entered credentials will be empty as they are encrypted and stored securely and not fetched when editing the connection.
​
Nickname
string
Update the connection name (must remain unique)
​
Authentication Credentials
sensitive
Update username, password, API keys, or tokens
  • Passwords are masked but can be replaced
  • New credentials are encrypted upon saving
​
Connection Parameters
configuration
Modify host, port, database name, or API endpoints
Changing these may require re-discovery of resources
​
Secret Expiration
date
Update or extend credential expiration date

​
Step 4: Save Changes

  1. Review all modifications
  2. Click Update to save and test the connection

​
What Happens When You Save

1

Validation

Entegrata validates the updated configuration
2

Connection Test

Tests connectivity with the new credentials/parameters
3

Configuration Update

Saves the changes if the test succeeds
4

Discovery Trigger

May automatically trigger re-discovery if connection parameters changed

​
Update Success

If the update succeeds, you’ll see a confirmation message. The connection immediately uses the new credentials for all future operations.
In-progress collection jobs continue with the old credentials and complete normally.

​
Update Failure

If the update fails (e.g., invalid credentials), you’ll see an error. The connection retains its previous configuration - changes are not saved.

​
Handling Update Errors

Cause: New credentials are incorrectResolution:
  • Double-check username and password
  • Verify API keys or tokens are valid
  • Test credentials directly with the data source
  • Ensure no typos or extra spaces
Cause: New host/endpoint is unreachableResolution:
  • Verify host name or IP address
  • Check DNS resolution
  • Ensure firewall allows Entegrata’s IP addresses
  • Test connectivity from another location
Cause: New database name doesn’t existResolution:
  • Confirm database name spelling
  • Ensure database exists on the server
  • Check user has access to the database

​
Updating Authentication Type

For connections that support multiple authentication methods (like SQL Server):
1

Select New Authentication Type

Choose from the authentication type dropdown
Authentication type dropdown
2

Enter New Credentials

Form fields update to match the selected authentication type
3

Save and Test

Click Update to save the changes
Changing authentication types (e.g., from SQL to Windows Authentication) requires entering completely new credentials.

​
Updating Secret Expiration

Extend or modify when credentials expire:
1

Open Date Picker

Click the Secret Expiration date field
Secret expiration date picker
2

Select New Date

Choose a new expiration date (or clear it to remove expiration tracking)
3

Save Changes

Click Update to save
Set secret expiration dates a few days before actual expiration to receive advance notification.

​
Impact of Editing Connections

​
What’s Preserved

  • All resource configurations (schedules, load types, filters)
  • Collection history and job records
  • Unique keys and primary key settings
  • Discovered resource catalog

​
What May Change

  • New resources discovered if connection parameters change
  • Resources removed if they’re no longer accessible with new credentials
  • Schema changes detected if switching databases or endpoints
After editing connection parameters, review discovered resources to ensure expected tables/endpoints are still available.

​
Best Practices

Test Credentials First

Verify new credentials work by logging in directly before updating the connection

Schedule During Off-Peak

Update credentials during low-activity periods to minimize impact

Update Documentation

Keep your internal documentation current with credential changes

Trigger Discovery After Major Changes

Manually run discovery after changing databases or endpoints to detect changes immediately

Monitor First Collection

Watch the first collection job after credential updates to ensure it succeeds

​
Canceling Changes

To discard changes without saving:
  1. Click Cancel in the edit form
  2. Changes are not applied
  3. Connection retains its previous configuration

​
Troubleshooting Edit Issues

​
Changes Not Saving

Symptoms: Click Update but changes don’t persist Possible causes:
  • Network interruption during save
  • Validation error not displayed
  • Browser caching issue
Resolution:
  1. Refresh the page and try again
  2. Check browser console for errors
  3. Try a different browser
  4. Contact support if issue persists

​
Connection Goes to Error State After Edit

Symptoms: Connection shows Error status after updating Possible causes:
  • New credentials are incorrect
  • Host/endpoint unreachable
  • Permissions insufficient with new credentials
Resolution:
  1. Edit the connection again
  2. Verify all credentials are correct
  3. Test connectivity to the data source
  4. Check Troubleshooting for detailed steps

​
Next Steps

Collection Settings

Update schedules and collection behavior

Discovery

Trigger discovery after connection changes

Troubleshooting

Resolve connection issues

Viewing Connections

Return to connections list