API - Corsair

Every nextdns.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Allowlist

add

allowlist.add Allow a domain Risk: write

await corsair.nextdns.api.allowlist.add({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`id`	`string`	Yes	—
`active`	`boolean`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—

delete

allowlist.delete Remove a domain from the allowlist Risk: write

await corsair.nextdns.api.allowlist.delete({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`id`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—

get

allowlist.get List allowed domains Risk: read

await corsair.nextdns.api.allowlist.get({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—

Output: object[]

Output full type

{
  id: string,
  active?: boolean
}[]

replace

allowlist.replace Replace the entire allowlist Risk: destructive

await corsair.nextdns.api.allowlist.replace({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`domains`	`object[]`	Yes	—

domains full type

{
  id: string,
  active?: boolean
}[]

Output: object[]

Output full type

{
  id: string,
  active?: boolean
}[]

update

allowlist.update Toggle an allowlist entry active/inactive Risk: write

await corsair.nextdns.api.allowlist.update({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`id`	`string`	Yes	—
`active`	`boolean`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—

Analytics

destinations

analytics.destinations Get query-destination analytics Risk: read

await corsair.nextdns.api.analytics.destinations({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`from`	`string`	No	—
`to`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—
`type`	`countries \| gafam`	Yes	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`meta`	`object`	No	—

data full type

{
}[]

meta full type

{
  pagination?: {
    cursor?: string | null
  }
}

devices

analytics.devices Get per-device analytics Risk: read

await corsair.nextdns.api.analytics.devices({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`from`	`string`	No	—
`to`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`meta`	`object`	No	—

data full type

{
}[]

meta full type

{
  pagination?: {
    cursor?: string | null
  }
}

dnssec

analytics.dnssec Get DNSSEC validation analytics Risk: read

await corsair.nextdns.api.analytics.dnssec({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`from`	`string`	No	—
`to`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`meta`	`object`	No	—

data full type

{
}[]

meta full type

{
  pagination?: {
    cursor?: string | null
  }
}

domains

analytics.domains Get per-domain analytics Risk: read

await corsair.nextdns.api.analytics.domains({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`from`	`string`	No	—
`to`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`meta`	`object`	No	—

data full type

{
}[]

meta full type

{
  pagination?: {
    cursor?: string | null
  }
}

encryption

analytics.encryption Get encrypted-vs-plain DNS analytics Risk: read

await corsair.nextdns.api.analytics.encryption({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`from`	`string`	No	—
`to`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`meta`	`object`	No	—

data full type

{
}[]

meta full type

{
  pagination?: {
    cursor?: string | null
  }
}

ips

analytics.ips Get per-client-IP analytics Risk: read

await corsair.nextdns.api.analytics.ips({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`from`	`string`	No	—
`to`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`meta`	`object`	No	—

data full type

{
}[]

meta full type

{
  pagination?: {
    cursor?: string | null
  }
}

ipVersions

analytics.ipVersions Get IPv4/IPv6 distribution analytics Risk: read

await corsair.nextdns.api.analytics.ipVersions({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`from`	`string`	No	—
`to`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`meta`	`object`	No	—

data full type

{
}[]

meta full type

{
  pagination?: {
    cursor?: string | null
  }
}

protocols

analytics.protocols Get DNS protocol distribution analytics Risk: read

await corsair.nextdns.api.analytics.protocols({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`from`	`string`	No	—
`to`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`meta`	`object`	No	—

data full type

{
}[]

meta full type

{
  pagination?: {
    cursor?: string | null
  }
}

queryTypes

analytics.queryTypes Get DNS query-type analytics Risk: read

await corsair.nextdns.api.analytics.queryTypes({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`from`	`string`	No	—
`to`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`meta`	`object`	No	—

data full type

{
}[]

meta full type

{
  pagination?: {
    cursor?: string | null
  }
}

reasons

analytics.reasons Get blocking-reason analytics Risk: read

await corsair.nextdns.api.analytics.reasons({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`from`	`string`	No	—
`to`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`meta`	`object`	No	—

data full type

{
}[]

meta full type

{
  pagination?: {
    cursor?: string | null
  }
}

status

analytics.status Get query-status analytics Risk: read

await corsair.nextdns.api.analytics.status({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`from`	`string`	No	—
`to`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`meta`	`object`	No	—

data full type

{
}[]

meta full type

{
  pagination?: {
    cursor?: string | null
  }
}

Auth

auth.login Verify the API key is valid Risk: read

await corsair.nextdns.api.auth.login({});

Input: empty object Output

Name	Type	Required	Description
`valid`	`boolean`	Yes	—
`profileCount`	`number`	Yes	—

Denylist

add

denylist.add Block a domain Risk: write

await corsair.nextdns.api.denylist.add({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`id`	`string`	Yes	—
`active`	`boolean`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—

list

denylist.list List blocked domains Risk: read

await corsair.nextdns.api.denylist.list({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—

Output: object[]

Output full type

{
  id: string,
  active?: boolean
}[]

remove

denylist.remove Unblock a domain Risk: write

await corsair.nextdns.api.denylist.remove({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`id`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—

replace

denylist.replace Replace the entire denylist Risk: destructive

await corsair.nextdns.api.denylist.replace({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`domains`	`object[]`	Yes	—

domains full type

{
  id: string,
  active?: boolean
}[]

Output: object[]

Output full type

{
  id: string,
  active?: boolean
}[]

update

denylist.update Toggle a denylist entry active/inactive Risk: write

await corsair.nextdns.api.denylist.update({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`id`	`string`	Yes	—
`active`	`boolean`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—

Logs

clear

logs.clear Clear all stored query logs - cannot be undone Risk: destructive · Irreversible

await corsair.nextdns.api.logs.clear({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—

Output

Name	Type	Required	Description
`cleared`	`boolean`	Yes	—

download

logs.download Download the CSV log export Risk: read

await corsair.nextdns.api.logs.download({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—

Output: string

get

logs.get Get raw or filtered DNS query logs Risk: read

await corsair.nextdns.api.logs.get({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`from`	`string`	No	—
`to`	`string`	No	—
`limit`	`number`	No	—
`cursor`	`string`	No	—
`raw`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	Yes	—
`meta`	`object`	No	—

data full type

{
}[]

meta full type

{
  pagination?: {
    cursor?: string | null
  }
}

Parental Control

addCategory

parentalControl.addCategory Block or allow a content category Risk: write

await corsair.nextdns.api.parentalControl.addCategory({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`id`	`porn \| gambling \| piracy \| dating \| social-networks`	Yes	—
`active`	`boolean`	No	—
`recreation`	`boolean`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—

addService

parentalControl.addService Block or allow a specific service Risk: write

await corsair.nextdns.api.parentalControl.addService({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`id`	`string`	Yes	—
`active`	`boolean`	No	—
`recreation`	`boolean`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—

deleteCategory

parentalControl.deleteCategory Remove a content category restriction Risk: write

await corsair.nextdns.api.parentalControl.deleteCategory({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`id`	`porn \| gambling \| piracy \| dating \| social-networks`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—

deleteService

parentalControl.deleteService Remove a service restriction Risk: write

await corsair.nextdns.api.parentalControl.deleteService({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`id`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—

get

parentalControl.get Get parental control settings Risk: read

await corsair.nextdns.api.parentalControl.get({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—

Output

Name	Type	Required	Description
`services`	`object[]`	No	—
`categories`	`object[]`	No	—
`recreation`	`object`	No	—
`safeSearch`	`boolean`	No	—
`youtubeRestrictedMode`	`boolean`	No	—
`blockBypass`	`boolean`	No	—

services full type

{
  id: string,
  active?: boolean,
  recreation?: boolean
}[]

categories full type

{
  id: string,
  active?: boolean,
  recreation?: boolean
}[]

recreation full type

{
  times?: {
  } | null,
  timezone?: string | null
}

getCategories

parentalControl.getCategories Get blocked/allowed content categories Risk: read

await corsair.nextdns.api.parentalControl.getCategories({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—

Output: object[]

Output full type

{
  id: string,
  active?: boolean,
  recreation?: boolean
}[]

getServices

parentalControl.getServices Get blocked/allowed services Risk: read

await corsair.nextdns.api.parentalControl.getServices({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—

Output: object[]

Output full type

{
  id: string,
  active?: boolean,
  recreation?: boolean
}[]

replaceCategories

parentalControl.replaceCategories Replace the entire set of category restrictions Risk: destructive

await corsair.nextdns.api.parentalControl.replaceCategories({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`categories`	`object[]`	Yes	—

categories full type

{
  id: porn | gambling | piracy | dating | social-networks,
  active?: boolean,
  recreation?: boolean
}[]

Output: object[]

Output full type

{
  id: string,
  active?: boolean,
  recreation?: boolean
}[]

replaceServices

parentalControl.replaceServices Replace the entire set of service restrictions Risk: destructive

await corsair.nextdns.api.parentalControl.replaceServices({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`services`	`object[]`	Yes	—

services full type

{
  id: string,
  active?: boolean,
  recreation?: boolean
}[]

Output: object[]

Output full type

{
  id: string,
  active?: boolean,
  recreation?: boolean
}[]

update

parentalControl.update Update safe search, YouTube restricted mode, or bypass blocking Risk: write

await corsair.nextdns.api.parentalControl.update({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`safeSearch`	`boolean`	No	—
`youtubeRestrictedMode`	`boolean`	No	—
`blockBypass`	`boolean`	No	—

Output

Name	Type	Required	Description
`services`	`object[]`	No	—
`categories`	`object[]`	No	—
`recreation`	`object`	No	—
`safeSearch`	`boolean`	No	—
`youtubeRestrictedMode`	`boolean`	No	—
`blockBypass`	`boolean`	No	—

services full type

{
  id: string,
  active?: boolean,
  recreation?: boolean
}[]

categories full type

{
  id: string,
  active?: boolean,
  recreation?: boolean
}[]

recreation full type

{
  times?: {
  } | null,
  timezone?: string | null
}

updateCategory

parentalControl.updateCategory Toggle a content category restriction Risk: write

await corsair.nextdns.api.parentalControl.updateCategory({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`id`	`porn \| gambling \| piracy \| dating \| social-networks`	Yes	—
`active`	`boolean`	No	—
`recreation`	`boolean`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—

updateService

parentalControl.updateService Toggle a service restriction Risk: write

await corsair.nextdns.api.parentalControl.updateService({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`id`	`string`	Yes	—
`active`	`boolean`	No	—
`recreation`	`boolean`	No	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—

Privacy

addBlocklist

privacy.addBlocklist Enable an additional privacy blocklist Risk: write

await corsair.nextdns.api.privacy.addBlocklist({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`id`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—

addNative

privacy.addNative Block a native tracking service from a specific vendor Risk: write

await corsair.nextdns.api.privacy.addNative({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`id`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—

deleteBlocklist

privacy.deleteBlocklist Remove a privacy blocklist Risk: write

await corsair.nextdns.api.privacy.deleteBlocklist({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`id`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—

deleteNative

privacy.deleteNative Unblock a native tracking service Risk: write

await corsair.nextdns.api.privacy.deleteNative({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`id`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—

get

privacy.get Get privacy settings Risk: read

await corsair.nextdns.api.privacy.get({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—

Output

Name	Type	Required	Description
`blocklists`	`object[]`	No	—
`natives`	`object[]`	No	—
`disguisedTrackers`	`boolean`	No	—
`allowAffiliate`	`boolean`	No	—

blocklists full type

{
  id: string,
  name?: string | null,
  website?: string | null,
  description?: string | null,
  entries?: number | null,
  updatedOn?: string | null
}[]

natives full type

{
  id: string
}[]

replaceBlocklists

privacy.replaceBlocklists Replace the entire set of enabled privacy blocklists Risk: destructive

await corsair.nextdns.api.privacy.replaceBlocklists({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`ids`	`string[]`	Yes	—

Output: object[]

Output full type

{
  id: string,
  name?: string | null,
  website?: string | null,
  description?: string | null,
  entries?: number | null,
  updatedOn?: string | null
}[]

replaceNatives

privacy.replaceNatives Replace the entire set of blocked native trackers Risk: destructive

await corsair.nextdns.api.privacy.replaceNatives({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`ids`	`string[]`	Yes	—

Output: object[]

Output full type

{
  id: string
}[]

update

privacy.update Update disguised-tracker and affiliate-link settings Risk: write

await corsair.nextdns.api.privacy.update({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`disguisedTrackers`	`boolean`	No	—
`allowAffiliate`	`boolean`	No	—
`blocklists`	`object[]`	No	—
`natives`	`object[]`	No	—

blocklists full type

{
  id: string,
  name?: string | null,
  website?: string | null,
  description?: string | null,
  entries?: number | null,
  updatedOn?: string | null
}[]

natives full type

{
  id: string
}[]

Output

Name	Type	Required	Description
`blocklists`	`object[]`	No	—
`natives`	`object[]`	No	—
`disguisedTrackers`	`boolean`	No	—
`allowAffiliate`	`boolean`	No	—

blocklists full type

{
  id: string,
  name?: string | null,
  website?: string | null,
  description?: string | null,
  entries?: number | null,
  updatedOn?: string | null
}[]

natives full type

{
  id: string
}[]

Profiles

create

profiles.create Create a new profile Risk: write

await corsair.nextdns.api.profiles.create({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	—
`security`	`object`	No	—
`privacy`	`object`	No	—
`parentalControl`	`object`	No	—
`settings`	`object`	No	—
`denylist`	`object[]`	No	—
`allowlist`	`object[]`	No	—
`rewrites`	`object[]`	No	—

security full type

{
  threatIntelligenceFeeds?: boolean,
  aiThreatDetection?: boolean,
  googleSafeBrowsing?: boolean,
  cryptojacking?: boolean,
  dnsRebinding?: boolean,
  idnHomographs?: boolean,
  typosquatting?: boolean,
  dga?: boolean,
  nrd?: boolean,
  ddns?: boolean,
  parking?: boolean,
  csam?: boolean,
  tlds?: {
    id: string
  }[]
}

privacy full type

{
  blocklists?: {
    id: string,
    name?: string | null,
    website?: string | null,
    description?: string | null,
    entries?: number | null,
    updatedOn?: string | null
  }[],
  natives?: {
    id: string
  }[],
  disguisedTrackers?: boolean,
  allowAffiliate?: boolean
}

parentalControl full type

{
  services?: {
    id: string,
    active?: boolean,
    recreation?: boolean
  }[],
  categories?: {
    id: string,
    active?: boolean,
    recreation?: boolean
  }[],
  recreation?: {
    times?: {
    } | null,
    timezone?: string | null
  },
  safeSearch?: boolean,
  youtubeRestrictedMode?: boolean,
  blockBypass?: boolean
}

settings full type

{
  logs?: {
    enabled?: boolean,
    drop?: {
      ip?: boolean,
      domain?: boolean
    },
    retention?: number | null,
    location?: string | null
  },
  blockPage?: {
    enabled?: boolean
  },
  performance?: {
    ecs?: boolean,
    cacheBoost?: boolean,
    cnameFlattening?: boolean
  },
  web3?: boolean
}

denylist full type

{
  id: string,
  active?: boolean
}[]

allowlist full type

{
  id: string,
  active?: boolean
}[]

rewrites full type

{
  id?: string,
  name: string,
  type?: string,
  content: string
}[]

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`fingerprint`	`string`	No	—
`role`	`string`	No	—
`name`	`string`	Yes	—

delete

profiles.delete Delete a profile - cannot be undone Risk: destructive · Irreversible

await corsair.nextdns.api.profiles.delete({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—

get

profiles.get Get full profile details including nested settings and lists Risk: read

await corsair.nextdns.api.profiles.get({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—
`name`	`string`	Yes	—
`fingerprint`	`string`	No	—
`security`	`object`	No	—
`privacy`	`object`	No	—
`parentalControl`	`object`	No	—
`settings`	`object`	No	—
`setup`	`object`	No	—
`denylist`	`object[]`	No	—
`allowlist`	`object[]`	No	—
`rewrites`	`object[]`	No	—

security full type

{
  threatIntelligenceFeeds?: boolean,
  aiThreatDetection?: boolean,
  googleSafeBrowsing?: boolean,
  cryptojacking?: boolean,
  dnsRebinding?: boolean,
  idnHomographs?: boolean,
  typosquatting?: boolean,
  dga?: boolean,
  nrd?: boolean,
  ddns?: boolean,
  parking?: boolean,
  csam?: boolean,
  tlds?: {
    id: string
  }[]
}

privacy full type

{
  blocklists?: {
    id: string,
    name?: string | null,
    website?: string | null,
    description?: string | null,
    entries?: number | null,
    updatedOn?: string | null
  }[],
  natives?: {
    id: string
  }[],
  disguisedTrackers?: boolean,
  allowAffiliate?: boolean
}

parentalControl full type

{
  services?: {
    id: string,
    active?: boolean,
    recreation?: boolean
  }[],
  categories?: {
    id: string,
    active?: boolean,
    recreation?: boolean
  }[],
  recreation?: {
    times?: {
    } | null,
    timezone?: string | null
  },
  safeSearch?: boolean,
  youtubeRestrictedMode?: boolean,
  blockBypass?: boolean
}

settings full type

{
  logs?: {
    enabled?: boolean,
    drop?: {
      ip?: boolean,
      domain?: boolean
    },
    retention?: number | null,
    location?: string | null
  },
  blockPage?: {
    enabled?: boolean
  },
  performance?: {
    ecs?: boolean,
    cacheBoost?: boolean,
    cnameFlattening?: boolean
  },
  web3?: boolean
}

setup full type

{
  ipv4?: string[],
  ipv6?: string[],
  linkedIp?: {
    servers?: string[],
    ip?: string | null,
    ddns?: string | null,
    updateToken?: string
  } | null,
  dnscrypt?: string | null
}

denylist full type

{
  id: string,
  active?: boolean
}[]

allowlist full type

{
  id: string,
  active?: boolean
}[]

rewrites full type

{
  id?: string,
  name: string,
  type?: string,
  content: string
}[]

list

profiles.list List every profile the API key can see Risk: read

await corsair.nextdns.api.profiles.list({});

Input: empty object Output: object[]

Output full type

{
  id: string,
  fingerprint?: string | null,
  role?: string | null,
  name: string
}[]

rename

profiles.rename Rename a profile Risk: write

await corsair.nextdns.api.profiles.rename({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`name`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—

update

profiles.update Partially update a profile Risk: write

await corsair.nextdns.api.profiles.update({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`name`	`string`	No	—
`security`	`object`	No	—
`privacy`	`object`	No	—
`parentalControl`	`object`	No	—
`settings`	`object`	No	—
`denylist`	`object[]`	No	—
`allowlist`	`object[]`	No	—
`rewrites`	`object[]`	No	—

security full type

{
  threatIntelligenceFeeds?: boolean,
  aiThreatDetection?: boolean,
  googleSafeBrowsing?: boolean,
  cryptojacking?: boolean,
  dnsRebinding?: boolean,
  idnHomographs?: boolean,
  typosquatting?: boolean,
  dga?: boolean,
  nrd?: boolean,
  ddns?: boolean,
  parking?: boolean,
  csam?: boolean,
  tlds?: {
    id: string
  }[]
}

privacy full type

{
  blocklists?: {
    id: string,
    name?: string | null,
    website?: string | null,
    description?: string | null,
    entries?: number | null,
    updatedOn?: string | null
  }[],
  natives?: {
    id: string
  }[],
  disguisedTrackers?: boolean,
  allowAffiliate?: boolean
}

parentalControl full type

{
  services?: {
    id: string,
    active?: boolean,
    recreation?: boolean
  }[],
  categories?: {
    id: string,
    active?: boolean,
    recreation?: boolean
  }[],
  recreation?: {
    times?: {
    } | null,
    timezone?: string | null
  },
  safeSearch?: boolean,
  youtubeRestrictedMode?: boolean,
  blockBypass?: boolean
}

settings full type

{
  logs?: {
    enabled?: boolean,
    drop?: {
      ip?: boolean,
      domain?: boolean
    },
    retention?: number | null,
    location?: string | null
  },
  blockPage?: {
    enabled?: boolean
  },
  performance?: {
    ecs?: boolean,
    cacheBoost?: boolean,
    cnameFlattening?: boolean
  },
  web3?: boolean
}

denylist full type

{
  id: string,
  active?: boolean
}[]

allowlist full type

{
  id: string,
  active?: boolean
}[]

rewrites full type

{
  id?: string,
  name: string,
  type?: string,
  content: string
}[]

Output

Name	Type	Required	Description
`id`	`string`	Yes	—

Rewrites

add

rewrites.add Add a DNS rewrite rule Risk: write

await corsair.nextdns.api.rewrites.add({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`name`	`string`	Yes	—
`content`	`string`	Yes	—
`type`	`string`	No	—

Output

Name	Type	Required	Description
`id`	`string`	No	—
`name`	`string`	Yes	—
`type`	`string`	No	—
`content`	`string`	Yes	—

delete

rewrites.delete Delete a DNS rewrite rule Risk: write

await corsair.nextdns.api.rewrites.delete({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`id`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—

get

rewrites.get List DNS rewrite rules Risk: read

await corsair.nextdns.api.rewrites.get({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—

Output: object[]

Output full type

{
  id?: string,
  name: string,
  type?: string,
  content: string
}[]

Security

addBlockedTld

security.addBlockedTld Add a top-level domain to the security blocklist Risk: write

await corsair.nextdns.api.security.addBlockedTld({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`id`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—

get

security.get Get security settings Risk: read

await corsair.nextdns.api.security.get({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—

Output

Name	Type	Required	Description
`threatIntelligenceFeeds`	`boolean`	No	—
`aiThreatDetection`	`boolean`	No	—
`googleSafeBrowsing`	`boolean`	No	—
`cryptojacking`	`boolean`	No	—
`dnsRebinding`	`boolean`	No	—
`idnHomographs`	`boolean`	No	—
`typosquatting`	`boolean`	No	—
`dga`	`boolean`	No	—
`nrd`	`boolean`	No	—
`ddns`	`boolean`	No	—
`parking`	`boolean`	No	—
`csam`	`boolean`	No	—
`tlds`	`object[]`	No	—

tlds full type

{
  id: string
}[]

getTlds

security.getTlds Get blocked top-level domains Risk: read

await corsair.nextdns.api.security.getTlds({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—

Output: object[]

Output full type

{
  id: string
}[]

removeBlockedTld

security.removeBlockedTld Remove a top-level domain from the security blocklist Risk: write

await corsair.nextdns.api.security.removeBlockedTld({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`id`	`string`	Yes	—

Output

Name	Type	Required	Description
`id`	`string`	Yes	—

replaceTlds

security.replaceTlds Replace the entire blocked-TLD list Risk: destructive

await corsair.nextdns.api.security.replaceTlds({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`tlds`	`string[]`	Yes	—

Output: object[]

Output full type

{
  id: string
}[]

update

security.update Update multiple security settings in one call Risk: write

await corsair.nextdns.api.security.update({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`threatIntelligenceFeeds`	`boolean`	No	—
`aiThreatDetection`	`boolean`	No	—
`googleSafeBrowsing`	`boolean`	No	—
`cryptojacking`	`boolean`	No	—
`dnsRebinding`	`boolean`	No	—
`idnHomographs`	`boolean`	No	—
`typosquatting`	`boolean`	No	—
`dga`	`boolean`	No	—
`nrd`	`boolean`	No	—
`ddns`	`boolean`	No	—
`parking`	`boolean`	No	—
`csam`	`boolean`	No	—

Output

Name	Type	Required	Description
`threatIntelligenceFeeds`	`boolean`	No	—
`aiThreatDetection`	`boolean`	No	—
`googleSafeBrowsing`	`boolean`	No	—
`cryptojacking`	`boolean`	No	—
`dnsRebinding`	`boolean`	No	—
`idnHomographs`	`boolean`	No	—
`typosquatting`	`boolean`	No	—
`dga`	`boolean`	No	—
`nrd`	`boolean`	No	—
`ddns`	`boolean`	No	—
`parking`	`boolean`	No	—
`csam`	`boolean`	No	—
`tlds`	`object[]`	No	—

tlds full type

{
  id: string
}[]

Settings

get

settings.get Get all settings for a profile Risk: read

await corsair.nextdns.api.settings.get({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—

Output

Name	Type	Required	Description
`logs`	`object`	No	—
`blockPage`	`object`	No	—
`performance`	`object`	No	—
`web3`	`boolean`	No	—

logs full type

{
  enabled?: boolean,
  drop?: {
    ip?: boolean,
    domain?: boolean
  },
  retention?: number | null,
  location?: string | null
}

blockPage full type

{
  enabled?: boolean
}

performance full type

{
  ecs?: boolean,
  cacheBoost?: boolean,
  cnameFlattening?: boolean
}

getBlockPage

settings.getBlockPage Get block page settings Risk: read

await corsair.nextdns.api.settings.getBlockPage({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—

Output

Name	Type	Required	Description
`enabled`	`boolean`	No	—

getLogs

settings.getLogs Get logging settings Risk: read

await corsair.nextdns.api.settings.getLogs({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—

Output

Name	Type	Required	Description
`enabled`	`boolean`	No	—
`drop`	`object`	No	—
`retention`	`number`	No	—
`location`	`string`	No	—

drop full type

{
  ip?: boolean,
  domain?: boolean
}

getPerformance

settings.getPerformance Get performance settings (ECS, cache boost, CNAME flattening) Risk: read

await corsair.nextdns.api.settings.getPerformance({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—

Output

Name	Type	Required	Description
`ecs`	`boolean`	No	—
`cacheBoost`	`boolean`	No	—
`cnameFlattening`	`boolean`	No	—

logClientIps

settings.logClientIps Enable or disable logging of client IPs Risk: write

await corsair.nextdns.api.settings.logClientIps({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`enabled`	`boolean`	Yes	—

Output

Name	Type	Required	Description
`enabled`	`boolean`	No	—
`drop`	`object`	No	—
`retention`	`number`	No	—
`location`	`string`	No	—

drop full type

{
  ip?: boolean,
  domain?: boolean
}

logDomains

settings.logDomains Enable or disable logging of queried domains Risk: write

await corsair.nextdns.api.settings.logDomains({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`enabled`	`boolean`	Yes	—

Output

Name	Type	Required	Description
`enabled`	`boolean`	No	—
`drop`	`object`	No	—
`retention`	`number`	No	—
`location`	`string`	No	—

drop full type

{
  ip?: boolean,
  domain?: boolean
}

update

settings.update Update multiple settings categories in one call Risk: write

await corsair.nextdns.api.settings.update({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`logs`	`object`	No	—
`blockPage`	`object`	No	—
`performance`	`object`	No	—
`web3`	`boolean`	No	—

logs full type

{
  enabled?: boolean,
  drop?: {
    ip?: boolean,
    domain?: boolean
  },
  retention?: number | null,
  location?: string | null
}

blockPage full type

{
  enabled?: boolean
}

performance full type

{
  ecs?: boolean,
  cacheBoost?: boolean,
  cnameFlattening?: boolean
}

Output

Name	Type	Required	Description
`logs`	`object`	No	—
`blockPage`	`object`	No	—
`performance`	`object`	No	—
`web3`	`boolean`	No	—

logs full type

{
  enabled?: boolean,
  drop?: {
    ip?: boolean,
    domain?: boolean
  },
  retention?: number | null,
  location?: string | null
}

blockPage full type

{
  enabled?: boolean
}

performance full type

{
  ecs?: boolean,
  cacheBoost?: boolean,
  cnameFlattening?: boolean
}

updateBlockPage

settings.updateBlockPage Enable or disable the branded block page Risk: write

await corsair.nextdns.api.settings.updateBlockPage({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`enabled`	`boolean`	Yes	—

Output

Name	Type	Required	Description
`enabled`	`boolean`	No	—

updateLogs

settings.updateLogs Update log retention, storage location, and privacy options Risk: write

await corsair.nextdns.api.settings.updateLogs({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`enabled`	`boolean`	No	—
`retention`	`3600`	No	—
`location`	`string`	No	—

Output

Name	Type	Required	Description
`enabled`	`boolean`	No	—
`drop`	`object`	No	—
`retention`	`number`	No	—
`location`	`string`	No	—

drop full type

{
  ip?: boolean,
  domain?: boolean
}

updatePerformance

settings.updatePerformance Update performance optimization settings Risk: write

await corsair.nextdns.api.settings.updatePerformance({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—
`ecs`	`boolean`	No	—
`cacheBoost`	`boolean`	No	—
`cnameFlattening`	`boolean`	No	—

Output

Name	Type	Required	Description
`ecs`	`boolean`	No	—
`cacheBoost`	`boolean`	No	—
`cnameFlattening`	`boolean`	No	—

Setup

updateLinkedIp

setup.updateLinkedIp Update the profile’s Linked IP to the caller’s current public IP Risk: write

await corsair.nextdns.api.setup.updateLinkedIp({});

Input

Name	Type	Required	Description
`profileId`	`string`	Yes	—

Output

Name	Type	Required	Description
`servers`	`string[]`	No	—
`ip`	`string`	No	—
`ddns`	`string`	No	—
`updateToken`	`string`	No	—

​Allowlist

​add

​delete

​get

​replace

​update

​Analytics

​destinations

​devices

​dnssec

​domains

​encryption

​ips

​ipVersions

​protocols

​queryTypes

​reasons

​status

​Auth

​login

​Denylist

​add

​list

​remove

​replace

​update

​Logs

​clear

​download

​get

​Parental Control

​addCategory

​addService

​deleteCategory

​deleteService

​get

​getCategories

​getServices

​replaceCategories

​replaceServices

​update

​updateCategory

​updateService

​Privacy

​addBlocklist

​addNative

​deleteBlocklist

​deleteNative

​get

​replaceBlocklists

​replaceNatives

​update

​Profiles

​create

​delete

​get

​list

​rename

​update

​Rewrites

​add

​delete

​get

​Security

​addBlockedTld

​get

​getTlds

​removeBlockedTld

​replaceTlds

​update

​Settings

​get

​getBlockPage

​getLogs

​getPerformance

​logClientIps

​logDomains

​update

​updateBlockPage

​updateLogs

Allowlist

add

delete

get

replace

update

Analytics

destinations

devices

dnssec

domains

encryption

ips

ipVersions

protocols

queryTypes

reasons

status

Auth

login

Denylist

add

list

remove

replace

update

Logs

clear

download

get

Parental Control

addCategory

addService

deleteCategory

deleteService

get

getCategories

getServices

replaceCategories

replaceServices

update

updateCategory

updateService

Privacy

addBlocklist

addNative

deleteBlocklist

deleteNative

get

replaceBlocklists

replaceNatives

update

Profiles

create

delete

get

list

rename

update

Rewrites

add

delete

get

Security

addBlockedTld

get

getTlds

removeBlockedTld

replaceTlds

update

Settings

get

getBlockPage

getLogs

getPerformance

logClientIps

logDomains

update

updateBlockPage

updateLogs