@knowttl/technitium-axi 0.0.0-stage → 0.1.0

package/dist/archive-contract.js

@@ -0,0 +1,27 @@
+// Entry names and selection rules reviewed against the pinned vendor handlers.
+export const archiveContract = {
+    sourceRevision: '0dd592aad21eced4221a9a46204cb1a299972ca0',
+    sources: {
+        'DnsWebService.cs': '1e2f492baa3113d09704589bf0109fd4c9bbc05f65204918d0d485ba8ae5753e',
+        'WebServiceClusterApi.cs': '2bb0efaa14335f9bfa74844db917021a2d2869604d1531b2e85e3105cad1e6d5',
+        'Cluster/ClusterManager.cs': '787086de7f3a2b625e788042d4f8ef2aa8d6ef27c9d235be2ffc94922d4ff496',
+    },
+    backup: {
+        authConfig: ['auth.config'], clusterConfig: ['cluster.config'],
+        webServiceSettings: ['webservice.config', '<certificate-relative-path-within-config>'],
+        dnsSettings: ['dns.config', '<certificate-relative-path-within-config>'],
+        logSettings: ['log.config'], zones: ['zones/*.zone'], allowedZones: ['allowed.config'],
+        blockedZones: ['blocked.config'], blockLists: ['blocklist.config', 'blocklists/*'],
+        apps: ['apps/**/*'], scopes: ['scopes/*.scope'], stats: ['stats/*.stat', 'stats/*.dstat'], logs: ['logs/*.log'],
+    },
+    transfer: {
+        changedFiles: ['auth.config', 'dns.config', 'allowed.config', 'blocked.config', 'blocklist.config'],
+        excludedComponents: ['clusterConfig', 'webServiceSettings', 'logSettings', 'scopes', 'stats', 'logs'],
+        excludedEntries: ['zones/*.zone', 'blocklists/*', '<certificate-relative-path-within-config>'],
+        comparison: 'file mtime > If-Modified-Since; DNSSEC key StateChangedOn > If-Modified-Since',
+        keys: 'zones/<zone-name>.keys: signed Primary members of the cluster catalog; includeZones forces eligible selected names, changed unselected keys remain eligible',
+        appEntries: { unchanged: 'apps/<name>/.exists', package: 'apps/<name>/<name>.zip', config: 'apps/<name>/dnsApp.config' },
+        appMarker: 'Emit zero-byte .exists only when neither package nor config is newer; empty and key-only worlds have no app directories',
+        response: { status: 200, contentType: 'application/zip', lastModified: 'RFC 1123 GMT response time', emptyZip: 'valid protected result' },
+    },
+};

package/dist/catalogue.js

@@ -0,0 +1,20 @@
+import { readContracts } from './read-contracts.js';
+import { archiveContract } from './archive-contract.js';
+export const readFlags = ['--json', '--help', '--config', '--profile', '--result-file', '--fields', '--full', '--max-bytes', '--max-requests', '--max-pages', '--max-elapsed-ms'];
+export const commands = [
+    { command: 'schema', description: 'Show the credential profile JSON Schema', effect: 'local', arguments: [], flags: ['--json', '--help'] },
+    { command: 'inventory', description: 'Show the packaged command inventory', effect: 'local', arguments: [], flags: ['--json', '--help'] },
+    { command: 'status', description: 'Read the selected server status without sending a credential', effect: 'read', operation: 'OP-001', arguments: [], flags: ['--json', '--help', '--config', '--profile'] },
+    { command: 'user session get', description: 'Read the selected session with a redacted projection and optional protected result file', effect: 'read', operation: 'OP-006', arguments: [], flags: ['--json', '--help', '--config', '--profile', '--result-file'] },
+    { command: 'auth status', description: 'Verify the selected credential and report its source without values', effect: 'local', arguments: [], flags: ['--json', '--help', '--config', '--profile'] },
+    { command: 'profile list', description: 'List profile names from the selected config', effect: 'local', arguments: [], flags: ['--json', '--help', '--config'] },
+    { command: 'config path', description: 'Show the selected config path', effect: 'local', arguments: [], flags: ['--json', '--help', '--config'] },
+    { command: 'config import', description: 'Validate and atomically install a config containing SecretRefs', effect: 'local', arguments: [], flags: ['--json', '--help', '--config', '--input-file'] },
+    { command: 'doctor', description: 'Verify credential protection and perform one bounded session read', effect: 'read', arguments: [], flags: ['--json', '--help', '--config', '--profile'] },
+    ...readContracts.filter(item => !['OP-001', 'OP-006'].includes(item.id)).map(item => ({
+        command: item.command, description: `Read ${item.command}`, effect: 'read', operation: item.id,
+        arguments: item.parameters, flags: [...readFlags, ...item.parameters.map(parameter => parameter.flag)],
+        ...(['OP-084', 'OP-125'].includes(item.id) ? { archive: archiveContract } : {}),
+    })),
+];
+export const inventory = { version: 1, tool: 'technitium-axi', commands };

package/dist/cli.js

@@ -0,0 +1,132 @@
+import { readFile } from 'node:fs/promises';
+import { homedir } from 'node:os';
+import { isAbsolute, resolve } from 'node:path';
+import { createHash } from 'node:crypto';
+import { encode } from '@toon-format/toon';
+import { commands, inventory } from './catalogue.js';
+import { configPath, loadConfig, selectProfile } from './credentials.js';
+import { ToolError } from './errors.js';
+import { PrivateFiles } from './private-file.js';
+import { Redactor, saveResult, vendorRead } from './vendor.js';
+import { readContracts } from './read-contracts.js';
+import { readInputs, readOperation } from './reads.js';
+const help = {
+    description: 'Manage Technitium DNS Server through one selected credential profile', commands,
+    flags: ['--help', '--version', '-v', '-V', '--json', '--config', '--profile'],
+    examples: ['technitium-axi status --profile <name>', 'technitium-axi schema --json', 'technitium-axi user session get'],
+};
+export async function main(args) {
+    const redactor = new Redactor();
+    const json = args.includes('--json');
+    const print = (value) => { console.log(redactor.text(json ? JSON.stringify(value) : encode(value))); };
+    try {
+        const options = {};
+        const readOptions = {};
+        const valueFlags = new Set(['--config', '--profile', '--result-file', '--input-file', '--fields', '--max-bytes', '--max-requests', '--max-pages', '--max-elapsed-ms',
+            ...readContracts.flatMap(item => item.parameters.map(parameter => parameter.flag))]);
+        const positional = [];
+        const flags = new Set();
+        for (let i = 0; i < args.length; i++) {
+            const arg = args[i];
+            if (!arg.startsWith('-')) {
+                positional.push(arg);
+                continue;
+            }
+            if (flags.has(arg))
+                throw new ToolError('USAGE', 'Repeated flag', 'Provide each flag once');
+            flags.add(arg);
+            if (valueFlags.has(arg)) {
+                const value = args[++i];
+                if (value === undefined || value.startsWith('-') || (value === '' && ['--config', '--profile', '--result-file', '--input-file'].includes(arg)))
+                    throw new ToolError('USAGE', 'Flag requires a value', `Use ${arg} <value>`);
+                if (arg === '--config')
+                    options.config = value;
+                else if (arg === '--profile')
+                    options.profile = value;
+                else if (arg === '--result-file')
+                    options.resultFile = value;
+                else if (arg === '--input-file')
+                    options.inputFile = value;
+                else
+                    readOptions[arg] = value;
+            }
+        }
+        const command = positional.join(' ');
+        const selected = commands.find(item => item.command === command);
+        const allowed = selected ? [...selected.flags, '--version', '-v', '-V'] : help.flags;
+        if ([...flags].some(flag => !allowed.includes(flag)))
+            throw new ToolError('USAGE', 'Unknown or prohibited flag', `Valid flags: ${allowed.join(', ')}`);
+        if (command && !selected)
+            throw new ToolError('USAGE', 'Unknown command or unexpected argument', 'Run technitium-axi --help');
+        if (args.some(arg => ['--version', '-v', '-V'].includes(arg))) {
+            console.log(JSON.parse(await readFile(new URL('../package.json', import.meta.url), 'utf8')).version);
+            return;
+        }
+        if (flags.has('--help')) {
+            print(selected ? { command: selected.command, description: selected.description, flags: selected.flags, arguments: selected.arguments,
+                examples: [`technitium-axi ${selected.command}`, `technitium-axi ${selected.command} --json`] } : help);
+            return;
+        }
+        if (command === 'schema') {
+            print(JSON.parse(await readFile(new URL('../axi-credential.schema.json', import.meta.url), 'utf8')));
+            return;
+        }
+        if (command === 'inventory') {
+            print(inventory);
+            return;
+        }
+        if (command === 'config path') {
+            print({ config: configPath(options.config) });
+            return;
+        }
+        if (command === 'config import') {
+            if (!options.inputFile)
+                throw new ToolError('USAGE', 'Config input is required', 'Use config import --input-file <file>');
+            const config = await loadConfig(resolve(options.inputFile), true);
+            await new PrivateFiles().write(configPath(options.config), JSON.stringify(config));
+            print({ config: configPath(options.config), profiles: Object.keys(config.profiles).length });
+            return;
+        }
+        if (command === 'profile list') {
+            const config = await loadConfig(configPath(options.config), options.config !== undefined || process.env.TECHNITIUM_AXI_CONFIG !== undefined);
+            const profiles = Object.keys(config.profiles).sort().map(name => ({ name, default: name === config.defaultProfile }));
+            print({ count: profiles.length, profiles, help: ['Run technitium-axi auth status --profile <name>'] });
+            return;
+        }
+        if (options.resultFile && !isAbsolute(options.resultFile))
+            throw new ToolError('USAGE', 'Result file must be absolute', 'Use --result-file <absolute-path>');
+        const readContract = readContracts.find(item => item.command === command);
+        if (readContract)
+            readInputs(readContract, readOptions);
+        const credential = await selectProfile(options);
+        let token;
+        if (command && command !== 'status') {
+            token = await credential.token();
+            redactor.add(token);
+        }
+        if (command === 'auth status') {
+            print({ profile: credential.name, source: credential.source, origin: credential.profile.origin,
+                tokenKind: credential.profile.tokenKind, tokenSource: credential.tokenSource });
+            return;
+        }
+        const result = readContract && !['OP-001', 'OP-006'].includes(readContract.id)
+            ? await readOperation(credential.profile, command, token, readOptions, flags.has('--full'))
+            : await vendorRead(credential.profile, command === '' || command === 'status' ? 'status' : 'user session get', token);
+        if ('secret' in result && typeof result.secret === 'string')
+            redactor.add(result.secret);
+        let reference;
+        if (options.resultFile) {
+            await saveResult(options.resultFile, result.bytes);
+            reference = { path: options.resultFile, bytes: result.bytes.length, sha256: createHash('sha256').update(result.bytes).digest('hex') };
+        }
+        const executable = resolve(process.argv[1] ?? 'bin/technitium-axi.js');
+        const home = homedir();
+        print({ ...(command === '' ? { bin: executable.startsWith(`${home}/`) ? `~${executable.slice(home.length)}` : executable, description: help.description } : {}),
+            ...result.projection, ...(reference ? { result: reference } : {}) });
+    }
+    catch (error) {
+        const failure = error instanceof ToolError ? error : new ToolError('CONFIG_INVALID', 'Unable to read the selected configuration or protected file', 'Check config path, SecretRef, ownership and file permissions');
+        print({ error: { code: failure.code, message: failure.message }, help: [failure.hint] });
+        process.exitCode = failure.exitCode;
+    }
+}

package/dist/credentials.js

@@ -0,0 +1,149 @@
+import { readFile } from 'node:fs/promises';
+import { homedir } from 'node:os';
+import { dirname, isAbsolute, join, resolve } from 'node:path';
+import { Ajv } from 'ajv';
+import { PrivateFiles } from './private-file.js';
+import { invalid, ToolError } from './errors.js';
+const profileName = '^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$';
+const files = new PrivateFiles();
+const fields = { origin: 'ORIGIN', auth: 'AUTH', tokenKind: 'TOKEN_KIND', token: 'TOKEN', username: 'USERNAME', caFile: 'CA_FILE', tlsServerName: 'TLS_SERVER_NAME' };
+export function configPath(explicit) {
+    const base = process.platform === 'win32' ? process.env.APPDATA ?? join(homedir(), 'AppData', 'Roaming')
+        : process.env.XDG_CONFIG_HOME && isAbsolute(process.env.XDG_CONFIG_HOME) ? process.env.XDG_CONFIG_HOME : join(homedir(), '.config');
+    return resolve(explicit ?? process.env.TECHNITIUM_AXI_CONFIG ?? join(base, 'technitium-axi', 'config.json'));
+}
+function statePath() {
+    const base = process.platform === 'win32' ? process.env.LOCALAPPDATA ?? join(homedir(), 'AppData', 'Local')
+        : process.env.XDG_STATE_HOME && isAbsolute(process.env.XDG_STATE_HOME) ? process.env.XDG_STATE_HOME : join(homedir(), '.local', 'state');
+    return join(base, 'technitium-axi', 'credentials.json');
+}
+export function readOnly() {
+    const value = process.env.TECHNITIUM_AXI_READ_ONLY?.toLowerCase();
+    if (value === undefined || ['0', 'false'].includes(value))
+        return false;
+    if (['1', 'true'].includes(value))
+        return true;
+    return invalid('TECHNITIUM_AXI_READ_ONLY must be a boolean');
+}
+async function validator() {
+    const schema = JSON.parse(await readFile(new URL('../axi-credential.schema.json', import.meta.url), 'utf8'));
+    const ajv = new Ajv({ strict: true });
+    ajv.addKeyword({ keyword: 'x-secret', schemaType: 'boolean' });
+    return { profile: ajv.compile(schema), config: ajv.compile({
+            type: 'object', additionalProperties: false, required: ['version', 'profiles'],
+            properties: { version: { const: 1 }, defaultProfile: { type: 'string', pattern: profileName },
+                profiles: { type: 'object', propertyNames: { pattern: profileName }, additionalProperties: schema } },
+        }) };
+}
+export async function loadConfig(path, explicit = false) {
+    let raw;
+    try {
+        raw = await files.read(path, false);
+    }
+    catch (error) {
+        if (error.code !== 'ENOENT')
+            throw error;
+        if (explicit)
+            invalid('Selected config file does not exist');
+        return { version: 1, profiles: {} };
+    }
+    let config;
+    try {
+        config = JSON.parse(raw);
+    }
+    catch {
+        invalid('Config must contain valid JSON');
+    }
+    if (!(await validator()).config(config))
+        invalid('Invalid config, profile fields or SecretRef');
+    for (const profile of Object.values(config.profiles)) {
+        validateOrigin(profile);
+        if (profile.caFile)
+            profile.caFile = resolve(dirname(path), profile.caFile);
+    }
+    if (config.defaultProfile && !Object.hasOwn(config.profiles, config.defaultProfile))
+        invalid('Default profile does not exist');
+    return config;
+}
+export async function selectProfile(options) {
+    readOnly();
+    const path = configPath(options.config);
+    const config = await loadConfig(path, options.config !== undefined || process.env.TECHNITIUM_AXI_CONFIG !== undefined);
+    const requested = options.profile ?? process.env.TECHNITIUM_AXI_PROFILE;
+    const envFields = Object.entries(fields).filter(([, field]) => process.env[`TECHNITIUM_AXI_${field}`] !== undefined);
+    let name;
+    let source;
+    let profile;
+    if (requested !== undefined) {
+        if (!new RegExp(profileName).test(requested))
+            invalid('Invalid profile name');
+        const selected = config.profiles[requested];
+        if (!selected)
+            throw new ToolError('PROFILE_NOT_FOUND', 'Selected profile does not exist', 'Run technitium-axi profile list');
+        name = requested;
+        source = options.profile !== undefined ? 'flag' : 'profile-env';
+        profile = selected;
+    }
+    else if (envFields.length) {
+        const value = Object.fromEntries(envFields.map(([field, suffix]) => [field, field === 'token'
+                ? { env: 'TECHNITIUM_AXI_TOKEN' } : process.env[`TECHNITIUM_AXI_${suffix}`]]));
+        if (!(await validator()).profile(value))
+            invalid('Incomplete or invalid environment profile');
+        if (value.caFile && !isAbsolute(value.caFile))
+            invalid('Environment caFile must be an absolute path');
+        name = 'env';
+        source = 'environment';
+        profile = value;
+    }
+    else {
+        const names = Object.keys(config.profiles);
+        const selected = config.defaultProfile ?? (names.length === 1 ? names[0] : undefined);
+        if (!selected)
+            throw new ToolError(names.length ? 'PROFILE_AMBIGUOUS' : 'PROFILE_REQUIRED', 'Select a credential profile', 'Use --config <file> --profile <name>');
+        name = selected;
+        source = config.defaultProfile ? 'default' : 'sole';
+        profile = config.profiles[name];
+    }
+    validateOrigin(profile);
+    const tokenRef = profile.token ?? { env: 'TECHNITIUM_AXI_TOKEN' };
+    const tokenSource = 'env' in tokenRef ? { env: tokenRef.env } : 'file' in tokenRef ? { file: tokenRef.file } : { stored: statePath() };
+    return { name, source, path, profile, tokenSource, async token() {
+            let token;
+            if ('env' in tokenRef)
+                token = process.env[tokenRef.env];
+            else if ('file' in tokenRef)
+                token = (await files.read(tokenRef.file)).replace(/^\uFEFF/, '').trimEnd();
+            else {
+                let stored;
+                try {
+                    stored = JSON.parse(await files.read(statePath()));
+                }
+                catch (error) {
+                    if (error.code !== 'ENOENT')
+                        throw error;
+                    stored = {};
+                }
+                const entry = stored[name];
+                const binding = { origin: profile.origin, username: profile.username ?? null, tokenKind: profile.tokenKind,
+                    tlsServerName: profile.tlsServerName ?? null, caFile: profile.caFile ?? null };
+                if (entry && JSON.stringify(entry.binding) === JSON.stringify(binding))
+                    token = entry.token;
+            }
+            if (!token)
+                throw new ToolError('AUTH_REQUIRED', 'A supplied token is required', 'Set the environment variable or protected file named by the selected token SecretRef', 1);
+            if (/[\s\x00-\x1f\x7f]/.test(token))
+                invalid('Token contains invalid header characters');
+            return token;
+        } };
+}
+function validateOrigin(profile) {
+    let url;
+    try {
+        url = new URL(profile.origin);
+    }
+    catch {
+        invalid('Invalid HTTPS origin');
+    }
+    if (url.origin !== profile.origin || url.protocol !== 'https:')
+        invalid('Use a canonical HTTPS origin without a path, query or userinfo');
+}

package/dist/errors.js

@@ -0,0 +1,14 @@
+export class ToolError extends Error {
+    code;
+    hint;
+    exitCode;
+    constructor(code, message, hint, exitCode = 2) {
+        super(message);
+        this.code = code;
+        this.hint = hint;
+        this.exitCode = exitCode;
+    }
+}
+export function invalid(message) {
+    throw new ToolError('CONFIG_INVALID', message, 'Run technitium-axi schema --json to inspect valid profile fields');
+}

package/dist/private-file.js

@@ -0,0 +1,75 @@
+import { constants } from 'node:fs';
+import { chmod, lstat, mkdir, open, realpath, rename, rm } from 'node:fs/promises';
+import { dirname, isAbsolute, resolve } from 'node:path';
+import { randomUUID } from 'node:crypto';
+import { ToolError } from './errors.js';
+export class PrivateFiles {
+    platform;
+    constructor(platform = process.platform) {
+        this.platform = platform;
+    }
+    requireFileProtection() {
+        if (this.platform === 'win32')
+            throw new ToolError('CONFIG_INSECURE', 'Windows file ownership and ACL verification is PENDING', 'Use an environment-only profile with an env SecretRef and no config or result file');
+    }
+    insecure(path) {
+        throw new ToolError('CONFIG_INSECURE', 'Unsafe file ownership, permissions or redirected path', `Use an owned regular file and chmod 600 ${path}`);
+    }
+    async direct(path) {
+        if (!isAbsolute(path))
+            this.insecure(path);
+        if ((await lstat(path)).isSymbolicLink() || await realpath(path) !== resolve(path))
+            this.insecure(path);
+    }
+    async read(path, secret = true) {
+        const before = await lstat(path);
+        this.requireFileProtection();
+        await this.direct(path);
+        if (!before.isFile() || before.isSymbolicLink())
+            this.insecure(path);
+        if (before.uid !== process.getuid?.() || (before.mode & (secret ? 0o077 : 0o022)) !== 0)
+            this.insecure(path);
+        const handle = await open(path, constants.O_RDONLY | constants.O_NOFOLLOW);
+        try {
+            const opened = await handle.stat();
+            if (opened.dev !== before.dev || opened.ino !== before.ino)
+                this.insecure(path);
+            if (opened.uid !== process.getuid?.() || (opened.mode & (secret ? 0o077 : 0o022)) !== 0)
+                this.insecure(path);
+            return await handle.readFile('utf8');
+        }
+        finally {
+            await handle.close();
+        }
+    }
+    async write(path, bytes) {
+        this.requireFileProtection();
+        if (!isAbsolute(path))
+            this.insecure(path);
+        const directory = dirname(path);
+        await mkdir(directory, { recursive: true, mode: 0o700 });
+        await this.direct(directory);
+        if ((await lstat(directory)).uid !== process.getuid?.())
+            this.insecure(directory);
+        await chmod(directory, 0o700);
+        try {
+            await this.read(path);
+        }
+        catch (error) {
+            if (error.code !== 'ENOENT')
+                throw error;
+        }
+        const temporary = `${path}.${randomUUID()}.tmp`;
+        const handle = await open(temporary, 'wx', 0o600);
+        try {
+            await handle.writeFile(bytes);
+            await handle.sync();
+            await handle.close();
+            await rename(temporary, path);
+        }
+        finally {
+            await handle.close();
+            await rm(temporary, { force: true });
+        }
+    }
+}

package/dist/read-contracts.js

@@ -0,0 +1,50 @@
+// Contracts reviewed against Technitium DNS Server API at 0dd592aad21eced4221a9a46204cb1a299972ca0.
+// Only documented fields are eligible for ordinary output; unknown fields stay in protected results.
+export const readContracts = [
+    { "id": "OP-001", "command": "status", "path": "/api/status", "kind": "json", "confidential": false, "parameters": [], "response": { "hasDefaultCredentials": "boolean", "ssoEnabled": "boolean", "server": "string", "status": "string" } },
+    { "id": "OP-006", "command": "user session get", "path": "/api/user/session/get", "kind": "json", "confidential": true, "parameters": [], "response": { "username": "string", "info": { "version": "string", "permissions": {} } } },
+    { "id": "OP-012", "command": "user profile get", "path": "/api/user/profile/get", "kind": "json", "confidential": false, "parameters": [], "response": { "displayName": "string", "username": "string", "isSsoUser": "boolean", "totpEnabled": "boolean", "disabled": "boolean", "previousSessionLoggedOn": "string", "previousSessionRemoteAddress": "string", "recentSessionLoggedOn": "string", "recentSessionRemoteAddress": "string", "sessionTimeoutSeconds": "number", "memberOfGroups": { "array": "string" }, "sessions": { "array": { "username": "string", "isCurrentSession": "boolean", "type": "string", "lastSeen": "string", "lastSeenRemoteAddress": "string", "lastSeenUserAgent": "string", "partialToken": "string", "tokenName": "nullable" } } } },
+    { "id": "OP-014", "command": "user check-for-update", "path": "/api/user/checkForUpdate", "kind": "json", "confidential": false, "parameters": [], "response": { "updateAvailable": "boolean", "updateVersion": "string", "currentVersion": "string", "updateTitle": "string", "updateMessage": "string", "downloadLink": "string", "instructionsLink": "string", "changeLogLink": "string" } },
+    { "id": "OP-015", "command": "dashboard metrics json", "path": "/api/dashboard/metrics/json", "kind": "json", "confidential": false, "parameters": [], "response": { "uptimestamp": "string", "uptimeSeconds": "number", "lifetimeCounters": { "totalQueries": "number", "totalNoError": "number", "totalServerFailure": "number", "totalNxDomain": "number", "totalRefused": "number", "totalAuthoritative": "number", "totalRecursive": "number", "totalCached": "number", "totalBlocked": "number", "totalDropped": "number", "totalClients": "number" } } },
+    { "id": "OP-016", "command": "dashboard metrics text", "path": "/api/dashboard/metrics/text", "kind": "prometheus-text", "confidential": false, "parameters": [], "response": {} },
+    { "id": "OP-017", "command": "dashboard stats get", "path": "/api/dashboard/stats/get", "kind": "json", "confidential": false, "parameters": [{ "name": "node", "flag": "--node", "type": "string", "required": false, "location": "form" }, { "name": "type", "flag": "--type", "type": "string", "required": false, "location": "form", "values": ["LastHour", "LastDay", "LastWeek", "LastMonth", "LastYear", "Custom"] }, { "name": "utc", "flag": "--utc", "type": "boolean", "required": false, "location": "form" }, { "name": "dontTrimQueryTypeData", "flag": "--dont-trim-query-type-data", "type": "boolean", "required": false, "location": "form" }, { "name": "start", "flag": "--start", "type": "date", "required": false, "location": "form" }, { "name": "end", "flag": "--end", "type": "date", "required": false, "location": "form" }], "response": { "stats": { "totalQueries": "number", "totalNoError": "number", "totalServerFailure": "number", "totalNxDomain": "number", "totalRefused": "number", "totalAuthoritative": "number", "totalRecursive": "number", "totalCached": "number", "totalBlocked": "number", "totalDropped": "number", "totalClients": "number", "zones": "number", "cachedEntries": "number", "allowedZones": "number", "blockedZones": "number", "allowListZones": "number", "blockListZones": "number" }, "mainChartData": { "labelFormat": "string", "labels": { "array": "string" }, "datasets": { "array": { "label": "string", "backgroundColor": "string", "borderColor": "string", "borderWidth": "number", "fill": "boolean", "data": { "array": "number" } } } }, "queryResponseChartData": { "labels": { "array": "string" }, "datasets": { "array": { "data": { "array": "number" }, "backgroundColor": { "array": "string" } } } }, "queryTypeChartData": { "labels": { "array": "string" }, "datasets": { "array": { "data": { "array": "number" }, "backgroundColor": { "array": "string" } } } }, "protocolTypeChartData": { "labels": { "array": "string" }, "datasets": { "array": { "data": { "array": "number" }, "backgroundColor": { "array": "string" } } } }, "topClients": { "array": { "name": "string", "domain": "string", "hits": "number", "rateLimited": "boolean" } }, "topDomains": { "array": { "name": "string", "hits": "number" } }, "topBlockedDomains": { "array": { "name": "string", "hits": "number" } } } },
+    { "id": "OP-018", "command": "dashboard stats get-top", "path": "/api/dashboard/stats/getTop", "kind": "json", "confidential": false, "parameters": [{ "name": "node", "flag": "--node", "type": "string", "required": false, "location": "form" }, { "name": "type", "flag": "--type", "type": "string", "required": false, "location": "form", "values": ["LastHour", "LastDay", "LastWeek", "LastMonth", "LastYear", "custom"] }, { "name": "start", "flag": "--start", "type": "date", "required": false, "location": "form" }, { "name": "end", "flag": "--end", "type": "date", "required": false, "location": "form" }, { "name": "statsType", "flag": "--stats-type", "type": "string", "required": true, "location": "form", "values": ["TopClients", "TopDomains", "TopBlockedDomains"] }, { "name": "limit", "flag": "--limit", "type": "integer", "required": false, "location": "form" }, { "name": "noReverseLookup", "flag": "--no-reverse-lookup", "type": "boolean", "required": false, "location": "form" }, { "name": "onlyRateLimitedClients", "flag": "--only-rate-limited-clients", "type": "boolean", "required": false, "location": "form" }], "response": { "topClients": { "array": { "name": "string", "domain": "nullable", "hits": "number", "rateLimited": "boolean" } }, "topDomains": { "array": { "name": "string", "hits": "number" } }, "topBlockedDomains": { "array": { "name": "string", "hits": "number" } } } },
+    { "id": "OP-020", "command": "zone list", "path": "/api/zones/list", "kind": "json", "confidential": false, "parameters": [{ "name": "node", "flag": "--node", "type": "string", "required": false, "location": "form" }, { "name": "filterName", "flag": "--filter-name", "type": "string", "required": false, "location": "form" }, { "name": "filterType", "flag": "--filter-type", "type": "string", "required": false, "location": "form", "values": ["Primary", "Secondary", "Stub", "Forwarder", "SecondaryForwarder", "Catalog", "SecondaryCatalog"] }, { "name": "pageNumber", "flag": "--page-number", "type": "integer", "required": false, "location": "form" }, { "name": "zonesPerPage", "flag": "--zones-per-page", "type": "integer", "required": false, "location": "form" }], "response": { "pageNumber": "number", "totalPages": "number", "totalZones": "number", "zones": { "array": { "name": "string", "type": "string", "dnssecStatus": "string", "soaSerial": "number", "expiry": "string", "isExpired": "boolean", "syncFailed": "boolean", "lastModified": "string", "disabled": "boolean", "internal": "boolean", "notifyFailed": "boolean", "notifyFailedFor": { "array": "string" } } } } },
+    { "id": "OP-021", "command": "zone catalog list", "path": "/api/zones/catalogs/list", "kind": "json", "confidential": false, "parameters": [{ "name": "node", "flag": "--node", "type": "string", "required": false, "location": "form" }], "response": { "catalogZoneNames": { "array": "string" } } },
+    { "id": "OP-024", "command": "zone export", "path": "/api/zones/export", "kind": "zone-text", "confidential": true, "parameters": [{ "name": "node", "flag": "--node", "type": "string", "required": false, "location": "form" }, { "name": "zone", "flag": "--zone", "type": "string", "required": true, "location": "form" }], "response": {} },
+    { "id": "OP-031", "command": "zone options get", "path": "/api/zones/options/get", "kind": "json", "confidential": false, "parameters": [{ "name": "node", "flag": "--node", "type": "string", "required": false, "location": "form" }, { "name": "zone", "flag": "--zone", "type": "string", "required": true, "location": "form" }, { "name": "includeAvailableCatalogZoneNames", "flag": "--include-available-catalog-zone-names", "type": "boolean", "required": false, "location": "form" }, { "name": "includeAvailableTsigKeyNames", "flag": "--include-available-tsig-key-names", "type": "boolean", "required": false, "location": "form" }], "response": { "name": "string", "type": "string", "internal": "boolean", "dnssecStatus": "string", "notifyFailed": "boolean", "notifyFailedFor": { "array": "string" }, "disabled": "boolean", "catalog": "nullable", "overrideCatalogQueryAccess": "boolean", "overrideCatalogZoneTransfer": "boolean", "overrideCatalogNotify": "boolean", "queryAccess": "string", "queryAccessNetworkACL": { "array": "string" }, "zoneTransfer": "string", "zoneTransferNetworkACL": { "array": "string" }, "zoneTransferTsigKeyNames": { "array": "string" }, "notify": "string", "notifyNameServers": { "array": "string" }, "update": "string", "updateNetworkACL": { "array": "string" }, "updateSecurityPolicies": { "array": { "tsigKeyName": "string", "domain": "string", "allowedTypes": { "array": "string" } } }, "availableCatalogZoneNames": { "array": "string" }, "availableTsigKeyNames": { "array": "string" } } },
+    { "id": "OP-033", "command": "zone permission get", "path": "/api/zones/permissions/get", "kind": "json", "confidential": false, "parameters": [{ "name": "node", "flag": "--node", "type": "string", "required": false, "location": "form" }, { "name": "zone", "flag": "--zone", "type": "string", "required": true, "location": "form" }, { "name": "includeUsersAndGroups", "flag": "--include-users-and-groups", "type": "boolean", "required": false, "location": "form" }], "response": { "section": "string", "subItem": "string", "userPermissions": { "array": { "username": "string", "canView": "boolean", "canModify": "boolean", "canDelete": "boolean" } }, "groupPermissions": { "array": { "name": "string", "canView": "boolean", "canModify": "boolean", "canDelete": "boolean" } }, "users": { "array": "string" }, "groups": { "array": "string" } } },
+    { "id": "OP-037", "command": "zone dnssec view-ds", "path": "/api/zones/dnssec/viewDS", "kind": "json", "confidential": false, "parameters": [{ "name": "node", "flag": "--node", "type": "string", "required": false, "location": "form" }, { "name": "zone", "flag": "--zone", "type": "string", "required": true, "location": "form" }], "response": { "name": "string", "type": "string", "internal": "boolean", "disabled": "boolean", "dnssecStatus": "string", "dsRecords": { "array": { "keyTag": "number", "dnsKeyState": "string", "dnsKeyStateReadyBy": "string", "algorithm": "string", "publicKey": "string", "digests": { "array": { "digestType": "string", "digest": "string" } } } } } },
+    { "id": "OP-038", "command": "zone dnssec properties get", "path": "/api/zones/dnssec/properties/get", "kind": "json", "confidential": false, "parameters": [{ "name": "node", "flag": "--node", "type": "string", "required": false, "location": "form" }, { "name": "zone", "flag": "--zone", "type": "string", "required": true, "location": "form" }], "response": { "name": "string", "type": "string", "internal": "boolean", "disabled": "boolean", "dnssecStatus": "string", "dnsKeyTtl": "number", "dnssecPrivateKeys": { "array": { "keyTag": "number", "keyType": "string", "algorithm": "string", "state": "string", "stateChangedOn": "string", "stateReadyBy": "string", "isRetiring": "boolean", "rolloverDays": "number" } } } },
+    { "id": "OP-050", "command": "zone record get", "path": "/api/zones/records/get", "kind": "json", "confidential": true, "parameters": [{ "name": "node", "flag": "--node", "type": "string", "required": false, "location": "form" }, { "name": "domain", "flag": "--domain", "type": "string", "required": true, "location": "form" }, { "name": "zone", "flag": "--zone", "type": "string", "required": false, "location": "form" }, { "name": "listZone", "flag": "--list-zone", "type": "boolean", "required": false, "location": "form" }], "response": { "zone": { "name": "string", "type": "string", "internal": "boolean", "dnssecStatus": "string", "disabled": "boolean" }, "records": { "array": { "disabled": "boolean", "name": "string", "type": "string", "ttl": "number", "rData": { "ipAddress": "string", "nameServer": "string", "primaryNameServer": "string", "responsiblePerson": "string", "serial": "number", "refresh": "number", "retry": "number", "expire": "number", "minimum": "number", "typeCovered": "string", "algorithm": "string", "labels": "number", "originalTtl": "number", "signatureExpiration": "string", "signatureInception": "string", "keyTag": "number", "signersName": "string", "signature": "string", "flags": "string", "protocol": "string-or-number", "publicKey": "string", "computedKeyTag": "number", "dnsKeyState": "string", "computedDigests": { "array": { "digestType": "string", "digest": "string" } }, "dnsKeyStateReadyBy": "string", "hashAlgorithm": "string", "iterations": "number", "salt": "string", "nextHashedOwnerName": "string", "types": { "array": "string" }, "digestType": "string", "digest": "string", "cname": "string", "text": "string", "splitText": "boolean", "characterStringsBase64": { "array": "string" }, "forwarder": "string", "dnssecValidation": "boolean", "proxyType": "string", "proxyAddress": "string", "proxyPort": "number", "proxyUsername": "nullable" }, "dnssecStatus": "string", "lastUsedOn": "string" } } } },
+    { "id": "OP-053", "command": "cache list", "path": "/api/cache/list", "kind": "json", "confidential": false, "parameters": [{ "name": "domain", "flag": "--domain", "type": "string", "required": false, "location": "form" }, { "name": "direction", "flag": "--direction", "type": "string", "required": false, "location": "form", "values": ["up", "down"] }], "response": { "domain": "string", "zones": { "array": "string" }, "records": { "array": { "name": "string", "type": "string", "ttl": "string", "rData": { "value": "string" } } } } },
+    { "id": "OP-056", "command": "allowed list", "path": "/api/allowed/list", "kind": "json", "confidential": false, "parameters": [{ "name": "node", "flag": "--node", "type": "string", "required": false, "location": "form" }, { "name": "domain", "flag": "--domain", "type": "string", "required": false, "location": "form" }, { "name": "direction", "flag": "--direction", "type": "string", "required": false, "location": "form", "values": ["up", "down"] }], "response": { "domain": "string", "zones": { "array": "string" }, "records": { "array": { "name": "string", "type": "string", "ttl": "string", "rData": { "value": "string", "primaryNameServer": "string", "responsiblePerson": "string", "serial": "number", "refresh": "number", "retry": "number", "expire": "number", "minimum": "number" } } } } },
+    { "id": "OP-061", "command": "allowed export", "path": "/api/allowed/export", "kind": "plain-text", "confidential": false, "parameters": [{ "name": "node", "flag": "--node", "type": "string", "required": false, "location": "form" }], "response": {} },
+    { "id": "OP-062", "command": "blocked list", "path": "/api/blocked/list", "kind": "json", "confidential": false, "parameters": [{ "name": "node", "flag": "--node", "type": "string", "required": false, "location": "form" }, { "name": "domain", "flag": "--domain", "type": "string", "required": false, "location": "form" }, { "name": "direction", "flag": "--direction", "type": "string", "required": false, "location": "form", "values": ["up", "down"] }], "response": { "domain": "string", "zones": { "array": "string" }, "records": { "array": { "name": "string", "type": "string", "ttl": "string", "rData": { "value": "string", "primaryNameServer": "string", "responsiblePerson": "string", "serial": "number", "refresh": "number", "retry": "number", "expire": "number", "minimum": "number" } } } } },
+    { "id": "OP-067", "command": "blocked export", "path": "/api/blocked/export", "kind": "plain-text", "confidential": false, "parameters": [{ "name": "node", "flag": "--node", "type": "string", "required": false, "location": "form" }], "response": {} },
+    { "id": "OP-068", "command": "app list", "path": "/api/apps/list", "kind": "json", "confidential": false, "parameters": [{ "name": "node", "flag": "--node", "type": "string", "required": false, "location": "form" }], "response": { "apps": { "array": { "name": "string", "version": "string", "dnsApps": { "array": { "classPath": "string", "description": "string", "isAppRecordRequestHandler": "boolean", "isRequestController": "boolean", "isAuthoritativeRequestHandler": "boolean", "isRequestBlockingHandler": "boolean", "isQueryLogger": "boolean", "isPostProcessor": "boolean", "recordDataTemplate": "nullable" } } } } } },
+    { "id": "OP-069", "command": "app list-store-apps", "path": "/api/apps/listStoreApps", "kind": "json", "confidential": false, "parameters": [{ "name": "node", "flag": "--node", "type": "string", "required": false, "location": "form" }], "response": { "storeApps": { "array": { "name": "string", "version": "string", "description": "string", "url": "string", "size": "string", "installed": "boolean", "installedVersion": "string", "updateAvailable": "boolean" } } } },
+    { "id": "OP-075", "command": "app config get", "path": "/api/apps/config/get", "kind": "json", "confidential": true, "parameters": [{ "name": "node", "flag": "--node", "type": "string", "required": false, "location": "form" }, { "name": "name", "flag": "--name", "type": "string", "required": true, "location": "form" }], "response": { "config": "string" } },
+    { "id": "OP-078", "command": "dns-client health-check", "path": "/api/dnsClient/healthCheck", "kind": "json", "confidential": false, "parameters": [{ "name": "node", "flag": "--node", "type": "string", "required": false, "location": "form" }, { "name": "domain", "flag": "--domain", "type": "string", "required": false, "location": "form" }, { "name": "type", "flag": "--type", "type": "string", "required": false, "location": "form" }], "response": { "server": "string", "status": "string" } },
+    { "id": "OP-079", "command": "settings get", "path": "/api/settings/get", "kind": "json", "confidential": true, "parameters": [], "response": { "version": "string", "hasDnssecPrivateKeys": "boolean", "uptimestamp": "string", "clusterInitialized": "boolean", "dnsServerDomain": "string", "dnsServerLocalEndPoints": { "array": "string" }, "dnsServerIPv4SourceAddresses": { "array": "string" }, "dnsServerIPv6SourceAddresses": { "array": "string" }, "defaultRecordTtl": "number", "defaultNsRecordTtl": "number", "defaultSoaRecordTtl": "number", "defaultResponsiblePerson": "nullable", "useSoaSerialDateScheme": "boolean", "minSoaRefresh": "number", "minSoaRetry": "number", "zoneTransferAllowedNetworks": { "array": "string" }, "notifyAllowedNetworks": { "array": "string" }, "dnsServerEnableCheckForUpdate": "boolean", "dnsAppsEnableAutomaticUpdate": "boolean", "ipv6Mode": "string", "preferIPv6": "boolean", "enableUdpSocketPool": "boolean", "socketPoolExcludedPorts": { "array": "number" }, "udpPayloadSize": "number", "dnssecValidation": "boolean", "eDnsClientSubnet": "boolean", "eDnsClientSubnetIPv4PrefixLength": "number", "eDnsClientSubnetIPv6PrefixLength": "number", "eDnsClientSubnetIpv4Override": "nullable", "eDnsClientSubnetIpv6Override": "nullable", "qpmPrefixLimitsIPv4": { "array": { "prefix": "number", "udpLimit": "number", "tcpLimit": "number" } }, "qpmPrefixLimitsIPv6": { "array": { "prefix": "number", "udpLimit": "number", "tcpLimit": "number" } }, "qpmLimitSampleMinutes": "number", "qpmLimitUdpTruncationPercentage": "number", "qpmLimitBypassList": { "array": "string" }, "clientTimeout": "number", "tcpSendTimeout": "number", "tcpReceiveTimeout": "number", "quicIdleTimeout": "number", "quicMaxInboundStreams": "number", "listenBacklog": "number", "udpSendBufferSizeKB": "number", "udpReceiveBufferSizeKB": "number", "maxConcurrentResolutionsPerCore": "number", "webServiceLocalAddresses": { "array": "string" }, "webServiceHttpPort": "number", "webServiceEnableHttpUnixSocket": "boolean", "webServiceHttpUnixSocket": "nullable", "webServiceEnableTlsUnixSocket": "boolean", "webServiceTlsUnixSocket": "nullable", "webServiceEnableTls": "boolean", "webServiceEnableHttp3": "boolean", "webServiceHttpToTlsRedirect": "boolean", "webServiceUseSelfSignedTlsCertificate": "boolean", "webServiceTlsPort": "number", "webServiceReverseProxyAddresses": { "array": "string" }, "webServiceRealIpHeader": "string", "webServiceCspFrameAncestorsHeader": "string", "webServiceTlsCertificatePath": "nullable", "enableEDnsClientSubnetSourceAddress": "boolean", "enableDnsOverUdpProxy": "boolean", "enableDnsOverTcpProxy": "boolean", "enableDnsOverHttp": "boolean", "enableDnsOverHttpUnixSocket": "boolean", "enableDnsOverHttpsUnixSocket": "boolean", "enableDnsOverTls": "boolean", "enableDnsOverHttps": "boolean", "enableDnsOverHttp3": "boolean", "enableDnsOverQuic": "boolean", "enableDnsOverHttpHelpRedirect": "boolean", "dnsOverUdpProxyPort": "number", "dnsOverTcpProxyPort": "number", "dnsOverHttpPort": "number", "dnsOverHttpUnixSocket": "nullable", "dnsOverHttpsUnixSocket": "nullable", "dnsOverTlsPort": "number", "dnsOverHttpsPort": "number", "dnsOverQuicPort": "number", "dnsReverseProxyNetworkACL": { "array": "string" }, "dnsOverHttpRealIpHeader": "string", "dnsTlsCertificatePath": "nullable", "tsigKeys": { "array": { "keyName": "string", "algorithmName": "string" } }, "recursion": "string", "recursionNetworkACL": { "array": "string" }, "randomizeName": "boolean", "qnameMinimization": "boolean", "locallyServedDnsZones": "boolean", "resolverRetries": "number", "resolverTimeout": "number", "resolverConcurrency": "number", "resolverMaxStackCount": "number", "saveCache": "boolean", "serveStale": "boolean", "serveStaleTtl": "number", "serveStaleAnswerTtl": "number", "serveStaleResetTtl": "number", "serveStaleMaxWaitTime": "number", "cacheMaximumEntries": "number", "cacheMinimumRecordTtl": "number", "cacheMaximumRecordTtl": "number", "cacheNegativeRecordTtl": "number", "cacheFailureRecordTtl": "number", "enableCachePrefetch": "boolean", "cachePrefetchEligibility": "number", "cachePrefetchTrigger": "number", "enableBlocking": "boolean", "allowTxtBlockingReport": "boolean", "blockingBypassList": { "array": "string" }, "blockingType": "string", "blockingAnswerTtl": "number", "customBlockingAddresses": { "array": "string" }, "blockListUrls": { "array": "string" }, "blockListUpdateIntervalHours": "number", "blockListNextUpdatedOn": "string", "proxy": { "type": "string", "address": "string", "port": "number", "username": "nullable" }, "forwarders": { "array": "string" }, "forwarderProtocol": "string", "concurrentForwarding": "boolean", "forwarderRetries": "number", "forwarderTimeout": "number", "forwarderConcurrency": "number", "enableLogging": "boolean", "loggingType": "string", "ignoreResolverLogs": "boolean", "logQueries": "boolean", "noStackTrace": "boolean", "useLocalTime": "boolean", "logFolder": "string", "maxLogFileDays": "number", "enableInMemoryStats": "boolean", "maxStatFileDays": "number" } },
+    { "id": "OP-081", "command": "settings get-tsig-key-names", "path": "/api/settings/getTsigKeyNames", "kind": "json", "confidential": false, "parameters": [], "response": { "tsigKeyNames": { "array": "string" } } },
+    { "id": "OP-084", "command": "settings backup", "path": "/api/settings/backup", "kind": "zip", "confidential": true, "parameters": [{ "name": "node", "flag": "--node", "type": "string", "required": false, "location": "form" }, { "name": "authConfig", "flag": "--auth-config", "type": "boolean", "required": false, "location": "form" }, { "name": "clusterConfig", "flag": "--cluster-config", "type": "boolean", "required": false, "location": "form" }, { "name": "webServiceSettings", "flag": "--web-service-settings", "type": "boolean", "required": false, "location": "form" }, { "name": "dnsSettings", "flag": "--dns-settings", "type": "boolean", "required": false, "location": "form" }, { "name": "logSettings", "flag": "--log-settings", "type": "boolean", "required": false, "location": "form" }, { "name": "zones", "flag": "--zones", "type": "boolean", "required": false, "location": "form" }, { "name": "allowedZones", "flag": "--allowed-zones", "type": "boolean", "required": false, "location": "form" }, { "name": "blockedZones", "flag": "--blocked-zones", "type": "boolean", "required": false, "location": "form" }, { "name": "blockLists", "flag": "--block-lists", "type": "boolean", "required": false, "location": "form" }, { "name": "apps", "flag": "--apps", "type": "boolean", "required": false, "location": "form" }, { "name": "scopes", "flag": "--scopes", "type": "boolean", "required": false, "location": "form" }, { "name": "stats", "flag": "--stats", "type": "boolean", "required": false, "location": "form" }, { "name": "logs", "flag": "--logs", "type": "boolean", "required": false, "location": "form" }], "response": {} },
+    { "id": "OP-086", "command": "dhcp lease list", "path": "/api/dhcp/leases/list", "kind": "json", "confidential": false, "parameters": [], "response": { "leases": { "array": { "scope": "string", "type": "string", "hardwareAddress": "string", "clientIdentifier": "string", "address": "string", "hostName": "nullable", "leaseObtained": "string", "leaseExpires": "string" } } } },
+    { "id": "OP-090", "command": "dhcp scope list", "path": "/api/dhcp/scopes/list", "kind": "json", "confidential": false, "parameters": [], "response": { "scopes": { "array": { "name": "string", "enabled": "boolean", "startingAddress": "string", "endingAddress": "string", "subnetMask": "string", "networkAddress": "string", "broadcastAddress": "string" } } } },
+    { "id": "OP-091", "command": "dhcp scope get", "path": "/api/dhcp/scopes/get", "kind": "json", "confidential": false, "parameters": [{ "name": "name", "flag": "--name", "type": "string", "required": true, "location": "form" }], "response": { "name": "string", "startingAddress": "string", "endingAddress": "string", "subnetMask": "string", "leaseTimeDays": "number", "leaseTimeHours": "number", "leaseTimeMinutes": "number", "offerDelayTime": "number", "pingCheckEnabled": "boolean", "pingCheckTimeout": "number", "pingCheckRetries": "number", "domainName": "string", "domainSearchList": { "array": "string" }, "dnsUpdates": "boolean", "dnsOverwriteForDynamicLease": "boolean", "dnsTtl": "number", "serverAddress": "string", "serverHostName": "string", "bootFileName": "string", "routerAddress": "string", "useThisDnsServer": "boolean", "dnsServers": { "array": "string" }, "winsServers": { "array": "string" }, "ntpServers": { "array": "string" }, "staticRoutes": { "array": { "destination": "string", "subnetMask": "string", "router": "string" } }, "vendorInfo": { "array": { "identifier": "string", "information": "string" } }, "capwapAcIpAddresses": { "array": "string" }, "tftpServerAddresses": { "array": "string" }, "genericOptions": { "array": { "code": "number", "value": "string" } }, "exclusions": { "array": { "startingAddress": "string", "endingAddress": "string" } }, "reservedLeases": { "array": { "hostName": "nullable", "hardwareAddress": "string", "address": "string", "comments": "string" } }, "allowOnlyReservedLeases": "boolean", "blockLocallyAdministeredMacAddresses": "boolean", "ignoreClientIdentifierOption": "boolean" } },
+    { "id": "OP-098", "command": "admin session list", "path": "/api/admin/sessions/list", "kind": "json", "confidential": false, "parameters": [{ "name": "node", "flag": "--node", "type": "string", "required": false, "location": "form" }], "response": { "sessions": { "array": { "username": "string", "isCurrentSession": "boolean", "type": "string", "lastSeen": "string", "lastSeenRemoteAddress": "string", "lastSeenUserAgent": "string", "partialToken": "string", "tokenName": "nullable" } } } },
+    { "id": "OP-101", "command": "admin user list", "path": "/api/admin/users/list", "kind": "json", "confidential": false, "parameters": [{ "name": "node", "flag": "--node", "type": "string", "required": false, "location": "form" }], "response": { "users": { "array": { "displayName": "string", "username": "string", "isSsoUser": "boolean", "disabled": "boolean", "previousSessionLoggedOn": "string", "previousSessionRemoteAddress": "string", "recentSessionLoggedOn": "string", "recentSessionRemoteAddress": "string" } } } },
+    { "id": "OP-103", "command": "admin user get", "path": "/api/admin/users/get", "kind": "json", "confidential": false, "parameters": [{ "name": "node", "flag": "--node", "type": "string", "required": false, "location": "form" }, { "name": "user", "flag": "--user", "type": "string", "required": true, "location": "form" }, { "name": "includeGroups", "flag": "--include-groups", "type": "boolean", "required": false, "location": "form" }], "response": { "displayName": "string", "username": "string", "isSsoUser": "boolean", "totpEnabled": "boolean", "disabled": "boolean", "previousSessionLoggedOn": "string", "previousSessionRemoteAddress": "string", "recentSessionLoggedOn": "string", "recentSessionRemoteAddress": "string", "sessionTimeoutSeconds": "number", "memberOfGroups": { "array": "string" }, "sessions": { "array": { "username": "string", "isCurrentSession": "boolean", "type": "string", "lastSeen": "string", "lastSeenRemoteAddress": "string", "lastSeenUserAgent": "string", "partialToken": "string", "tokenName": "nullable" } }, "groups": { "array": "string" } } },
+    { "id": "OP-106", "command": "admin group list", "path": "/api/admin/groups/list", "kind": "json", "confidential": false, "parameters": [{ "name": "node", "flag": "--node", "type": "string", "required": false, "location": "form" }], "response": { "groups": { "array": { "name": "string", "description": "string" } } } },
+    { "id": "OP-108", "command": "admin group get", "path": "/api/admin/groups/get", "kind": "json", "confidential": false, "parameters": [{ "name": "node", "flag": "--node", "type": "string", "required": false, "location": "form" }, { "name": "group", "flag": "--group", "type": "string", "required": true, "location": "form" }, { "name": "includeUsers", "flag": "--include-users", "type": "boolean", "required": false, "location": "form" }], "response": { "name": "string", "description": "string", "members": { "array": "string" }, "users": { "array": "string" } } },
+    { "id": "OP-111", "command": "admin permission list", "path": "/api/admin/permissions/list", "kind": "json", "confidential": false, "parameters": [{ "name": "node", "flag": "--node", "type": "string", "required": false, "location": "form" }], "response": { "permissions": { "array": { "section": "string", "userPermissions": { "array": { "username": "string", "canView": "boolean", "canModify": "boolean", "canDelete": "boolean" } }, "groupPermissions": { "array": { "name": "string", "canView": "boolean", "canModify": "boolean", "canDelete": "boolean" } } } } } },
+    { "id": "OP-112", "command": "admin permission get", "path": "/api/admin/permissions/get", "kind": "json", "confidential": false, "parameters": [{ "name": "section", "flag": "--section", "type": "string", "required": true, "location": "form" }, { "name": "includeUsersAndGroups", "flag": "--include-users-and-groups", "type": "boolean", "required": false, "location": "form" }], "response": { "section": "string", "userPermissions": { "array": { "username": "string", "canView": "boolean", "canModify": "boolean", "canDelete": "boolean" } }, "groupPermissions": { "array": { "name": "string", "canView": "boolean", "canModify": "boolean", "canDelete": "boolean" } }, "users": { "array": "string" }, "groups": { "array": "string" } } },
+    { "id": "OP-114", "command": "admin sso get", "path": "/api/admin/sso/get", "kind": "json", "confidential": false, "parameters": [{ "name": "includeGroups", "flag": "--include-groups", "type": "boolean", "required": false, "location": "form" }], "response": { "ssoEnabled": "boolean", "ssoAuthority": "nullable", "ssoClientId": "nullable", "ssoMetadataAddress": "nullable", "ssoAllowSignup": "boolean", "ssoAllowSignupOnlyForMappedUsers": "boolean", "ssoGroupMap": { "array": { "remoteGroup": "string", "localGroup": "string" } }, "localGroups": { "array": "string" }, "ssoScopes": { "array": "string" } } },
+    { "id": "OP-118", "command": "admin cluster state", "path": "/api/admin/cluster/state", "kind": "json", "confidential": false, "parameters": [{ "name": "node", "flag": "--node", "type": "string", "required": false, "location": "form" }, { "name": "includeServerIpAddresses", "flag": "--include-server-ip-addresses", "type": "boolean", "required": false, "location": "form" }], "response": { "clusterInitialized": "boolean", "dnsServerDomain": "string", "version": "string", "clusterDomain": "string", "heartbeatRefreshIntervalSeconds": "number", "heartbeatRetryIntervalSeconds": "number", "configRefreshIntervalSeconds": "number", "configRetryIntervalSeconds": "number", "configLastSynced": "string", "clusterNodes": { "array": { "id": "number", "name": "string", "url": "string", "type": "string", "state": "string", "version": "string", "lastSeen": "string", "ipAddress": "string" } }, "serverIpAddresses": { "array": "string" } } },
+    { "id": "OP-125", "command": "admin cluster primary transfer-config", "path": "/api/admin/cluster/primary/transferConfig", "kind": "zip", "confidential": true, "parameters": [{ "name": "includeZones", "flag": "--include-zones", "type": "zone-list", "required": false, "location": "form" }, { "name": "If-Modified-Since", "flag": "--if-modified-since", "type": "http-date", "required": false, "location": "header" }], "response": {} },
+    { "id": "OP-134", "command": "log list", "path": "/api/logs/list", "kind": "json", "confidential": false, "parameters": [{ "name": "node", "flag": "--node", "type": "string", "required": false, "location": "form" }], "response": { "logFiles": { "array": { "fileName": "string", "size": "string" } } } },
+    { "id": "OP-135", "command": "log download", "path": "/api/logs/download", "kind": "log-text", "confidential": false, "parameters": [{ "name": "node", "flag": "--node", "type": "string", "required": false, "location": "form" }, { "name": "fileName", "flag": "--file-name", "type": "string", "required": true, "location": "form" }, { "name": "limit", "flag": "--limit", "type": "integer", "required": false, "location": "form" }], "response": {} },
+    { "id": "OP-138", "command": "log query", "path": "/api/logs/query", "kind": "json", "confidential": false, "parameters": [{ "name": "node", "flag": "--node", "type": "string", "required": false, "location": "form" }, { "name": "name", "flag": "--name", "type": "string", "required": true, "location": "form" }, { "name": "classPath", "flag": "--class-path", "type": "string", "required": true, "location": "form" }, { "name": "pageNumber", "flag": "--page-number", "type": "integer", "required": false, "location": "form" }, { "name": "entriesPerPage", "flag": "--entries-per-page", "type": "integer", "required": false, "location": "form" }, { "name": "descendingOrder", "flag": "--descending-order", "type": "boolean", "required": false, "location": "form" }, { "name": "start", "flag": "--start", "type": "date", "required": false, "location": "form" }, { "name": "end", "flag": "--end", "type": "date", "required": false, "location": "form" }, { "name": "clientIpAddress", "flag": "--client-ip-address", "type": "string", "required": false, "location": "form" }, { "name": "protocol", "flag": "--protocol", "type": "string", "required": false, "location": "form", "values": ["Udp", "Tcp", "Tls", "Https", "Quic"] }, { "name": "responseType", "flag": "--response-type", "type": "string", "required": false, "location": "form", "values": ["Authoritative", "Recursive", "Cached", "Blocked", "UpstreamBlocked", "CacheBlocked"] }, { "name": "rcode", "flag": "--rcode", "type": "string", "required": false, "location": "form" }, { "name": "qname", "flag": "--qname", "type": "string", "required": false, "location": "form" }, { "name": "qtype", "flag": "--qtype", "type": "string", "required": false, "location": "form" }, { "name": "qclass", "flag": "--qclass", "type": "string", "required": false, "location": "form" }], "response": { "pageNumber": "number", "totalPages": "number", "totalEntries": "number", "entries": { "array": { "rowNumber": "number", "timestamp": "string", "clientIpAddress": "string", "protocol": "string", "responseType": "string", "responseRtt": "number", "rcode": "string", "qname": "string", "qtype": "string", "qclass": "string", "answer": "string" } } } },
+    { "id": "OP-139", "command": "log export", "path": "/api/logs/export", "kind": "csv", "confidential": false, "parameters": [{ "name": "node", "flag": "--node", "type": "string", "required": false, "location": "form" }, { "name": "name", "flag": "--name", "type": "string", "required": true, "location": "form" }, { "name": "classPath", "flag": "--class-path", "type": "string", "required": true, "location": "form" }, { "name": "start", "flag": "--start", "type": "date", "required": false, "location": "form" }, { "name": "end", "flag": "--end", "type": "date", "required": false, "location": "form" }, { "name": "clientIpAddress", "flag": "--client-ip-address", "type": "string", "required": false, "location": "form" }, { "name": "protocol", "flag": "--protocol", "type": "string", "required": false, "location": "form", "values": ["Udp", "Tcp", "Tls", "Https", "Quic"] }, { "name": "responseType", "flag": "--response-type", "type": "string", "required": false, "location": "form", "values": ["Authoritative", "Recursive", "Cached", "Blocked", "UpstreamBlocked", "CacheBlocked"] }, { "name": "rcode", "flag": "--rcode", "type": "string", "required": false, "location": "form" }, { "name": "qname", "flag": "--qname", "type": "string", "required": false, "location": "form" }, { "name": "qtype", "flag": "--qtype", "type": "string", "required": false, "location": "form" }, { "name": "qclass", "flag": "--qclass", "type": "string", "required": false, "location": "form" }], "response": {} },
+    { "id": "OP-141", "command": "admin ldap get", "path": "/api/admin/ldap/get", "kind": "json", "confidential": false, "parameters": [{ "name": "includeGroups", "flag": "--include-groups", "type": "boolean", "required": false, "location": "form" }], "response": { "ldapEnabled": "boolean", "ldapServer": "nullable", "ldapPort": "number", "ldapSslOption": "string", "ldapIgnoreSslErrors": "boolean", "ldapBindUsername": "nullable", "ldapSearchBase": "nullable", "ldapUserSearchFilter": "nullable", "ldapGroupAttribute": "nullable", "ldapAllowSignup": "boolean", "ldapAllowSignupOnlyForMappedUsers": "boolean", "ldapGroupMap": { "array": { "remoteGroup": "string", "localGroup": "string" } }, "localGroups": { "array": "string" } } }
+];