Skip to content

Domain.connect

Attaches a domain you already hold and verifies you own it through DNS.

Action class
None
Approval
Runs on its own
Emits
Domain.connected
Venues
Bing, Google Search Console
Price
Free
More factsFewer facts
POST https://api.sb/{your-domain}/domains/connect

Its Inputs, Outputs, Effects and guards quote the hub’s Domain.connect; this page adds what each Venue honors, its limits and a worked call. It is one of the Verbs of Sites and content.

Inputs

NameTypeDefaultMeaning
hostnamestringRequiredThe hostname to attach.
startupStartupRequiredThe startup it serves.
tenantTenantNone.The Tenant it serves, when a customer connects its own name. Optional.

Outputs

FieldTypeWhat null means
domainDomainNever null: the connected Domain.

Effects

Action class

None: no approval rule names it, so it runs within its seat’s Permissions and Limits

Modes
  • try: Runs every check and returns the record as it would be; nothing is stored.
  • send: Returns a pending Action at once; Domain.connected fires when it is done.
  • do: Waits for the Action to finish and returns the record.
Idempotency

Only with a key: the same Idempotency-Key and input return the first Action, and the same key with other input returns 409.

Saved or shared

Issues a certificate once the DNS record verifies. Asks for a TXT ownership proof and a CNAME that delegates certificate validation; refuses to reach live without the CNAME. Refuses a wildcard name for a Tenant, and past the Tenant’s name count follows its Entitlement’s atBound. Registers the Domain with Stripe as a payment method domain on the startup’s account.

Emits

Domain.connected with { domain }

Performed by

Whichever seat calls it

Price

Free on your own account: the platform charges nothing for the call.

On each Venue

VenueFormats
BingResponsive search ad
Google Search ConsoleNone.

Each Venue’s caps, review and rate limits are on its integration page, linked from its row. A field marked Not sent is one that Venue has no place for; the call never fails on it.

What try does

AccountWhat try does
Bing WebmasterReturns the URLs IndexNow would receive and the key file it would check; nothing is pushed.
Google Search ConsoleReads run for real, because a read changes nothing in Search Console; try stores no rows and submits no sitemap.

Refuses when

The hub sets no guard of its own on this call: it refuses only on the shared checks every write meets (a missing record, a Permission the seat lacks).

Through a connected account it can also meet the shared account refusals.

When it waits

Returns in one response; nothing waits.

Example

In send mode the call returns its pending Action at once, and Domain.connected delivers the result.

You, to your agent
Connect tryleaseline.app, which I bought last week.
Response, in send mode
{
  "mode": "send",
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/action_Sd3kQ9vT2w",
    "operation": "Domain.connect",
    "status": "pending",
    "reason": "running"
  }
}

To retry, send the same Idempotency-Key: the retry returns the first answer for $0. A new key reads again.

Used by