Connect SpamTitan

Written By Christopher Scaminaci

Last updated About 3 hours ago

SpamTitan is TitanHQ's email security gateway. It sits in front of your mail, filters spam, malware and impersonation, holds what it blocks in quarantine, and gives you per-customer control of who may send, who may receive and how outbound mail leaves. StackJack talks to SpamTitan through its REST API, the same interface the web console is built on.

Connecting SpamTitan to StackJack gives your AI assistant a family of spamtitan_ MCP tools. MCP (Model Context Protocol) tools are the standardized commands an AI assistant can call through StackJack. With them, your AI can:

Work the quarantine: list what is held, read one message, and release or delete it; search message history across a time window; read the mail queue; and ask SpamTitan to send a quarantine report, to everyone or to one user
Report: scan summaries and the other reports SpamTitan keeps, for the whole system or for one customer
Manage sender and IP lists: the sender allow and block lists and the allowed and blocked IP lists, for the whole system or scoped to one customer, domain or user
Manage customers, domains and users: customers (SpamTitan calls them domain groups), the domains under them, each domain's filtering policy, recipient verification and authentication settings, and users with their aliases. Suspend, lock out and reinstate a customer
Run mail authentication: SPF, DKIM checking and bypass, DMARC (including the failure action and reporting), the DKIM keys a domain signs with, and ARC signing keys
Tune filtering: pattern filters, geoblocking with its country rules and exemptions, Link Lock, DNS blocklists and their bypass lists, sandboxing, and rate controls
Run the outbound side: outbound relay, trusted networks, SASL, smarthosts and outbound TLS policy
Administer the appliance: read and set appliance configuration, apply a license file, request a Let's Encrypt certificate, open and close the support tunnel, and change the account password. The configuration, license, certificate and support tunnel tools need a Global Admin

How StackJack authenticates to SpamTitan

SpamTitan uses an API token. An admin makes it once, and StackJack sends it as a Bearer token on every request. There is no client ID, no sign-in and no refresh. The token alone authenticates, and it expires on the date chosen when it was made: one year by default. Nothing renews it, so put the expiry in your calendar.

Two things decide what StackJack can do:

The Location. A token is valid only on the cluster that made it. You choose the Location in StackJack, and StackJack uses that cluster's API address, never the sign-in address.
The admin who made the token. A SpamTitan token has no scopes. It carries the role of the admin who made it, and SpamTitan decides what each role may call.

Pick your location

Your cluster is part of the address you sign in at. Signing in at https://us1-smtp-ui.titanhq.com means your cluster is us1. The clusters are us1, us2, us3, us4, eu1, uk1, ap1 and ca1. StackJack stores your choice and fills in the API address for you.

The API address is not the sign-in address. The sign-in site answers every request with a web page, so a connection pointed at it could never tell a good token from a bad one. StackJack refuses that address. If you paste a sign-in address into the host box, StackJack switches the Location to the matching cluster and tells you so.

If you run SpamTitan Gateway, a Private Cloud, or an older cloud host, choose Other SpamTitan host and enter that host's own address, starting with https://. StackJack reaches it from the internet, so it must be public, over HTTPS, with a certificate a browser would trust. A Private Cloud instance uses a self-signed certificate by default, which StackJack rejects until a trusted certificate is installed.

Steps

Find your location. Look at the address you sign in at and note the cluster, for example us1.
Make an API token. On current SpamTitan Cloud (version 9.00 and later) the web console has no API key screen, so the token is made with one request. Open a terminal and run the command below, with your own admin email and password and your own cluster in the address. The password stays in your terminal and StackJack never sees it. Copy the access_token value from the answer. The token is shown once.
```
curl -X POST https://us1-smtp-api.titanhq.com/restapi/auth/tokens \
  -H "Accept: application/json" -H "Content-Type: application/json" \
  -d '{"email":"admin@example.com","password":"your-password"}'
```
The token lasts one year unless the request carries an expiration_date. Do not ask for a token that never expires: SpamTitan says such a token can only be removed through a support request. On SpamTitan 8.00 or earlier, open Settings, then User Management, then RestAPI Keys, and create a key there instead. SpamTitan does not document how the request behaves for an account with two-factor authentication. If it is refused, make the token from an admin account that can.
Choose which admin the token belongs to. A Global Admin reaches everything, including appliance-wide settings. An MSP admin can act on each of their customers. A Domain Group Admin or a Domain Admin reaches only their own customers or domains, and a User reaches only their own mailbox. Make the token from the admin whose reach matches what you want StackJack to manage.
Enter it in StackJack. Open Connectors, choose SpamTitan, pick your Location (or Other and the host address), paste the token and save.
Test the connection. StackJack reads the system geoblocking setting, which every admin role can read, so the test proves the token and the address without changing anything.

The token is stored encrypted and is not shown again. Enter it again whenever you edit this connector. Changing only the Location asks for the token again, which is deliberate: a save can never quietly replace a working token with a blank one.

What to know before your AI uses this connector

Working across your customers

SpamTitan calls a customer a domain group. If you are an MSP, most tools take an optional customer, domain or user, so the same tool can act on the whole system or on one of them. Leave all three out and the tool acts at the level of the token. Give one and StackJack uses SpamTitan's address for that scope. Give more than one and the tool refuses, because SpamTitan has no address that means two scopes at once. The customer list tool shows the ids.

A few tools need a scope and refuse without one: removing a geoblocking exemption and creating or removing a Link Lock policy act on one customer, domain or user, never on the whole system.

Some tools change what mail is filtered or who sees it

Every change is a Pro tool, and the ones that matter most are labeled as changes that need approval. An AI assistant that honors that label shows you the action and waits for you to confirm. The confirmation is the assistant's, not StackJack's. A StackJack automation cannot run one of these at all until somebody signs off that it may take consequential actions on its own.

Those tools fall into groups:

Entries that exempt mail from filtering. An allow list entry, an allowed IP and a bypass entry tell SpamTitan to stop checking something. Your AI is told what each one exempts before it writes it. SpamTitan's own documentation also says that deleting an allow list entry, a block list entry or a pattern filter, or updating an allow list entry, deletes every other entry that belongs to the same customer, and that updating a block list entry updates all of that customer's entries. Those tools say so in their descriptions, and they are labeled as changes that need approval.
Protection switches. SPF, DKIM, DMARC, geoblocking, sandboxing, rate controls and the others can turn a protection off for everything in their scope. Updating a customer, a domain's policy or a user's policy can do the same, because each can switch spam, virus, attachment or geoblocking protection off for that customer, domain or user. Those updates are labeled as changes that need approval too.
Deletes. Deleting a domain, a user, a customer's lists or a key cannot be undone. Deletes that accept either one id or a list of ids refuse to run with neither.
Tools that store a password or a key. Creating or updating a user or a domain, changing how a domain's users sign in, adding or changing a smarthost, setting SASL or the outbound TLS client certificate, and creating a DKIM or ARC signing key can store a password, a bind password or a key, and a user can be given administrator roles. Replacing an RBL, which removes one and adds another, is labeled the same way. These are labeled as changes that need approval too.
Reaching people. Releasing quarantined mail delivers it. Requesting a quarantine report mails the users it covers. Suspending a customer or locking one out stops their mail.
Appliance-wide changes. Appliance configuration, the license, certificates, the support tunnel, the server-wide smarthost and the system outbound TLS policy apply to the whole system.

Some answers contain secrets

The DKIM and ARC key tools return private signing keys. The appliance configuration holds stored secrets, and the license record identifies your license. These answers are never recorded or saved as a file, and the tools that take a password, a key or a license file keep those arguments out of StackJack's records too. A tool that is asked to read a key will return it to the assistant that asked, so grant the key tools only to assistants you would trust with the key.

Releasing or deleting quarantined mail needs a second id

SpamTitan identifies a quarantined message by two values: its id and a secret_id. Both come back from the quarantine list and from the message read. Release and delete each need both, so the assistant lists or reads the message first.

Quarantine and message trace search the whole cluster by default

SpamTitan's own default is to search only the node that answered. StackJack asks for all nodes for the quarantine list and the message trace, because a single node would hide part of your mail. You can narrow it with the cluster argument. Message trace requires a start and an end date and a recipient.

Lists come in pages

Most list tools accept a page size up to 100 and a page number starting at 1. Ask for a page at a time and use SpamTitan's filter and sort arguments to narrow a large list. Five small lists are not paged, because SpamTitan documents no paging for them: geoblocking rules, geoblocking exemptions, RBLs, rate control policies and outbound hostnames.

What StackJack does not offer

StackJack holds one token that you made. It does not make, list, revoke or restore tokens, and it does not turn two-factor authentication on or off for the admin account. Those are your own credential management, and revoking tokens in particular could cut StackJack off from your SpamTitan.

Plans

Reading is free. Every change needs the Pro plan on this connector.

Tool reference

See the generated SpamTitan tool reference for the current inventory, plan assignment, input schemas and destructive-action labels.

SpamTitan publishes no rate limit for its API, so StackJack paces requests on its own. Pacing smooths a burst. It does not guarantee that every call arrives, so check whether a change landed before repeating it. See Retrying a failed or timed-out write.

Troubleshooting

"SpamTitan rejected the API token" (401). A 401 on a connection that used to work almost always means the token expired. Tokens last one year by default and cannot be renewed: make a new one and paste it in. If the token is new, check the Location. A token is valid only on the cluster that made it, so a token from one cluster fails on another.

"Accepted the token but not for this action" (403). The admin who made the token cannot call that route. Appliance-wide settings (configuration, license, certificates, the support tunnel and system-wide filtering) need a Global Admin, and per-customer or per-domain routes need at least the matching Domain Group Admin or Domain Admin. Make a new token from an admin whose role can reach it.

"Something answered at that address, but it was not the SpamTitan API." The address is probably the web console (a -smtp-ui address) or another service. Choose your Location again so StackJack uses the cluster's API address, or enter your own host's address under Other.

"That route or record does not exist" (404). Check the id, domain or user first. The list tools show what exists. If the record exists, your edition may not serve the route: SpamTitan Cloud serves some documented routes only through its generic tier routes, and a Gateway or Private Cloud on an older version lacks routes added later.

"A value in the request was rejected" (422). SpamTitan names the field that failed, such as an address, a mask or a required combination of fields. Correct it and try again.

Nothing connects to my Gateway or Private Cloud. StackJack reaches your host from the internet over HTTPS. Check that the host is public, the port is open, and the certificate is one a browser would trust. A self-signed certificate is rejected.

The connector worked and then stopped, with no change on your side. Check the token's expiry date first. Then confirm the admin who made it still exists and still has the same role.

SpamTitan tools

spamtitan_ · 199 tools · Free 84 · Pro 115

Customers

Tool	What it does
`spamtitan_create_customer` Pro · Write	Creates a customer, which SpamTitan calls a domain group.
`spamtitan_delete_customer` Pro · Destructive	DESTRUCTIVE.
`spamtitan_get_customer` Free · Read-only	Returns one customer (domain group) by id.
`spamtitan_list_customers` Free · Read-only	Lists the customers (SpamTitan domain groups).
`spamtitan_lock_out_customer` Pro · Destructive	DESTRUCTIVE.
`spamtitan_reinstate_customer` Pro · Write	Reinstates a customer (a domain group), undoing both a suspension and a lock-out.
`spamtitan_suspend_customer` Pro · Destructive	DESTRUCTIVE.
`spamtitan_update_customer` Pro · Destructive	DESTRUCTIVE.

Domain DKIM keys

Tool	What it does
`spamtitan_create_domain_dkim_key` Pro · Destructive	DESTRUCTIVE.
`spamtitan_delete_domain_dkim_key` Pro · Destructive	DESTRUCTIVE.
`spamtitan_get_domain_dkim_key` Free · Read-only	Show a DKIM key.
`spamtitan_list_domain_dkim_keys` Free · Read-only	List all the DKIMs.
`spamtitan_update_domain_dkim_key` Pro · Write	Update a DKIM comment.
`spamtitan_verify_domain_dkim_key` Free · Read-only	Verify a DKIM.

Domain authentication

Tool	What it does
`spamtitan_get_domain_auth_settings` Free · Read-only	Show the authentication settings for a domain.
`spamtitan_list_domain_auth_settings` Free · Read-only	Returns a list of all domains' authentication methods.
`spamtitan_update_domain_auth_settings` Pro · Destructive	DESTRUCTIVE.

Domains

Tool	What it does
`spamtitan_create_domain` Pro · Destructive	DESTRUCTIVE.
`spamtitan_delete_domain` Pro · Destructive	DESTRUCTIVE.
`spamtitan_get_domain` Free · Read-only	Returns a specified domain.
`spamtitan_list_domains` Free · Read-only	Returns a list of all domains available.
`spamtitan_update_domain` Pro · Destructive	DESTRUCTIVE.
`spamtitan_update_domain_policy` Pro · Destructive	DESTRUCTIVE.

Users and aliases

Tool	What it does
`spamtitan_add_user_aliases` Pro · Write	Adds one or more alias email addresses to a user.
`spamtitan_create_user` Pro · Destructive	DESTRUCTIVE.
`spamtitan_delete_all_user_aliases` Pro · Destructive	DESTRUCTIVE.
`spamtitan_delete_user` Pro · Destructive	DESTRUCTIVE.
`spamtitan_delete_user_alias` Pro · Destructive	DESTRUCTIVE.
`spamtitan_get_user` Free · Read-only	Returns one user by id, with the user's roles and policy.
`spamtitan_list_users` Free · Read-only	Lists the users at the chosen scope.
`spamtitan_update_user` Pro · Destructive	DESTRUCTIVE.
`spamtitan_update_user_policy` Pro · Destructive	DESTRUCTIVE.

Allowed IPs

Tool	What it does
`spamtitan_create_allowed_ip` Pro · Write	Adds an IP address or network to the allowed IP list.
`spamtitan_delete_allowed_ip` Pro · Destructive	DESTRUCTIVE.
`spamtitan_get_allowed_ip` Free · Read-only	Returns one allowed IP entry by id.
`spamtitan_list_allowed_ips` Free · Read-only	Lists the allowed IP entries: the addresses and networks exempt from filtering checks.
`spamtitan_update_allowed_ip` Pro · Write	Updates an allowed IP entry: its address, prefix length or comment.

Blocked IPs

Tool	What it does
`spamtitan_create_blocked_ip` Pro · Write	Adds an IP address or network to the blocked IP list.
`spamtitan_delete_blocked_ip` Pro · Destructive	DESTRUCTIVE.
`spamtitan_get_blocked_ip` Free · Read-only	Returns one blocked IP entry by id.
`spamtitan_list_blocked_ips` Free · Read-only	Lists the blocked IP entries: the addresses and networks SpamTitan blocks mail from.
`spamtitan_update_blocked_ip` Pro · Write	Updates a blocked IP entry: its address, prefix length or comment.

Sender allow list

Tool	What it does
`spamtitan_create_allow_list_entry` Pro · Write	Creates an allow-list entry for a sender address or a sender domain.
`spamtitan_delete_allow_list_entry` Pro · Destructive	DESTRUCTIVE.
`spamtitan_get_allow_list_entry` Free · Read-only	Returns one allow-list entry by id, at the chosen scope.
`spamtitan_list_allow_list` Free · Read-only	Lists the allow-listed sender addresses and domains at the chosen scope.
`spamtitan_update_allow_list_entry` Pro · Destructive	DESTRUCTIVE.

Sender block list

Tool	What it does
`spamtitan_create_block_list_entry` Pro · Write	Creates a block-list entry for a sender address or a sender domain.
`spamtitan_delete_block_list_entry` Pro · Destructive	DESTRUCTIVE.
`spamtitan_get_block_list_entry` Free · Read-only	Returns one block-list entry by id, at the chosen scope.
`spamtitan_list_block_list` Free · Read-only	Lists the blocked sender addresses and domains at the chosen scope.
`spamtitan_update_block_list_entry` Pro · Destructive	DESTRUCTIVE.

Mail queue

Tool	What it does
`spamtitan_get_mail_queue` Free · Read-only	Shows a summary of the mail in the SpamTitan queues.

Message trace

Tool	What it does
`spamtitan_trace_messages` Free · Read-only	Search for messages for a recipient in a specific time period.

Quarantine

Tool	What it does
`spamtitan_delete_quarantine_message` Pro · Destructive	DESTRUCTIVE.
`spamtitan_get_quarantine_message` Free · Read-only	Show the details of a Quarantined Mail.
`spamtitan_list_quarantine` Free · Read-only	List the quarantine for the authenticated user, or for a defined group.
`spamtitan_release_quarantine_message` Pro · Destructive	DESTRUCTIVE.
`spamtitan_request_quarantine_report` Pro · Destructive	DESTRUCTIVE.
`spamtitan_request_user_quarantine_report` Pro · Destructive	DESTRUCTIVE.

Reports

Tool	What it does
`spamtitan_get_license_usage_report` Free · Read-only	Show a summary of licensing information, either for the system, domain, or domain group.
`spamtitan_get_scan_summary_report` Free · Read-only	Show a summary of mail delivered to the SpamTitan system.
`spamtitan_get_spam_update_report` Free · Read-only	Show a summary of spam updates.
`spamtitan_get_virus_update_report` Free · Read-only	Show a summary of virus updates for both Bitdefender and ClamAV.

ARC signing keys

Tool	What it does
`spamtitan_create_arc_key` Pro · Destructive	DESTRUCTIVE.
`spamtitan_delete_arc_key` Pro · Destructive	DESTRUCTIVE.
`spamtitan_get_active_arc_key` Free · Read-only	Returns the ARC signing key SpamTitan signs with now, including its private key and its public key as a DNS TXT record.
`spamtitan_get_arc_key` Free · Read-only	Returns one ARC signing key by id, including its private key and its public key as a DNS TXT record.
`spamtitan_list_arc_keys` Free · Read-only	Lists the ARC signing keys on the system, each with its private key and its public key as a DNS TXT record.
`spamtitan_set_active_arc_key` Pro · Write	Selects which ARC signing key SpamTitan signs with.
`spamtitan_update_arc_key` Pro · Write	Changes the comment on an ARC signing key; the key itself is not changed.
`spamtitan_verify_arc_key` Free · Read-only	Reports whether an ARC signing key is valid for use: the answer is verified, true or false.

DKIM checking and bypass

Tool	What it does
`spamtitan_create_dkim_bypass_entry` Pro · Write	Adds an IP address or network to the DKIM exemption list.
`spamtitan_delete_dkim_bypass_entry` Pro · Destructive	DESTRUCTIVE.
`spamtitan_get_adsp_checking` Free · Read-only	Shows whether ADSP (Author Domain Signing Practices) checking is on; the answer is enabled, true or false.
`spamtitan_get_dkim_bypass_entry` Free · Read-only	Returns one DKIM bypass entry by id.
`spamtitan_get_dkim_checking` Free · Read-only	Shows whether DKIM signature checking is on; the answer is enabled, true or false.
`spamtitan_list_dkim_bypass` Free · Read-only	Lists the IP addresses and networks exempt from DKIM checking.
`spamtitan_set_adsp_checking` Pro · Destructive	DESTRUCTIVE.
`spamtitan_set_dkim_checking` Pro · Destructive	DESTRUCTIVE.
`spamtitan_update_dkim_bypass_entry` Pro · Write	Updates a DKIM bypass entry: its address, prefix length or comment.

DMARC

Tool	What it does
`spamtitan_create_dmarc_bypass_entry` Pro · Write	Adds an IP address or network to the DMARC exemption list (the vendor calls it the DMARC whitelist).
`spamtitan_delete_dmarc_bypass_entry` Pro · Destructive	DESTRUCTIVE.
`spamtitan_get_dmarc_arc_trust` Free · Read-only	Shows whether DMARC implicitly trusts every ARC header on inbound mail; the answer is enabled, true or false.
`spamtitan_get_dmarc_bypass_entry` Free · Read-only	Returns one DMARC bypass entry by id.
`spamtitan_get_dmarc_checking` Free · Read-only	Shows whether DMARC checking is on; the answer is enabled, true or false.
`spamtitan_get_dmarc_failure_action` Free · Read-only	Shows the action SpamTitan takes when the sender's DMARC policy says reject or quarantine.
`spamtitan_get_dmarc_mailing_list_whitelisting` Free · Read-only	Shows whether mailing list mail is exempt from DMARC; the answer is enabled, true or false.
`spamtitan_get_dmarc_reporting` Free · Read-only	Shows the DMARC reporting settings SpamTitan uses in its aggregate reports: the sender email, the organization name and the extra contact information.
`spamtitan_list_dmarc_bypass` Free · Read-only	Lists the IP addresses and networks exempt from DMARC checking.
`spamtitan_reset_dmarc_reporting` Pro · Destructive	DESTRUCTIVE.
`spamtitan_set_dmarc_arc_trust` Pro · Destructive	DESTRUCTIVE.
`spamtitan_set_dmarc_checking` Pro · Destructive	DESTRUCTIVE.
`spamtitan_set_dmarc_failure_action` Pro · Destructive	DESTRUCTIVE.
`spamtitan_set_dmarc_mailing_list_whitelisting` Pro · Destructive	DESTRUCTIVE.
`spamtitan_set_dmarc_reporting` Pro · Write	Sets the identity SpamTitan puts in its DMARC aggregate reports: the sender email, the organization name and the extra contact information.
`spamtitan_update_dmarc_bypass_entry` Pro · Write	Updates a DMARC bypass entry: its address, prefix length or comment.

SPF

Tool	What it does
`spamtitan_create_spf_bypass_entry` Pro · Write	Adds an IP address or network to the SPF exemption list.
`spamtitan_delete_spf_bypass_entry` Pro · Destructive	DESTRUCTIVE.
`spamtitan_get_spf_bypass_entry` Free · Read-only	Returns one SPF bypass entry by id.
`spamtitan_get_spf_checking` Free · Read-only	Shows whether SPF checking is on; the answer is enabled, true or false.
`spamtitan_get_spf_rejection` Free · Read-only	Shows whether SPF rejection is on; the answer is reject, true or false.
`spamtitan_get_spf_rejection_for_dmarc_none` Free · Read-only	Shows whether SPF rejection is on for senders whose DMARC policy is none; the answer is reject, true or false.
`spamtitan_list_spf_bypass` Free · Read-only	Lists the IP addresses and networks exempt from SPF checking.
`spamtitan_set_spf_checking` Pro · Destructive	DESTRUCTIVE.
`spamtitan_set_spf_rejection` Pro · Destructive	DESTRUCTIVE.
`spamtitan_set_spf_rejection_for_dmarc_none` Pro · Destructive	DESTRUCTIVE.
`spamtitan_update_spf_bypass_entry` Pro · Write	Updates an SPF bypass entry: its address, prefix length or comment.

Geoblocking

Tool	What it does
`spamtitan_get_geoblocking` Free · Read-only	Shows whether geoblocking (blocking or allowing mail by the sender's country) is enabled.
`spamtitan_set_geoblocking` Pro · Destructive	DESTRUCTIVE.

Geoblocking exemptions

Tool	What it does
`spamtitan_create_geo_exemption` Pro · Write	Exempts one sender (a domain, an email address or an IP) from geoblocking.
`spamtitan_delete_geo_exemption` Pro · Destructive	DESTRUCTIVE.
`spamtitan_get_geo_exemption` Free · Read-only	Shows one geoblocking sender exemption.
`spamtitan_list_geo_exemptions` Free · Read-only	Lists the geoblocking sender exemptions.
`spamtitan_update_geo_exemption` Pro · Write	Updates one geoblocking sender exemption.

Geoblocking rules

Tool	What it does
`spamtitan_create_geo_rule` Pro · Write	Creates a geoblocking rule for one country.
`spamtitan_delete_geo_rule` Pro · Destructive	DESTRUCTIVE.
`spamtitan_get_geo_rule` Free · Read-only	Shows the geoblocking rule of one country.
`spamtitan_list_geo_rules` Free · Read-only	Lists the geoblocking allow and block rules.
`spamtitan_update_geo_rule` Pro · Write	Updates the geoblocking rule of one country.

Link Lock

Tool	What it does
`spamtitan_create_link_lock_allowed_url` Pro · Write	Adds a URL that Link Lock does not rewrite or block.
`spamtitan_create_link_lock_policy` Pro · Write	Creates the Link Lock policy of one customer, domain or user.
`spamtitan_delete_link_lock_allowed_url` Pro · Destructive	DESTRUCTIVE.
`spamtitan_delete_link_lock_policy` Pro · Destructive	DESTRUCTIVE.
`spamtitan_get_link_lock_allowed_url` Free · Read-only	Shows one Link Lock allowed URL.
`spamtitan_get_link_lock_policy` Free · Read-only	Shows the current Link Lock policy.
`spamtitan_list_link_lock_allowed_urls` Free · Read-only	Lists the URLs that Link Lock does not rewrite or block.
`spamtitan_update_link_lock_allowed_url` Pro · Write	Updates one Link Lock allowed URL.
`spamtitan_update_link_lock_policy` Pro · Write	Updates the Link Lock policy of the system, a domain or a user.

Pattern filters

Tool	What it does
`spamtitan_create_pattern_filter` Pro · Write	Creates a pattern filter that matches mail and changes its spam score.
`spamtitan_delete_pattern_filter` Pro · Destructive	DESTRUCTIVE.
`spamtitan_get_pattern_filter` Free · Read-only	Shows one pattern filter.
`spamtitan_list_pattern_filters` Free · Read-only	Lists the pattern filters.
`spamtitan_update_pattern_filter` Pro · Write	Updates one pattern filter.

RBL bypass

Tool	What it does
`spamtitan_create_rbl_bypass_entry` Pro · Write	Adds an IP address or network that skips RBL checks.
`spamtitan_delete_rbl_bypass_entry` Pro · Destructive	DESTRUCTIVE.
`spamtitan_get_rbl_bypass_entry` Free · Read-only	Shows one RBL bypass entry.
`spamtitan_list_rbl_bypass` Free · Read-only	Lists the IP addresses and networks that skip RBL checks.
`spamtitan_update_rbl_bypass_entry` Pro · Write	Updates one RBL bypass entry.

RBL lists

Tool	What it does
`spamtitan_create_rbl` Pro · Write	Adds an RBL (a DNS blocklist host name) to the end of the RBL list.
`spamtitan_delete_rbl` Pro · Destructive	DESTRUCTIVE.
`spamtitan_disable_all_rbls` Pro · Destructive	DESTRUCTIVE.
`spamtitan_list_rbls` Free · Read-only	Lists the RBLs on the appliance, in the order they are run.
`spamtitan_replace_rbl` Pro · Destructive	DESTRUCTIVE.
`spamtitan_test_rbl_for_ip` Free · Read-only	Shows which RBLs an IP address is listed on.

Rate controls

Tool	What it does
`spamtitan_create_rate_control_policy` Pro · Write	Creates a rate control policy that limits how much mail a source may send.
`spamtitan_delete_rate_control_policy` Pro · Destructive	DESTRUCTIVE.
`spamtitan_get_rate_control_policy` Free · Read-only	Shows one rate control policy.
`spamtitan_get_rate_controls` Free · Read-only	Shows whether rate controls are enabled on the system.
`spamtitan_list_rate_control_policies` Free · Read-only	Lists the rate control policies.
`spamtitan_set_rate_controls` Pro · Destructive	DESTRUCTIVE.
`spamtitan_update_rate_control_policy` Pro · Write	Updates one rate control policy.

Sandboxing

Tool	What it does
`spamtitan_get_sandboxing` Free · Read-only	Shows whether sandboxing is enabled.
`spamtitan_set_sandboxing` Pro · Destructive	DESTRUCTIVE.

Outbound TLS

Tool	What it does
`spamtitan_add_tls_policy` Pro · Write	Adds a TLS exception policy for one recipient domain.
`spamtitan_delete_tls_policy` Pro · Destructive	DESTRUCTIVE.
`spamtitan_get_system_tls_policy` Free · Read-only	Shows the system-wide outbound TLS policy.
`spamtitan_get_tls_client_certificate` Free · Read-only	Shows which certificate SpamTitan sends when a receiving server asks for a client certificate.
`spamtitan_get_tls_policy` Free · Read-only	Shows one per-recipient TLS exception policy.
`spamtitan_list_tls_policies` Free · Read-only	Lists the per-recipient TLS exception policies.
`spamtitan_remove_tls_client_certificate` Pro · Destructive	DESTRUCTIVE.
`spamtitan_set_system_tls_policy` Pro · Destructive	DESTRUCTIVE.
`spamtitan_set_tls_client_certificate` Pro · Destructive	DESTRUCTIVE.
`spamtitan_update_tls_policy` Pro · Write	Updates one per-recipient TLS exception policy.

Outbound relay

Tool	What it does
`spamtitan_add_outbound_hostname` Pro · Write	Adds the hostname of an outbound relay.
`spamtitan_delete_outbound_hostname` Pro · Destructive	DESTRUCTIVE.
`spamtitan_get_hide_internal_networks` Free · Read-only	Shows whether Hide Internal Networks is enabled.
`spamtitan_get_outbound_policy` Free · Read-only	Shows the outbound mail policy.
`spamtitan_list_outbound_hostnames` Free · Read-only	Lists the hostnames of the outbound relays.
`spamtitan_set_hide_internal_networks` Pro · Destructive	DESTRUCTIVE.
`spamtitan_update_outbound_policy` Pro · Write	Updates the outbound mail policy for spam, viruses, banned attachments and the quarantine report.

SASL

Tool	What it does
`spamtitan_get_sasl_settings` Free · Read-only	Shows the SASL settings.
`spamtitan_set_sasl_settings` Pro · Destructive	DESTRUCTIVE.

Smarthosts

Tool	What it does
`spamtitan_add_sender_smarthost` Pro · Destructive	DESTRUCTIVE.
`spamtitan_delete_sender_smarthost` Pro · Destructive	DESTRUCTIVE.
`spamtitan_disable_server_smarthost` Pro · Destructive	DESTRUCTIVE.
`spamtitan_get_sender_smarthost` Free · Read-only	Shows one sender-based smarthost.
`spamtitan_get_server_smarthost` Free · Read-only	Shows the server-wide smarthost settings.
`spamtitan_list_sender_smarthosts` Free · Read-only	Lists the sender-based smarthosts.
`spamtitan_set_server_smarthost` Pro · Destructive	DESTRUCTIVE.
`spamtitan_update_sender_smarthost` Pro · Destructive	DESTRUCTIVE.

Trusted networks

Tool	What it does
`spamtitan_add_trusted_network` Pro · Write	Adds a trusted network.
`spamtitan_delete_trusted_network` Pro · Destructive	DESTRUCTIVE.
`spamtitan_get_outbound_domain_verification` Free · Read-only	Shows whether outbound domain verification is enabled.
`spamtitan_get_trusted_network` Free · Read-only	Shows one trusted network.
`spamtitan_list_trusted_networks` Free · Read-only	Lists the trusted networks.
`spamtitan_set_outbound_domain_verification` Pro · Destructive	DESTRUCTIVE.
`spamtitan_update_trusted_network` Pro · Write	Updates one trusted network.

Admin account

Tool	What it does
`spamtitan_change_account_password` Pro · Destructive	DESTRUCTIVE.

Appliance configuration

Tool	What it does
`spamtitan_get_appliance_config` Free · Read-only	Provides the current values of SpamTitan configuration.
`spamtitan_set_appliance_config_value` Pro · Destructive	DESTRUCTIVE.

License and certificate

Tool	What it does
`spamtitan_apply_license` Pro · Destructive	DESTRUCTIVE.
`spamtitan_get_letsencrypt_status` Free · Read-only	Provides the current status of a LetsEncrypt certificate.
`spamtitan_get_license_key` Free · Read-only	Provides information about who the license is registered to.
`spamtitan_get_license_status` Free · Read-only	Provides details of the current status of the currently applied license.
`spamtitan_request_letsencrypt_certificate` Pro · Destructive	DESTRUCTIVE.

Support tunnel

Tool	What it does
`spamtitan_close_support_tunnel` Pro · Destructive	DESTRUCTIVE.
`spamtitan_get_support_tunnel_status` Free · Read-only	Get the current support port status.
`spamtitan_open_support_tunnel` Pro · Destructive	DESTRUCTIVE.

Was this helpful?

Still need help? Ask the team