docs(sending-domains): default new DKIM keys to 2048 bits (SparkPost/Momentum#1241)#577
Open
seewerah wants to merge 1 commit into
Open
docs(sending-domains): default new DKIM keys to 2048 bits (SparkPost/Momentum#1241)#577seewerah wants to merge 1 commit into
seewerah wants to merge 1 commit into
Conversation
… dkim_key_length (SparkPost/Momentum#1241) Update the Sending Domains API blueprint to match the API change in SparkPost/Momentum#1241: the implicit default DKIM key length is now 2048 bits on both POST /sending-domains and POST /sending-domains/{domain}/dkim-keys, and DKIM-key read paths (POST create, single GET, list GET, PUT update) now include a dkim_key_length field derived from the stored public key's RSA modulus. Update the dkim_key_length parameter description to lead with the 2048-bit default, frame the multi-string TXT record requirement around the new default (and note that mainstream DNS providers handle the split automatically), and surface the explicit 1024-bit override as an escape hatch for providers that don't. Add dkim_key_length to the DKIM Key Object schema, its sample payload, and the DKIM Key Constraints table. Update every DKIM-key sub-resource response example (list, create-auto, create-user-keys, single GET, PUT header-only update, PUT full key replacement) to include "dkim_key_length": 2048 so customers reading the docs see the field they will actually receive.
balupillai
approved these changes
May 14, 2026
PauloJeunonSousa
approved these changes
May 14, 2026
rafaelmatsumotomb
approved these changes
May 14, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
dkim_key_lengthparameter onPOST /v1/sending-domainsand onPOST /v1/sending-domains/{domain}/dkim-keysto document the new 2048-bit default and frame the 1024-bit value as an opt-in escape hatch for DNS providers that can't return multi-string TXT records.dkim_key_lengthfield that now appears on every DKIM-key read path (POST create, single GET, list GET, PUT update) in SparkPost/Momentum#1241: add it to the DKIM Key Object schema, the sample payload, the DKIM Key Constraints table (new "Default key length: 2048 bits" row), and every response example for the dkim-keys sub-resource so the docs match what the API actually returns.Why
Matches the behavior change shipping in SparkPost/Momentum#1241. Without these doc updates, customers reading the page would still see "Default: 1024" and would be surprised by a TXT record longer than the docs prepare them for, and the new response field would be undocumented. 2048-bit RSA is the modern DKIM baseline (accepted/preferred by Gmail, Microsoft, Yahoo) and matches what
mcp-server-sparkpostalready does for newly created domains.Scope notes
dkim_key_lengthon the dkim-keys sub-resource responses only. Thedkimsub-object returned by the parentPOST /sending-domainsresponse was intentionally left as-is in Momentum, so the parent-endpoint response examples here are not updated to includedkim_key_length. If we later decide to surface it on the parent endpoint'sdkimsub-object too, a follow-up doc PR can cover those samples.Test plan
dkim_key_lengthparameter blocks on both create endpoints render with "Default: 2048" and the rewritten DNS note.dkim_key_length."dkim_key_length": 2048.