> ## Documentation Index
> Fetch the complete documentation index at: https://support.entegrata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Edit Connections

> Update connection credentials and configuration settings

## 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 (coming soon)
* **Secret expiration update** - Extending credential expiration dates
* **Connection parameter changes** - Database name, organization ID, etc.

<Warning>
  Changing connection parameters (like database name or API endpoint) may affect existing resource configurations.
</Warning>

## 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

<Frame>
  <img src="https://mintcdn.com/entegrata/d4pzv5m2aXdjP4mx/data/collector/connections/images/connections-row-clickable.png?fit=max&auto=format&n=d4pzv5m2aXdjP4mx&q=85&s=fa20c59bf0446504066408f59b16f622" alt="Click connection to view details" width="2256" height="114" data-path="data/collector/connections/images/connections-row-clickable.png" />
</Frame>

### 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:

<Info>
  The previously entered credentials will be empty as they are encrypted and stored securely and not fetched when editing the connection.
</Info>

<ResponseField name="Nickname" type="string">
  Update the connection name (must remain unique)
</ResponseField>

<ResponseField name="Authentication Credentials" type="sensitive">
  Update username, password, API keys, or tokens

  * Passwords are masked but can be replaced
  * New credentials are encrypted upon saving
</ResponseField>

<ResponseField name="Connection Parameters" type="configuration">
  Modify host, port, database name, or API endpoints

  <Warning>
    Changing these may require re-discovery of resources
  </Warning>
</ResponseField>

<ResponseField name="Secret Expiration" type="date">
  Update or extend credential expiration date
</ResponseField>

### Step 4: Save Changes

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

#### What Happens When You Save

<Steps>
  <Step title="Validation">
    Entegrata validates the updated configuration
  </Step>

  <Step title="Connection Test">
    Tests connectivity with the new credentials/parameters
  </Step>

  <Step title="Configuration Update">
    Saves the changes if the test succeeds
  </Step>

  <Step title="Discovery Trigger">
    May automatically trigger re-discovery if connection parameters changed
  </Step>
</Steps>

## Update Success

If the update succeeds, you'll see a confirmation message.

The connection immediately uses the new credentials for all future operations.

<Info>
  In-progress collection jobs continue with the old credentials and complete normally.
</Info>

## 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

<AccordionGroup>
  <Accordion title="Authentication Failed">
    **Cause**: New credentials are incorrect

    **Resolution**:

    * 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
  </Accordion>

  <Accordion title="Cannot Connect to Host">
    **Cause**: New host/endpoint is unreachable

    **Resolution**:

    * Verify host name or IP address
    * Check DNS resolution
    * Ensure firewall allows Entegrata's IP addresses
    * Test connectivity from another location
  </Accordion>

  <Accordion title="Database Not Found">
    **Cause**: New database name doesn't exist

    **Resolution**:

    * Confirm database name spelling
    * Ensure database exists on the server
    * Check user has access to the database
  </Accordion>
</AccordionGroup>

## Updating Authentication Type

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

<Steps>
  <Step title="Select New Authentication Type">
    Choose from the authentication type dropdown

    <Frame>
      <img src="https://mintcdn.com/entegrata/d4pzv5m2aXdjP4mx/data/collector/connections/images/auth-type-selector.png?fit=max&auto=format&n=d4pzv5m2aXdjP4mx&q=85&s=8df1659278da91b8e0490f6a3d7f7acc" alt="Authentication type dropdown" width="802" height="84" data-path="data/collector/connections/images/auth-type-selector.png" />
    </Frame>
  </Step>

  <Step title="Enter New Credentials">
    Form fields update to match the selected authentication type
  </Step>

  <Step title="Save and Test">
    Click **Update** to save the changes
  </Step>
</Steps>

<Note>
  Changing authentication types (e.g., from SQL to Windows Authentication) requires entering completely new credentials.
</Note>

## Updating Secret Expiration

Extend or modify when credentials expire:

<Steps>
  <Step title="Open Date Picker">
    Click the Secret Expiration date field

    <Frame>
      <img src="https://mintcdn.com/entegrata/d4pzv5m2aXdjP4mx/data/collector/connections/images/secret-expiration-picker.png?fit=max&auto=format&n=d4pzv5m2aXdjP4mx&q=85&s=ca7723bee14225d069db20b795987fc4" alt="Secret expiration date picker" width="802" height="76" data-path="data/collector/connections/images/secret-expiration-picker.png" />
    </Frame>
  </Step>

  <Step title="Select New Date">
    Choose a new expiration date (or clear it to remove expiration tracking)
  </Step>

  <Step title="Save Changes">
    Click **Update** to save
  </Step>
</Steps>

<Tip>
  Set secret expiration dates a few days before actual expiration to receive advance notification.
</Tip>

## 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

<Warning>
  After editing connection parameters, review discovered resources to ensure expected tables/endpoints are still available.
</Warning>

## Best Practices

<CardGroup cols={2}>
  <Card title="Test Credentials First" icon="flask">
    Verify new credentials work by logging in directly before updating the connection
  </Card>

  <Card title="Schedule During Off-Peak" icon="clock">
    Update credentials during low-activity periods to minimize impact
  </Card>

  <Card title="Update Documentation" icon="file-text">
    Keep your internal documentation current with credential changes
  </Card>

  <Card title="Trigger Discovery After Major Changes" icon="magnifying-glass">
    Manually run discovery after changing databases or endpoints to detect changes immediately
  </Card>

  <Card title="Monitor First Collection" icon="chart-line">
    Watch the first collection job after credential updates to ensure it succeeds
  </Card>
</CardGroup>

## 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](/data/collector/connections/troubleshooting) for detailed steps

## Next Steps

<CardGroup cols={2}>
  <Card title="Collection Settings" icon="gear" href="/data/collector/connections/collection-settings">
    Update schedules and collection behavior
  </Card>

  <Card title="Discovery" icon="magnifying-glass" href="/data/collector/discovery/overview">
    Trigger discovery after connection changes
  </Card>

  <Card title="Troubleshooting" icon="wrench" href="/data/collector/connections/troubleshooting">
    Resolve connection issues
  </Card>

  <Card title="Viewing Connections" icon="eye" href="/data/collector/connections/viewing-connections">
    Return to connections list
  </Card>
</CardGroup>
