Skip to Content
Deliverability

Domain health checks

Start a health check of one or more domains and follow it as a job.

Deliverability1 endpointKen-Version: 2026-11-02AuthenticationWorkspacesErrors
MarkdownOpenAPI

Headers

The endpoints on this page take these headers. Each endpoint's curl shows the ones it sends.

NameInTypeRequiredDescription
Ken-Versionheaderstring, one of: 2026-11-02, 1.1optionalThe API version, a date in YYYY-MM-DD form. 1.1 is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and 404 where the path exists only in this version. A date that is not a version answers 400 unsupported_version; any other value that is not a version is treated as legacy.
X-Ken-Workspace-Idheaderinteger (int64)optionalThe id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers 400 workspace_required. A workspace you are not a member of answers 404 not_found.

Start a domain health check

POST/v1/domain-health-checksdomain-health-checks.create
Permission
Delivery edit
Rate limit
10 requests a minute per API key

Try it on developer.ken.so

Starts a health check of the workspace's domains and answers 202 with a domain_health job. Poll GET /v1/jobs/{jobId}?type=domain_health until the job finishes, then read the results with GET /v1/domains/{domainId}/health.

domainIds limits the check to those domains. Leave it out, or send an empty list, to check every domain. Kenso checks only domains whose mailboxes it hosts and skips any other id. One check runs at a time in a workspace. Example: { "domainIds": [4, 9] }.

Errors:

  • 400 validation_failed: domainIds has more than 1,000 ids, or an id of 0.
  • 409 conflict: a check is already running in the workspace. The response's data is that running job, so poll it instead of starting another.

Requires Delivery edit.

Request body

application/json, optional.

FieldTypeRequiredDescription
domainIdsarray of integer (int64)optionalIds of the domains to check, at most 1,000. Omitted, null or an empty list checks every domain in the workspace.
Request
curl -X POST "https://api.ken.so/v1/domain-health-checks" \
  -H "Authorization: Bearer $KENSO_API_KEY" \
  -H "Ken-Version: 2026-11-02" \
  -H "X-Ken-Workspace-Id: $KENSO_WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "domainIds": [
    812
  ]
}'

Response 202

data is a Job.

Show the 14 response fields and an example

The fields and an example are also on this endpoint's Markdown page.


On this page