InOrbitdocs
Sign in
Docs
Have a token? Manage tokens in the console
POST
/v1/accounts/orgs/{org_id}/domains/{domain}/check

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.

Authorization

bearer
headerAuthorizationBearer <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.

Path Parameters

org_id*string

The account's id: org in GET /v1/me.

domain*string

The domain, lower case, as it was added: company.hr.

Header Parameters

idempotency-key?string

Makes 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.

Length1 <= length <= 255

Request Body

iohr.accounts.v1.CheckDomainRequest; path variables override their fields

application/json
  1. body

iohr.accounts.v1.CheckDomainRequest

domain?string
org_id?string

Response Body

iohr.accounts.v1.CheckDomainResponse

application/json
  1. response

iohr.accounts.v1.CheckDomainResponse

domain?

iohr.accounts.v1.Domain

resolvers*array<>
status*string
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.checkDomain("<org_id>", "<domain>", {});  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"  },  "resolvers": [    {      "answered": true,      "dnssec": true,      "name": "string",      "seen": true,      "value": "string"    }  ],  "status": "string"}

Add a domain POST

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`.

Confirm a domain POST

Checks once more and, when the record is seen, makes the domain `verified` for this account. A domain is verified for one account at a time: another account holding it loses it and receives `domain.transferred`. Needs scope `domains:write`.