Start proving a domain: scope is domain (the domain and every name under it) or subdomain (one name under a registered domain and what is under it). The answer carries record_name and record_value, the one TXT record to publish, and dns_provider, who serves the domain's DNS. The token works for seven days. Adding a domain the account already has pending answers it unchanged.
Needs scope domains:write.
bearerAuthorizationBearer <token>An access token from the identity provider: a person's, or a customer's from the client credentials grant with an API key (docs.inorbit.hr). The gateway verifies it; the audience is iohr-api.
org_id*stringThe account's id: org in GET /v1/me.
idempotency-key?stringMakes a retry safe: a repeat with the same key and the same body within a day answers what the first call did (with Idempotency-Replayed: true) instead of running again; the same key with another body is 422 unprocessable. 1 to 255 visible characters; a UUID is a good one.
1 <= length <= 255iohr.accounts.v1.AddDomainRequest; path variables override their fields
application/json- body
iohr.accounts.v1.AddDomainRequest
domain?stringorg_id?stringscope?stringiohr.accounts.v1.AddDomainResponse
application/json- response
iohr.accounts.v1.AddDomainResponse
domain?iohr.accounts.v1.Domain
import { ApiError, Public } from "@inorbithr/sdk";// Reads INORBIT_TOKEN, or INORBIT_KEY_ID and INORBIT_KEY_SECRET.const api = Public.fromEnv();try { const { value } = await api.accounts.addDomain("<org_id>", { domain: "<domain>", scope: "<scope>", }); console.log(value);} catch (e) { if (!(e instanceof ApiError)) throw e; console.error(`${e.code}: ${e.problem} (request id ${e.raw.requestId})`);}npm install @inorbithr/sdk. Calls the package's public surface; an operation newer than your package needs the next release or a client generated for your account. The SDKs.
{ "domain": { "created_at": "string", "dns_provider": "string", "domain": "string", "expires_at": "string", "last_checked_at": "string", "record_name": "string", "record_value": "string", "scope": "string", "status": "string", "unverified_reason": "string", "verified_at": "string" }}Get a domain GET
One domain of the account, with its record and status. Needs scope `domains:read`.
Check a domain's record POST
Looks the TXT record up now through several public resolvers in different networks and says what each answered. `status` is `pending` (none sees a record), `wrong_value` (a record with another value), `partial` (one resolver sees ours) or `seen` (two or more agree). Once `seen`, the domain may be confirmed. Needs scope `domains:write`.