Skip to main content
Umbler is a Brazilian cloud platform for website hosting, domain registration, professional e-mail and DNS. This connector reads your Umbler account through the Umbler API and brings the websites you host (with their FTP accounts), the domains you registered, your e-mail domains and mailboxes, the DNS records of your domains and the users of the account.
The connector only reads data. It never creates, changes or deletes anything in Umbler. The FTP and e-mail passwords that the Umbler API returns are discarded and never loaded.

​
Configuring Umbler as a Source

In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the Umbler option from the list of connectors. Click Next and you’ll be prompted to add your access.

​
1. Add account access

The Umbler API uses a pair of credentials: a User ID and an API Token. Both are generated in the Umbler panel, in the API access area of your account.
  • User ID: the User ID of your Umbler API credential.
  • API Token: the API token generated together with the User ID.
The connector reads what the Umbler user who generated the token can see. Use a token from the account owner to get every website, domain and mailbox. A collaborator’s token only sees what was shared with that collaborator.
Once you’re done, click Next.

​
2. Select streams

Choose which data streams you want to sync. For faster extractions, select only the streams that are relevant to your analysis. You can select entire groups of streams or pick specific ones.
Tip: The stream can be found more easily by typing its name.
Select the streams and click Next.

​
3. Configure data streams

Customize how you want your data to appear in your catalog. Select the desired layer where the data will be placed, a folder to organize it inside the layer, a name for each table (which will effectively contain the fetched data) and the type of sync.
  • Layer: choose between the existing layers on your catalog. This is where you will find your new extracted tables as the extraction runs successfully.
  • Folder: a folder can be created inside the selected layer to group all tables being created from this new data source.
  • Table name: we suggest a name, but feel free to customize it. You have the option to add a prefix to all tables at once and make this process faster!
  • Sync Type: every Umbler stream is Full table. The Umbler API has no filter by date, so each sync reads the current state of your account and replaces the table with it.
Once you are done configuring, click Next.

​
4. Configure data source

Describe your data source for easy identification within your organization, not exceeding 140 characters. To define your Trigger, consider how often you want data to be extracted from this source. This decision usually depends on how frequently you need the new table data updated (every day, once a week, or only at specific times). Umbler data changes slowly, so a daily sync is usually enough. Optionally, you can configure Delta Log Retention and determine for how long we should store old states of this table as it gets updated. Read more about this resource here. Since every stream is Full table, an Additional Full Sync is not needed. Once you are ready, click Next to finalize the setup.

​
5. Check your new source

You can view your new source on the Sources page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.
For you to be able to see it on your Catalog, you need at least one successful source run.

​
Streams and Fields

​
Available streams

The table below lists every stream, its slug (the exact identifier to pass when creating the source via API) and a short description. All streams are Full table.

​
Fields by stream

Every website of the account. For each website the connector also reads its detail from Umbler and keeps it whole in details.Table: websites · Primary key: domain · Sync: Full table
FTP accounts of each website. Websites without FTP accounts have no rows.Table: website_ftp_accounts · Primary key: domain, user · Sync: Full table
Domains registered through Umbler. For each domain the connector also reads its detail and keeps it whole in details.Table: domain_registrations · Primary key: domain · Sync: Full table
Domains that use Umbler e-mail.Table: email_domains · Primary key: id · Sync: Full table
Mailboxes of each e-mail domain. Domains without mailboxes have no rows.Table: email_accounts · Primary key: domain, email_account · Sync: Full table
DNS records of the account’s domains whose DNS zone is hosted at Umbler. The connector checks every domain found in Websites, and also in Domain Registrations and E-mail Domains when Umbler returns them. If Umbler refuses or does not return one of these two lists, the sync log warns, and the domains that only appear there are missing from this table. A domain whose DNS is hosted elsewhere has no rows.Table: dns_records · Primary key: domain, id · Sync: Full table
Users of the Umbler account.Table: users · Primary key: id · Sync: Full table

​
Implementation Notes

​
Data Quality Considerations

  • Every table is a snapshot. Each sync replaces the tables with what Umbler returns at that moment. Websites, domains or mailboxes removed in Umbler disappear from the tables on the next sync.
  • A table is never half updated. The connector reads all the data of a table before writing any of it. If Umbler fails or refuses part of a table, that table keeps its previous content and the sync shows it as failed. The one exception is DNS Records: when Umbler refuses or does not return the Domain Registrations or E-mail Domains list, DNS records are still loaded for the other domains, and the sync log warns which domains were left out.
  • A table that suddenly comes back empty is not emptied. If Umbler returns no rows for a table that had rows in the previous sync, the sync fails for that table instead of emptying it. If the data really was removed in Umbler, run a full sync of the source to accept the empty table.
  • Domains without data. A website without FTP accounts, an e-mail domain without mailboxes or a domain whose DNS is hosted elsewhere has no rows in the related table, even when that is true for every domain. The sync log warns how many domains were in that situation.
  • Passwords are never loaded. The Umbler API returns FTP and e-mail passwords; the connector drops them. Inside details, fields whose name looks like a credential (password, senha, secret, token, keys, authorization or EPP codes, connection strings) and any text containing password= or pwd= are replaced by [redacted]. This works by field name and pattern, so treat details as internal data.
  • Domains are lowercase in every table, so you can join Websites, Domain Registrations, E-mail Domains, E-mail Accounts, Website FTP Accounts and DNS Records on domain.

​
API Limits & Performance

  • Umbler does not publish a request limit. The connector makes at most about 4 requests per second and, when Umbler asks it to slow down, waits as long as Umbler says.
  • Besides the four lists (websites, domain registrations, e-mail domains and users), the connector makes one request per website (detail and FTP accounts), per registered domain (detail), per e-mail domain (mailboxes) and per domain (DNS records). An account with 100 domains syncs in a few minutes.

​
Troubleshooting

​
Skills for agents

Download Umbler skills file

Umbler connector documentation as plain markdown, for use in AI agent contexts.