domains

Check the TXT record now, and whether the name points here.

post/v1/domains/{hostname}:verify

Request

  • Base URL: https://api.withruntime.com
  • URL: https://api.withruntime.com/v1/domains/{hostname}:verify
  • Auth: HTTP bearer

Path parameters

hostnamestring required

The hostname, such as app.example.com.

Headers

Idempotency-Keystring

Replaying the same key with the same request within 24 hours returns the first result and never repeats the effect. A refusal is not kept: a request refused before it ran (no_capacity, busy, a limit) runs afresh when sent again with its key. The SDKs send one automatically; the server makes one when absent and returns it in the idempotency-key response header.

Response

Success

idstring
hostnamestring
sandboxIdstring nullable

The sandbox it serves; null for an App's.

appIdstring nullable

The App it serves; null for a sandbox's port.

portinteger
statestring

pending (prove it with the TXT record), active, or released.

urlstring
disabledboolean

Turned off by Runtime after a report. Contact support.

verifiedAtstring date-time nullable
checkedAtstring date-time nullable
checkErrorstring nullable
createdAtstring date-time
pointedboolean nullable

The name resolves to Runtime's edge now.

hintstring

Changes

No recorded changes to this operation across all 1 revision of this API.