Managing Connections

Learn how to view, filter, validate, update, and delete your DNS provider connections.

Viewing Connections

Navigate to Connections > DNS Providers to see all your DNS connections.

Connection Statistics

At the top of the page, you'll see summary statistics:

Connection Cards

Each connection displays as a card with:

• Provider Icon - Visual identifier for the provider
• Connection Name - The name you assigned
• Status Badge - Current connection status (Active, Pending, Invalid)
• Provider Name - DNS provider name
• Zone Count - Number of zones synced
• Last Validated - When the connection was last validated
• Actions - View Details, Validate, Update Credentials, Delete

Filtering Connections

Filter by Status

Filter by Provider

• All Providers - Show all providers
• Cloudflare - Only Cloudflare connections
• AWS Route 53 - Only Route 53 connections
• Google Cloud DNS - Only Google DNS connections
• Vercel DNS - Only Vercel connections

Connection Details Panel

Click View Details from the connection dropdown menu to open the details panel.

Information Displayed

• Provider Information - Provider name, icon, and type
• Connection Name - The name you assigned
• Status - Current connection status with badge
• Zones - List of DNS zones for this connection
• Credentials Info - Masked credential information
• Configuration - Provider-specific configuration
• Created Date - When the connection was created
• Last Validated - When the connection was last validated
• Validation Error - Error message if validation failed

Quick Actions

From the details panel, you can:

• Validate - Re-check the connection
• Update Credentials - Change API tokens or keys
• Refresh Zones - Manually sync zones from provider
• Delete - Remove the connection

Validating Connections

Validation checks if Orkestia can successfully use your DNS connection.

When to Validate

• After creating a new connection
• After updating credentials
• If zones are not syncing
• If custom domain configuration fails
• Periodically to ensure continued access

How to Validate

1. Find the connection in the list
2. Click the Validate button on the card, or
3. Open connection details and click Validate

What Validation Checks

1. Authentication Test - Can Orkestia authenticate with the provider?
2. Permission Check - Does the connection have required permissions?
3. Zone Access - Can zones be listed and accessed?
4. API Connectivity - Is the provider API accessible?

Validation Results

Updating Credentials

Update your connection credentials when they expire or change.

When to Update

• API token expired or rotated
• API key changed
• Service account key updated
• AWS connection changed (for Route 53)

How to Update

1. Open the connection details panel
2. Click Update Credentials
3. Enter new credentials based on provider:

4. Click Update and Validate
5. Connection is automatically validated after update

Refreshing Zones

Manually refresh DNS zones to sync the latest zones from your provider.

When to Refresh

• New zones added in provider
• Zones not appearing in list
• After updating credentials
• Zones seem out of sync

How to Refresh

1. Open the connection details panel
2. Click Refresh Zones
3. Wait for sync to complete
4. Zones list updates automatically

Deleting Connections

Remove a DNS connection when it's no longer needed.

Before Deleting

Make sure:

• No custom domains are using this connection
• You've migrated any dependent domains to another connection
• You have another valid connection if needed

How to Delete

1. Click the dropdown menu (three dots) on the connection card
2. Click Delete
3. Confirm the deletion

Connection In Use

If you try to delete a connection that's being used by custom domains, you'll see an error:

Cannot delete connection: This connection is currently in use by X custom domains.

To resolve:

1. Navigate to each site using this connection
2. Change the domain's DNS connection to another one
3. Return and delete the original connection

Connection Statuses Reference

Best Practices

Regular Validation

• Validate connections periodically (monthly recommended)
• Validate after credential updates
• Validate if domains fail to configure

Credential Management

• Rotate API tokens regularly
• Use API tokens instead of global keys when possible
• Store credentials securely (never commit to code)
• Update credentials before they expire

Connection Organization

• Use descriptive connection names
• Group connections by environment (Production, Staging)
• Keep unused connections deleted
• Monitor connection statistics

Next Steps