API reference
Plan DNS changes
Plan creates, updates and deletes of A, AAAA, CNAME, TXT, MX and NS records in one zone. Nothing is sent to Cloudflare. The answer is the plan: its id, each change with the record before and after, and expires_at, after which the plan can no longer be applied. The zone has to be covered by a verified domain of the account.
Needs scope dns:write.
bearerAuthorizationBearer <JWT>An access token from the identity provider: a person's, or a customer's from the client credentials grant with an API key (developers.inorbit.hr). The gateway verifies it; the audience is iohr-api.
org_id*stringThe account's id: org in GET /v1/me.
connection_id*stringThe connection's id, con_ and a ULID, from List connections.
zone_id*stringThe zone's id, from List DNS zones.
iohr.dns.v1.PlanChangesRequest; path variables override their fields
application/json- body
iohr.dns.v1.PlanChangesRequest
changes?array<>connection_id?stringorg_id?stringzone_id?stringiohr.dns.v1.PlanChangesResponse
application/json- response
iohr.dns.v1.PlanChangesResponse
plan?iohr.dns.v1.Plan
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.dns.planChanges("<org_id>", "<connection_id>", "<zone_id>", {}); console.log(value);} catch (e) { if (!(e instanceof ApiError)) throw e; console.error(`${e.code}: ${e.problem} (request id ${e.raw.requestId})`); process.exitCode = 1;}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.
{ "plan": { "applied_at": "string", "applied_by": "string", "changes": [ { "after": { "comment": "string", "content": "string", "id": "string", "name": "string", "priority": 0, "proxied": true, "ttl": 0, "type": "string" }, "before": { "comment": "string", "content": "string", "id": "string", "name": "string", "priority": 0, "proxied": true, "ttl": 0, "type": "string" }, "op": "string", "record_id": "string" } ], "connection_id": "string", "created_at": "string", "created_by": "string", "error": "string", "expires_at": "string", "id": "string", "org_id": "string", "state": "string", "zone_id": "string", "zone_name": "string" }}