Skip to main content

Delete Destination(s)

Delete a Destination​

The Nexla API supports deleting destinations that the authenticated user has administrative or ownership rights to. Deleting a destination permanently removes it from your account and stops all associated data flows.

Delete Endpoint​

The primary endpoint for deleting destinations is:

DELETE /data_sinks/{destination_id}

Delete Response​

A successful deletion request returns a 200 status with no response body, indicating the destination has been permanently removed.

Delete Destination: Request
DELETE /data_sinks/5023

Response Structure​

Delete Destination: Response
Empty response with status 200 for success
Error response with reason if destination could not be deleted

Delete Considerations​

Before deleting a destination, consider these important factors:

Data Flow Impact​

  • Active Flows: Deleting a destination immediately stops all data output
  • Nexset Association: The associated Nexset will no longer have this output target
  • Irreversible Action: Deletion cannot be undone - the destination must be recreated

Associated Resources​

  • Credentials: Destination credentials are not automatically deleted
  • Data Maps: Associated data mapping configurations are preserved
  • Audit History: Deletion events are recorded in audit logs

Prerequisites​

To successfully delete a destination:

  1. Ownership Rights: You must have administrative or ownership access
  2. Destination Exists: The destination ID must be valid and accessible
  3. No Active Dependencies: The destination should not be part of critical active flows

Delete Process​

The deletion process follows these steps:

  1. Validation: Verify user permissions and destination existence
  2. Flow Termination: Stop any active data flows to the destination
  3. Resource Cleanup: Remove destination configuration and associations
  4. Confirmation: Return success status upon completion

Error Handling​

Common deletion issues and solutions:

  • Permission Denied: Ensure you have administrative or ownership rights
  • Destination Not Found: Verify the destination ID is correct
  • Active Dependencies: Check if the destination is part of active flows
  • System Errors: Contact support for unexpected system issues

Best Practices​

To safely delete destinations:

  1. Verify Impact: Check what data flows will be affected
  2. Backup Configuration: Save destination configuration before deletion
  3. Communicate Changes: Inform team members of planned deletions
  4. Test in Non-Production: Practice deletion procedures in test environments
  5. Document Reasons: Keep records of why destinations were deleted

Alternative to Deletion​

Instead of deleting destinations, consider:

Pausing Destinations​

PUT /data_sinks/{destination_id}/pause

Updating Configuration​

PUT /data_sinks/{destination_id}

Archiving Destinations​

Set destinations to inactive status rather than deleting them.

Recovery After Deletion​

If you need to restore a deleted destination:

  1. Recreate Destination: Use the same configuration parameters
  2. Reassociate Nexset: Connect the destination to the appropriate Nexset
  3. Test Configuration: Validate the new destination works correctly
  4. Activate Flow: Start data output to the new destination

After deleting a destination, you may need to:

Create New Destination​

POST /data_sinks

Update Nexset Configuration​

PUT /nexsets/{nexset_id}

Review Data Flow Impact​

GET /flows

Check Audit Log​

GET /audit_log