API - Corsair

Every dnsfilter.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.

Agent Local User Bulk Deletes

counts

agentLocalUserBulkDeletes.counts Counts for agent local user bulk deletes Risk: read

await corsair.dnsfilter.api.agentLocalUserBulkDeletes.counts({});

Input

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

Output

Name	Type	Required	Description
`count`	`number`	No	—

create

agentLocalUserBulkDeletes.create Bulk delete agent local user Risk: destructive · Irreversible

await corsair.dnsfilter.api.agentLocalUserBulkDeletes.create({});

Input

Name	Type	Required	Description
`block_page`	`object`	No	—
`collection_id`	`object`	No	—
`friendly_name`	`object`	No	—
`name_search`	`string`	No	—
`policy_schedule`	`object`	No	—
`search`	`string`	No	—
`user_login`	`object`	No	—
`user_name`	`object`	No	—
`ids`	`number[]`	No	—
`exclude_ids`	`number[]`	No	—

block_page full type

{
  operator?: contains | doesnotcontain,
  value?: string
}

collection_id full type

{
  operator?: is | isnot,
  value?: number[] | string
}

friendly_name full type

{
  operator?: contains | doesnotcontain,
  value?: string
}

policy_schedule full type

{
  operator?: contains | doesnotcontain,
  value?: string
}

user_name full type

{
  operator?: contains | doesnotcontain,
  value?: string
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  ids?: number[],
  exclude_ids?: number[]
}

get

agentLocalUserBulkDeletes.get Get an agent local user bulk delete Risk: read

await corsair.dnsfilter.api.agentLocalUserBulkDeletes.get({});

Input

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

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  ids?: number[],
  exclude_ids?: number[]
}

Agent Local Users

delete

agentLocalUsers.delete Delete an agent local user Risk: destructive · Irreversible

await corsair.dnsfilter.api.agentLocalUsers.delete({});

Input

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

Output: undefined

get

agentLocalUsers.get Get an agent local user Risk: read

await corsair.dnsfilter.api.agentLocalUsers.get({});

Input

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

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    friendly_name?: string,
    user_login?: string,
    user_name?: string,
    user_remote_id?: string,
    first_seen?: string,
    last_seen?: string
  },
  relationships?: {
    organization?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    }
  }
}

list

agentLocalUsers.list List agent local users Risk: read

await corsair.dnsfilter.api.agentLocalUsers.list({});

Input

Name	Type	Required	Description
`block_page`	`object`	No	—
`collection_id`	`object`	No	—
`cybersight_enabled`	`boolean`	No	—
`end_at`	`string`	No	—
`friendly_name`	`object`	No	—
`ids`	`number[]`	No	—
`in_a_collection`	`boolean`	No	—
`msp_id`	`number`	No	—
`name`	`string`	No	—
`organization_ids`	`number[]`	No	—
`page`	`object`	No	—
`policy_schedule`	`object`	No	—
`search`	`string`	No	—
`sort`	`string`	No	—
`start_at`	`string`	No	—
`user_agent_uuids`	`string[]`	No	—
`user_login`	`object`	No	—
`user_name`	`object`	No	—
`user_policy_override`	`boolean`	No	—
`uuids`	`string[]`	No	—

block_page full type

{
  operator?: contains | doesnotcontain,
  value?: string
}

collection_id full type

{
  operator?: is | isnot,
  value?: number[] | string
}

friendly_name full type

{
  operator?: contains | doesnotcontain,
  value?: string
}

page full type

{
  number?: number,
  size?: number
}

policy_schedule full type

{
  operator?: contains | doesnotcontain,
  value?: string
}

user_name full type

{
  operator?: contains | doesnotcontain,
  value?: string
}

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`links`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    friendly_name?: string,
    user_login?: string,
    user_name?: string,
    user_remote_id?: string,
    first_seen?: string,
    last_seen?: string
  },
  relationships?: {
    organization?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    }
  }
}[]

links full type

{
  self?: string,
  first?: string,
  prev?: string,
  next?: string,
  last?: string
}

listAll

agentLocalUsers.listAll List all agent local users Risk: read

await corsair.dnsfilter.api.agentLocalUsers.listAll({});

Input

Name	Type	Required	Description
`cybersight_enabled`	`boolean`	No	—
`end_at`	`string`	No	—
`in_a_collection`	`boolean`	No	—
`name`	`string`	No	—
`organization_ids`	`number[]`	No	—
`page`	`object`	No	—
`sort`	`string`	No	—
`start_at`	`string`	No	—
`user_agent_uuids`	`string[]`	No	—
`user_policy_override`	`boolean`	No	—

page full type

{
  number?: number,
  size?: number
}

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`links`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    friendly_name?: string,
    user_login?: string,
    user_name?: string,
    user_remote_id?: string,
    first_seen?: string,
    last_seen?: string
  },
  relationships?: {
    organization?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    }
  }
}[]

links full type

{
  self?: string,
  first?: string,
  prev?: string,
  next?: string,
  last?: string
}

update

agentLocalUsers.update Update an agent local user Risk: write

await corsair.dnsfilter.api.agentLocalUsers.update({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`agent_local_user`	`object`	Yes	—

agent_local_user full type

{
  friendly_name?: string,
  policy_id?: number,
  scheduled_policy_id?: number,
  block_page_id?: number
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    friendly_name?: string,
    user_login?: string,
    user_name?: string,
    user_remote_id?: string,
    first_seen?: string,
    last_seen?: string
  },
  relationships?: {
    organization?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    }
  }
}

Agent Local Users V2

counts

agentLocalUsersV2.counts Counts for agent local users V2 Risk: read

await corsair.dnsfilter.api.agentLocalUsersV2.counts({});

Input

Name	Type	Required	Description
`msp_id`	`number`	No	—
`name`	`string`	No	—
`organization_ids`	`number[]`	No	—
`search`	`string`	No	—

Output

Name	Type	Required	Description
`all`	`number`	No	—
`user_policy_override`	`number`	No	—
`inherited_policy`	`number`	No	—

Api Keys

create

apiKeys.create Create an API key Risk: write

await corsair.dnsfilter.api.apiKeys.create({});

Input

Name	Type	Required	Description
`name`	`string`	No	—
`expiry`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    expiry?: string,
    last_four?: string,
    token?: string,
    status?: string,
    created_at?: string,
    updated_at?: string,
    user_id:?: number
  }
}

delete

apiKeys.delete Delete an API key Risk: destructive · Irreversible

await corsair.dnsfilter.api.apiKeys.delete({});

Input

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

Output: undefined

get

apiKeys.get Get an API key Risk: read

await corsair.dnsfilter.api.apiKeys.get({});

Input

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

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    expiry?: string,
    last_four?: string,
    token?: string,
    status?: string,
    created_at?: string,
    updated_at?: string,
    user_id:?: number
  }
}

list

apiKeys.list List API keys Risk: read

await corsair.dnsfilter.api.apiKeys.list({});

Input

Name	Type	Required	Description
`expired`	`boolean`	No	—
`id`	`number`	No	—
`last_four`	`string`	No	—
`name`	`string`	No	—
`organization_id`	`number`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`links`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    expiry?: string,
    last_four?: string,
    token?: string,
    status?: string,
    created_at?: string,
    updated_at?: string,
    user_id:?: number
  }
}[]

links full type

{
  self?: string,
  first?: string,
  prev?: string,
  next?: string,
  last?: string
}

revoke

apiKeys.revoke Revoke an API key Risk: destructive · Irreversible

await corsair.dnsfilter.api.apiKeys.revoke({});

Input

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

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    expiry?: string,
    last_four?: string,
    token?: string,
    status?: string,
    created_at?: string,
    updated_at?: string,
    user_id:?: number
  }
}

Application Categories

get

applicationCategories.get Get an application category Risk: read

await corsair.dnsfilter.api.applicationCategories.get({});

Input

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

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    description?: string
  }
}

list

applicationCategories.list List application categories Risk: read

await corsair.dnsfilter.api.applicationCategories.list({});

Input

Name	Type	Required	Description
`page`	`object`	No	—

page full type

{
  number?: number,
  size?: number
}

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`links`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    description?: string
  }
}[]

links full type

{
  self?: string,
  first?: string,
  prev?: string,
  next?: string,
  last?: string
}

Applications

get

applications.get Get an application Risk: read

await corsair.dnsfilter.api.applications.get({});

Input

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

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    display_name?: string,
    description?: string,
    home_page_url?: string,
    favicon?: string,
    icon?: string
  },
  relationships?: {
    categories?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    }
  }
}

list

applications.list List applications Risk: read

await corsair.dnsfilter.api.applications.list({});

Input

Name	Type	Required	Description
`category_ids`	`number[]`	No	—
`page`	`object`	No	—

page full type

{
  number?: number,
  size?: number
}

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`links`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    display_name?: string,
    description?: string,
    home_page_url?: string,
    favicon?: string,
    icon?: string
  },
  relationships?: {
    categories?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    }
  }
}[]

links full type

{
  self?: string,
  first?: string,
  prev?: string,
  next?: string,
  last?: string
}

listAll

applications.listAll List all applications Risk: read

await corsair.dnsfilter.api.applications.listAll({});

Input

Name	Type	Required	Description
`category_ids`	`number[]`	No	—
`page`	`object`	No	—

page full type

{
  number?: number,
  size?: number
}

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`links`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    display_name?: string,
    description?: string,
    home_page_url?: string,
    favicon?: string,
    icon?: string
  },
  relationships?: {
    categories?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    }
  }
}[]

links full type

{
  self?: string,
  first?: string,
  prev?: string,
  next?: string,
  last?: string
}

Billings

addressShow

billings.addressShow Address show for billings Risk: read

await corsair.dnsfilter.api.billings.addressShow({});

Input

Name	Type	Required	Description
`organization_id`	`number`	Yes	—

Output

Name	Type	Required	Description
`first_name`	`string`	No	—
`last_name`	`string`	No	—
`email`	`string`	No	—
`company`	`string`	No	—
`phone`	`string`	No	—
`line1`	`string`	No	—
`line2`	`string`	No	—
`line3`	`string`	No	—
`city`	`string`	No	—
`state_code`	`string`	No	—
`state`	`string`	No	—
`zip`	`string`	No	—
`country`	`string`	No	—

addressUpdate

billings.addressUpdate Address update for billings Risk: write

await corsair.dnsfilter.api.billings.addressUpdate({});

Input

Name	Type	Required	Description
`organization_id`	`number`	Yes	—
`billing_address`	`object`	Yes	—

billing_address full type

{
  first_name?: string,
  last_name?: string,
  email?: string,
  company?: string,
  phone?: string,
  line1?: string,
  line2?: string,
  line3?: string,
  city?: string,
  state_code?: string,
  state?: string,
  zip?: string,
  country?: string
}

Output

Name	Type	Required	Description
`first_name`	`string`	No	—
`last_name`	`string`	No	—
`email`	`string`	No	—
`company`	`string`	No	—
`phone`	`string`	No	—
`line1`	`string`	No	—
`line2`	`string`	No	—
`line3`	`string`	No	—
`city`	`string`	No	—
`state_code`	`string`	No	—
`state`	`string`	No	—
`zip`	`string`	No	—
`country`	`string`	No	—

create

billings.create Create a billing Risk: write

await corsair.dnsfilter.api.billings.create({});

Input

Name	Type	Required	Description
`organization_id`	`number`	Yes	—
`payment_token`	`string`	Yes	—

Output: undefined

get

billings.get Get a billing Risk: read

await corsair.dnsfilter.api.billings.get({});

Input

Name	Type	Required	Description
`organization_id`	`number`	Yes	—

Output

Name	Type	Required	Description
`object`	`string`	No	—
`address_city`	`string`	No	—
`address_country`	`string`	No	—
`address_line1`	`string`	No	—
`address_line2`	`string`	No	—
`address_state`	`string`	No	—
`address_zip`	`string`	No	—
`brand`	`string`	No	—
`country`	`string`	No	—
`exp_month`	`number`	No	—
`exp_year`	`number`	No	—
`last4`	`string`	No	—

Block Pages

create

blockPages.create Create a block page Risk: write

await corsair.dnsfilter.api.blockPages.create({});

Input

Name	Type	Required	Description
`name`	`string`	No	—
`organization_id`	`number`	No	—
`block_org_name`	`string`	No	—
`block_email_addr`	`string`	No	—
`block_logo_uuid`	`string`	No	—
`created_at`	`string`	No	—
`updated_at`	`string`	No	—

Output

Name	Type	Required	Description
`name`	`string`	No	—
`organization_id`	`number`	No	—
`block_org_name`	`string`	No	—
`block_email_addr`	`string`	No	—
`block_logo_uuid`	`string`	No	—
`created_at`	`string`	No	—
`updated_at`	`string`	No	—

delete

blockPages.delete Delete a block page Risk: destructive · Irreversible

await corsair.dnsfilter.api.blockPages.delete({});

Input

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

Output

Name	Type	Required	Description
`name`	`string`	No	—
`organization_id`	`number`	No	—
`block_org_name`	`string`	No	—
`block_email_addr`	`string`	No	—
`block_logo_uuid`	`string`	No	—
`created_at`	`string`	No	—
`updated_at`	`string`	No	—

get

blockPages.get Get a block page Risk: read

await corsair.dnsfilter.api.blockPages.get({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`include_relationships`	`boolean`	No	—

Output

Name	Type	Required	Description
`name`	`string`	No	—
`organization_id`	`number`	No	—
`block_org_name`	`string`	No	—
`block_email_addr`	`string`	No	—
`block_logo_uuid`	`string`	No	—
`created_at`	`string`	No	—
`updated_at`	`string`	No	—

list

blockPages.list List block pages Risk: read

await corsair.dnsfilter.api.blockPages.list({});

Input

Name	Type	Required	Description
`organization_id`	`number`	No	—
`page`	`object`	No	—

page full type

{
  number?: number,
  size?: number
}

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`links`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    organization_id?: number,
    block_org_name?: string,
    block_email_addr?: string,
    block_logo_uuid?: string,
    created_at?: string,
    updated_at?: string
  }
}[]

links full type

{
  self?: string,
  first?: string,
  prev?: string,
  next?: string,
  last?: string
}

listAll

blockPages.listAll List all block pages Risk: read

await corsair.dnsfilter.api.blockPages.listAll({});

Input

Name	Type	Required	Description
`organization_id`	`number`	No	—
`page`	`object`	No	—

page full type

{
  number?: number,
  size?: number
}

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`links`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    organization_id?: number,
    block_org_name?: string,
    block_email_addr?: string,
    block_logo_uuid?: string,
    created_at?: string,
    updated_at?: string
  }
}[]

links full type

{
  self?: string,
  first?: string,
  prev?: string,
  next?: string,
  last?: string
}

update

blockPages.update Update a block page Risk: write

await corsair.dnsfilter.api.blockPages.update({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`name`	`string`	No	—
`organization_id`	`number`	No	—
`block_org_name`	`string`	No	—
`block_email_addr`	`string`	No	—
`block_logo_uuid`	`string`	No	—
`created_at`	`string`	No	—
`updated_at`	`string`	No	—

Output

Name	Type	Required	Description
`name`	`string`	No	—
`organization_id`	`number`	No	—
`block_org_name`	`string`	No	—
`block_email_addr`	`string`	No	—
`block_logo_uuid`	`string`	No	—
`created_at`	`string`	No	—
`updated_at`	`string`	No	—

Collection Users

create

collectionUsers.create Create a collection user Risk: write

await corsair.dnsfilter.api.collectionUsers.create({});

Input

Name	Type	Required	Description
`collection_id`	`number`	Yes	—
`body`	`object`	Yes	—

body full type

{
  collection_id: number,
  id: number
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  policy: {
    collection_id: number,
    id: number
  }
}

delete

collectionUsers.delete Delete a collection user Risk: destructive · Irreversible

await corsair.dnsfilter.api.collectionUsers.delete({});

Input

Name	Type	Required	Description
`collection_id`	`number`	Yes	—
`id`	`number`	Yes	—

Output: undefined

get

collectionUsers.get Get a collection user Risk: read

await corsair.dnsfilter.api.collectionUsers.get({});

Input

Name	Type	Required	Description
`collection_id`	`number`	Yes	—
`id`	`number`	Yes	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  policy: {
    collection_id: number,
    id: number
  }
}

list

collectionUsers.list List collection users Risk: read

await corsair.dnsfilter.api.collectionUsers.list({});

Input

Name	Type	Required	Description
`collection_id`	`number`	Yes	—
`name`	`string`	No	—
`page`	`object`	No	—
`sort`	`string`	No	—

page full type

{
  number?: number,
  size?: number
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  policy: {
    collection_id: number,
    id: number
  }
}

Csv Exports

agentLocalUsersCreate

csvExports.agentLocalUsersCreate Create agent local users CSV export Risk: write

await corsair.dnsfilter.api.csvExports.agentLocalUsersCreate({});

Input

Name	Type	Required	Description
`agent_local_users_csv_export`	`object`	No	—

agent_local_users_csv_export full type

{
  organization_ids?: number[],
  name?: string,
  search?: string,
  user_policy_override?: boolean
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  uuid?: string,
  organization_ids?: number[],
  url?: string | null,
  error?: string
}

agentLocalUsersGet

csvExports.agentLocalUsersGet Get agent local users CSV export Risk: read

await corsair.dnsfilter.api.csvExports.agentLocalUsersGet({});

Input

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

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  uuid?: string,
  organization_ids?: number[],
  url?: string | null,
  error?: string
}

cyberSightCreate

csvExports.cyberSightCreate Create CyberSight CSV export Risk: write

await corsair.dnsfilter.api.csvExports.cyberSightCreate({});

Input

Name	Type	Required	Description
`cyber_sight_csv_export`	`object`	No	—
`report_type`	`activity_logs \| top_websites \| top_applications \| top_categories \| top_streaming \| top_risky_users \| top_active_clients \| top_ai_usage`	Yes	—
`ai_tool`	`all \| web \| app \| client`	No	—
`start_at`	`string`	Yes	—
`end_at`	`string`	Yes	—
`msp_uuid`	`string`	No	—
`org_uuids`	`string[]`	No	—
`excluded_org_uuids`	`string[]`	No	—
`category_ids`	`string \| number[]`	No	—
`user_agent_uuids`	`string[]`	No	—
`agent_local_user_uuids`	`string[]`	No	—
`weekdays_only`	`boolean`	No	—
`search_id`	`string`	No	—
`size`	`number`	No	—
`activity_type_ids`	`number[]`	No	—
`app_executable_path`	`string`	No	—
`app_name`	`string`	No	—
`app_window_title`	`string`	No	—
`web_full_url`	`string`	No	—
`web_host`	`string`	No	—
`threats_only`	`boolean`	No	—
`web_categories`	`string`	No	—
`sort_by`	`app_executable_path \| app_name \| app_window_title \| cyber_sight_service_version \| event_duration \| event_end_at \| event_start_at \| remote_ip \| web_full_url \| web_host`	No	—
`sort_direction`	`asc \| desc`	No	—
`included_columns`	`string[]`	No	—

cyber_sight_csv_export full type

{
  included_columns?: string[],
  organization_ids?: number[]
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  uuid?: string,
  organization_ids?: number[],
  url?: string | null,
  error?: string | null
}

cyberSightGet

csvExports.cyberSightGet Get CyberSight CSV export Risk: read

await corsair.dnsfilter.api.csvExports.cyberSightGet({});

Input

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

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  uuid?: string,
  organization_ids?: number[],
  url?: string | null,
  error?: string | null,
  export?: {
    uuid?: string,
    status?: string
  },
  export.uuid?: string,
  export.status?: string
}

networksCreate

csvExports.networksCreate Create networks CSV export Risk: write

await corsair.dnsfilter.api.csvExports.networksCreate({});

Input

Name	Type	Required	Description
`ip_search`	`string`	No	—
`protected`	`boolean`	No	—
`search`	`string`	No	—
`state`	`string`	No	—
`unprotected`	`boolean`	No	—
`networks_csv_export`	`object`	No	—

networks_csv_export full type

{
  organization_ids?: number[],
  msp_id?: number,
  ids?: number[]
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: number,
  organization_ids?: number[],
  url?: string,
  error?: string
}

networksGet

csvExports.networksGet Get networks CSV export Risk: read

await corsair.dnsfilter.api.csvExports.networksGet({});

Input

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

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: number,
  organization_ids?: number[],
  url?: string,
  error?: string
}

unblockRequestsCreate

csvExports.unblockRequestsCreate Create unblock requests CSV export Risk: write

await corsair.dnsfilter.api.csvExports.unblockRequestsCreate({ tab: 'active', organization_id: 99 });

Input

Name	Type	Required	Description
`msp_id`	`number`	No	—
`organization_id`	`number`	No	—
`organization_ids`	`number[]`	No	—
`search`	`string`	No	—
`sort`	`string`	No	—
`tab`	`string`	No	—
`unblock_requests_csv_export`	`object`	No	—

unblock_requests_csv_export full type

{
  included_columns?: string[]
}

Output

Name	Type	Required	Description
`export`	`object`	No	—

export full type

{
  uuid?: string,
  tab?: active | history | string,
  row_count?: number,
  total_count?: number,
  truncated?: boolean,
  url?: string | null,
  error?: string | null
}

unblockRequestsGet

csvExports.unblockRequestsGet Get unblock requests CSV export Risk: read

await corsair.dnsfilter.api.csvExports.unblockRequestsGet({});

Input

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

Output

Name	Type	Required	Description
`export`	`object`	No	—

export full type

{
  uuid?: string,
  tab?: active | history | string,
  row_count?: number,
  total_count?: number,
  truncated?: boolean,
  url?: string | null,
  error?: string | null,
  status?: processing | string
}

userAgentCreate

csvExports.userAgentCreate Create user agent CSV export Risk: write

await corsair.dnsfilter.api.csvExports.userAgentCreate({});

Input

Name	Type	Required	Description
`user_agent_csv_export`	`object`	No	—
`network_ids`	`number[]`	No	—
`type`	`proxy \| agents`	No	—
`search`	`string`	No	—
`name_search`	`string`	No	—
`tags`	`string[]`	No	—
`status`	`string`	No	—
`state`	`online \| offline`	No	—
`agent_state`	`protected \| unprotected \| bypassed \| uninstalled`	No	—
`traffic_received_last_15_mins`	`boolean`	No	—

user_agent_csv_export full type

{
  organization_ids?: number[],
  msp_id?: number,
  ids?: string[]
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: number,
  organization_ids?: number[],
  url?: string,
  error?: string
}

userAgentGet

csvExports.userAgentGet Get user agent CSV export Risk: read

await corsair.dnsfilter.api.csvExports.userAgentGet({});

Input

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

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: number,
  organization_ids?: number[],
  url?: string,
  error?: string
}

userAgentsCsv

csvExports.userAgentsCsv Download user agents CSV Risk: read

await corsair.dnsfilter.api.csvExports.userAgentsCsv({ organization_id: 99 });

Input

Name	Type	Required	Description
`organization_id`	`number`	Yes	—
`include_suborgs`	`boolean`	No	—
`timezone`	`string`	No	—

Output: string

Current User Org Ui Settings

suppressLicenseWarning

currentUserOrgUiSettings.suppressLicenseWarning Suppress license warning for current user org UI settings Risk: write

await corsair.dnsfilter.api.currentUserOrgUiSettings.suppressLicenseWarning({});

Input

Name	Type	Required	Description
`body`	`object`	Yes	—

body full type

{
  organization_uuid?: string
}

Output

Name	Type	Required	Description
`warning_suppress_date`	`string`	No	—
`organization_uuid`	`string`	No	—
`user_uuid`	`string`	No	—

Current Users

get

currentUsers.get Get a current user Risk: read

await corsair.dnsfilter.api.currentUsers.get({});

Input: empty object Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    email?: string,
    email_verified?: boolean,
    created_at?: string,
    updated_at?: string,
    has_agreements_to_sign?: boolean,
    can_add_org_to_msps?: {
      id?: number,
      name?: string
    }[]
  }
}

update

currentUsers.update Update a current user Risk: write

await corsair.dnsfilter.api.currentUsers.update({});

Input

Name	Type	Required	Description
`user`	`object`	No	—

user full type

{
  first_name?: string,
  last_name?: string,
  phone?: string
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    email?: string,
    email_verified?: boolean,
    created_at?: string,
    updated_at?: string,
    has_agreements_to_sign?: boolean,
    can_add_org_to_msps?: {
      id?: number,
      name?: string
    }[]
  }
}

Current User Ui Settings

get

currentUserUiSettings.get Get a current user UI setting Risk: read

await corsair.dnsfilter.api.currentUserUiSettings.get({});

Input: empty object Output

Name	Type	Required	Description
`disable_license_warnings`	`boolean`	No	—
`user_uuid`	`string`	No	—
`theme_mode`	`string`	No	—

update

currentUserUiSettings.update Update a current user UI setting Risk: write

await corsair.dnsfilter.api.currentUserUiSettings.update({});

Input

Name	Type	Required	Description
`disable_license_warnings`	`boolean`	No	—
`user_uuid`	`string`	No	—
`theme_mode`	`string`	No	—

Output

Name	Type	Required	Description
`disable_license_warnings`	`boolean`	No	—
`user_uuid`	`string`	No	—
`theme_mode`	`string`	No	—

Dashboards

available

dashboards.available Available for dashboards Risk: read

await corsair.dnsfilter.api.dashboards.available({});

Input: empty object Output: object[]

Output full type

{
  id?: number,
  name?: string,
  data?: {
  },
  is_public?: boolean,
  created_at?: string,
  updated_at?: string,
  user?: {
    id?: number,
    name?: string
  }
}[]

create

dashboards.create Create a dashboard Risk: write

await corsair.dnsfilter.api.dashboards.create({});

Input

Name	Type	Required	Description
`dashboard`	`object`	Yes	—

dashboard full type

{
  name: string,
  data: {
  },
  is_public?: boolean
}

Output

Name	Type	Required	Description
`id`	`number`	No	—
`name`	`string`	No	—
`data`	`object`	No	—
`is_public`	`boolean`	No	—
`created_at`	`string`	No	—
`updated_at`	`string`	No	—
`user`	`object`	No	—

data full type

{
}

user full type

{
  id?: number,
  name?: string
}

delete

dashboards.delete Delete a dashboard Risk: destructive · Irreversible

await corsair.dnsfilter.api.dashboards.delete({});

Input

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

Output: undefined

link

dashboards.link Link for dashboards Risk: write

await corsair.dnsfilter.api.dashboards.link({});

Input

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

Output: undefined

list

dashboards.list List dashboards Risk: read

await corsair.dnsfilter.api.dashboards.list({});

Input: empty object Output: object[]

Output full type

{
  id?: number,
  name?: string,
  data?: {
  },
  is_public?: boolean,
  created_at?: string,
  updated_at?: string,
  user?: {
    id?: number,
    name?: string
  }
}[]

makePrivate

dashboards.makePrivate Make private for dashboards Risk: write

await corsair.dnsfilter.api.dashboards.makePrivate({});

Input

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

Output: undefined

makePublic

dashboards.makePublic Make public for dashboards Risk: write

await corsair.dnsfilter.api.dashboards.makePublic({});

Input

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

Output: undefined

owned

dashboards.owned Owned for dashboards Risk: read

await corsair.dnsfilter.api.dashboards.owned({});

Input: empty object Output: object[]

Output full type

{
  id?: number,
  name?: string,
  data?: {
  },
  is_public?: boolean,
  created_at?: string,
  updated_at?: string,
  user?: {
    id?: number,
    name?: string
  }
}[]

unlink

dashboards.unlink Unlink for dashboards Risk: write

await corsair.dnsfilter.api.dashboards.unlink({});

Input

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

Output: undefined

update

dashboards.update Update a dashboard Risk: write

await corsair.dnsfilter.api.dashboards.update({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`dashboard`	`object`	Yes	—

dashboard full type

{
  name?: string,
  data?: {
  },
  is_public?: boolean
}

Output

Name	Type	Required	Description
`id`	`number`	No	—
`name`	`string`	No	—
`data`	`object`	No	—
`is_public`	`boolean`	No	—
`created_at`	`string`	No	—
`updated_at`	`string`	No	—
`user`	`object`	No	—

data full type

{
}

user full type

{
  id?: number,
  name?: string
}

Dictionary

qpMethods

dictionary.qpMethods QP methods for dictionary Risk: read

await corsair.dnsfilter.api.dictionary.qpMethods({});

Input: empty object Output: object[]

Output full type

{
  id?: number,
  allow?: boolean,
  name?: string,
  description?: string
}[]

Dictionary V2

aiApplications

dictionaryV2.aiApplications AI applications for dictionary V2 Risk: read

await corsair.dnsfilter.api.dictionaryV2.aiApplications({});

Input: empty object Output: object[]

Output full type

{
  name?: string
}[]

cyberSightActivityTypes

dictionaryV2.cyberSightActivityTypes Cyber sight activity types for dictionary V2 Risk: read

await corsair.dnsfilter.api.dictionaryV2.cyberSightActivityTypes({});

Input: empty object Output: object[]

Output full type

{
  id?: number,
  name?: string,
  friendly_name?: string,
  description?: string
}[]

vpnSettingsStateTypes

dictionaryV2.vpnSettingsStateTypes Vpn settings state types for dictionary V2 Risk: read

await corsair.dnsfilter.api.dictionaryV2.vpnSettingsStateTypes({});

Input: empty object Output: object[]

Output full type

{
  id?: number,
  name?: string,
  friendly_name?: string,
  description?: string
}[]

Domain Notes

batchDestroy

domainNotes.batchDestroy Batch destroy for domain notes Risk: destructive · Irreversible

await corsair.dnsfilter.api.domainNotes.batchDestroy({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`resource`	`policies \| msps \| organizations`	Yes	—
`domains`	`string`	Yes	—

Output: object

Output full type

{
}

batchUpdate

domainNotes.batchUpdate Batch update for domain notes Risk: write

await corsair.dnsfilter.api.domainNotes.batchUpdate({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`resource`	`policies \| msps \| organizations`	Yes	—
`append`	`boolean`	No	—
`notes`	`object[]`	Yes	—
`organization_ids`	`number[]`	No	—
`single_note`	`string`	No	—
`type`	`allow \| block`	No	—

notes full type

{
  domain?: string,
  note?: string
}[]

Output: object

Output full type

{
}

delete

domainNotes.delete Delete a domain note Risk: destructive · Irreversible

await corsair.dnsfilter.api.domainNotes.delete({});

Input

Name	Type	Required	Description
`domain`	`string`	Yes	—
`id`	`number`	Yes	—
`resource`	`policies \| msps \| organizations`	Yes	—

Output: object

Output full type

{
}

get

domainNotes.get Get a domain note Risk: read

await corsair.dnsfilter.api.domainNotes.get({});

Input

Name	Type	Required	Description
`domain`	`string`	Yes	—
`id`	`number`	Yes	—
`resource`	`policies \| msps \| organizations`	Yes	—

Output: object

Output full type

{
}

update

domainNotes.update Update a domain note Risk: write

await corsair.dnsfilter.api.domainNotes.update({});

Input

Name	Type	Required	Description
`domain`	`string`	Yes	—
`id`	`number`	Yes	—
`resource`	`policies \| msps \| organizations`	Yes	—
`body`	`object`	Yes	—

body full type

{
  type: allow | block,
  domain: string,
  note?: string
}

Output: object

Output full type

{
}

Domains

bulkLookup

domains.bulkLookup Bulk lookup for domains Risk: read

await corsair.dnsfilter.api.domains.bulkLookup({});

Input

Name	Type	Required	Description
`fqdns`	`string`	No	—

Output

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

data full type

{
  id?: number | string,
  type?: string,
  uuid?: string,
  name?: string,
  category?: string,
  attributes?: {
    host?: string,
    name?: string
  },
  relationships?: {
    categories?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    }
  }
}[]

suggestThreat

domains.suggestThreat Suggest threat for domains Risk: write

await corsair.dnsfilter.api.domains.suggestThreat({});

Input

Name	Type	Required	Description
`categories`	`string`	No	—
`fqdn`	`string`	Yes	—
`notes`	`string`	Yes	—

Output

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

userLookup

domains.userLookup User lookup for domains Risk: read

await corsair.dnsfilter.api.domains.userLookup({});

Input

Name	Type	Required	Description
`fqdn`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: number | string,
  type?: string,
  uuid?: string,
  name?: string,
  category?: string,
  attributes?: {
    host?: string,
    name?: string
  },
  relationships?: {
    categories?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    }
  }
}

Enterprise Connections

create

enterpriseConnections.create Create an enterprise connection Risk: write

await corsair.dnsfilter.api.enterpriseConnections.create({});

Input

Name	Type	Required	Description
`organization_id`	`number`	Yes	—
`default_organization_id`	`number`	No	—
`strategy`	`oidc`	Yes	—
`display_name`	`string`	No	—
`role_default`	`administrator \| read_only \| owner \| technical \| accountant \| policies_only \| super_administrator`	No	—
`role_map`	`object[]`	No	—
`options`	`object`	Yes	—
`idp`	`openid \| okta \| azure \| google`	No	—
`authorized_domains`	`string[]`	No	—

role_map full type

{
  role?: string,
  group?: string
}[]

options full type

{
  client_id?: string,
  client_secret?: string,
  discovery_url?: string
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  attributes?: {
    id?: number,
    organization_id?: number,
    default_organization_id?: number,
    name?: string,
    display_name?: string,
    role_default?: number,
    role_map?: {
      role?: string,
      group?: string
    }[],
    sub_prefix?: string,
    conn_id?: string,
    idp?: openid | okta | azure | google | string,
    authorized_domains?: string[]
  }
}

delete

enterpriseConnections.delete Delete an enterprise connection Risk: destructive · Irreversible

await corsair.dnsfilter.api.enterpriseConnections.delete({});

Input

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

Output: undefined

get

enterpriseConnections.get Get an enterprise connection Risk: read

await corsair.dnsfilter.api.enterpriseConnections.get({});

Input

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

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  attributes?: {
    id?: number,
    organization_id?: number,
    default_organization_id?: number,
    name?: string,
    display_name?: string,
    role_default?: number,
    role_map?: {
      role?: string,
      group?: string
    }[],
    sub_prefix?: string,
    conn_id?: string,
    idp?: openid | okta | azure | google | string,
    authorized_domains?: string[]
  }
}

list

enterpriseConnections.list List enterprise connections Risk: read

await corsair.dnsfilter.api.enterpriseConnections.list({});

Input

Name	Type	Required	Description
`organization_id`	`number`	Yes	—

Output

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

data full type

{
  attributes?: {
    id?: number,
    organization_id?: number,
    default_organization_id?: number,
    name?: string,
    display_name?: string,
    role_default?: number,
    role_map?: {
      role?: string,
      group?: string
    }[],
    sub_prefix?: string,
    conn_id?: string,
    idp?: openid | okta | azure | google | string,
    authorized_domains?: string[]
  }
}[]

update

enterpriseConnections.update Update an enterprise connection Risk: write

await corsair.dnsfilter.api.enterpriseConnections.update({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`organization_id`	`number`	No	—
`default_organization_id`	`number`	No	—
`display_name`	`string`	No	—
`role_default`	`administrator \| read_only \| owner \| technical \| accountant \| policies_only \| super_administrator`	No	—
`role_map`	`object[]`	No	—
`options`	`object`	Yes	—
`idp`	`openid \| okta \| azure \| google`	No	—
`authorized_domains`	`string[]`	No	—

role_map full type

{
  role?: string,
  group?: string
}[]

options full type

{
  client_id?: string,
  client_secret?: string,
  discovery_url?: string
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  attributes?: {
    id?: number,
    organization_id?: number,
    default_organization_id?: number,
    name?: string,
    display_name?: string,
    role_default?: number,
    role_map?: {
      role?: string,
      group?: string
    }[],
    sub_prefix?: string,
    conn_id?: string,
    idp?: openid | okta | azure | google | string,
    authorized_domains?: string[]
  }
}

Invoices

current

invoices.current Current for invoices Risk: read

await corsair.dnsfilter.api.invoices.current({});

Input: empty object Output

Name	Type	Required	Description
`month_to_date`	`object`	No	—
`estimated`	`object`	No	—

month_to_date full type

{
  id?: number,
  start_date?: string,
  end_date?: string,
  organization_id?: number,
  created_at?: string,
  updated_at?: string,
  total_cents?: number,
  stripe_id?: string,
  requests?: number,
  paid?: boolean,
  closed?: boolean,
  forgiven?: boolean,
  payment_attempts?: number,
  payment_first_attempt?: string,
  payment_last_attempt?: string,
  payment_date?: string,
  payment_receipt_number?: string,
  organization_name?: string,
  invoice_item_groups?: {
    id?: number,
    invoice_id?: number,
    organization_name?: string,
    organization_id?: number,
    subtotal_cents?: number,
    created_at?: string,
    updated_at?: string,
    invoice_items?: {
      id?: number,
      invoice_id?: number,
      network_name?: string,
      network_id?: number,
      cents?: number,
      requests?: number,
      created_at?: string,
      updated_at?: string,
      stripe_id?: string,
      discounted?: boolean,
      invoice_item_group_id?: number
    }[]
  }[],
  invoice_items?: {
    id?: number,
    invoice_id?: number,
    network_name?: string,
    network_id?: number,
    cents?: number,
    requests?: number,
    created_at?: string,
    updated_at?: string,
    stripe_id?: string,
    discounted?: boolean,
    invoice_item_group_id?: number
  }[]
}

estimated full type

{
  id?: number,
  start_date?: string,
  end_date?: string,
  organization_id?: number,
  created_at?: string,
  updated_at?: string,
  total_cents?: number,
  stripe_id?: string,
  requests?: number,
  paid?: boolean,
  closed?: boolean,
  forgiven?: boolean,
  payment_attempts?: number,
  payment_first_attempt?: string,
  payment_last_attempt?: string,
  payment_date?: string,
  payment_receipt_number?: string,
  organization_name?: string,
  invoice_item_groups?: {
    id?: number,
    invoice_id?: number,
    organization_name?: string,
    organization_id?: number,
    subtotal_cents?: number,
    created_at?: string,
    updated_at?: string,
    invoice_items?: {
      id?: number,
      invoice_id?: number,
      network_name?: string,
      network_id?: number,
      cents?: number,
      requests?: number,
      created_at?: string,
      updated_at?: string,
      stripe_id?: string,
      discounted?: boolean,
      invoice_item_group_id?: number
    }[]
  }[],
  invoice_items?: {
    id?: number,
    invoice_id?: number,
    network_name?: string,
    network_id?: number,
    cents?: number,
    requests?: number,
    created_at?: string,
    updated_at?: string,
    stripe_id?: string,
    discounted?: boolean,
    invoice_item_group_id?: number
  }[]
}

get

invoices.get Get an invoice Risk: read

await corsair.dnsfilter.api.invoices.get({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`organization_id`	`number`	Yes	—

Output

Name	Type	Required	Description
`id`	`number`	No	—
`start_date`	`string`	No	—
`end_date`	`string`	No	—
`organization_id`	`number`	No	—
`created_at`	`string`	No	—
`updated_at`	`string`	No	—
`total_cents`	`number`	No	—
`stripe_id`	`string`	No	—
`requests`	`number`	No	—
`paid`	`boolean`	No	—
`closed`	`boolean`	No	—
`forgiven`	`boolean`	No	—
`payment_attempts`	`number`	No	—
`payment_first_attempt`	`string`	No	—
`payment_last_attempt`	`string`	No	—
`payment_date`	`string`	No	—
`payment_receipt_number`	`string`	No	—
`organization_name`	`string`	No	—
`invoice_item_groups`	`object[]`	No	—
`invoice_items`	`object[]`	No	—

invoice_item_groups full type

{
  id?: number,
  invoice_id?: number,
  organization_name?: string,
  organization_id?: number,
  subtotal_cents?: number,
  created_at?: string,
  updated_at?: string,
  invoice_items?: {
    id?: number,
    invoice_id?: number,
    network_name?: string,
    network_id?: number,
    cents?: number,
    requests?: number,
    created_at?: string,
    updated_at?: string,
    stripe_id?: string,
    discounted?: boolean,
    invoice_item_group_id?: number
  }[]
}[]

invoice_items full type

{
  id?: number,
  invoice_id?: number,
  network_name?: string,
  network_id?: number,
  cents?: number,
  requests?: number,
  created_at?: string,
  updated_at?: string,
  stripe_id?: string,
  discounted?: boolean,
  invoice_item_group_id?: number
}[]

list

invoices.list List invoices Risk: read

await corsair.dnsfilter.api.invoices.list({});

Input

Name	Type	Required	Description
`organization_id`	`number`	Yes	—

Output

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

data full type

{
  id?: number,
  start_date?: string,
  end_date?: string,
  organization_id?: number,
  created_at?: string,
  updated_at?: string,
  total_cents?: number,
  stripe_id?: string,
  requests?: number,
  paid?: boolean,
  closed?: boolean,
  forgiven?: boolean,
  payment_attempts?: number,
  payment_first_attempt?: string,
  payment_last_attempt?: string,
  payment_date?: string,
  payment_receipt_number?: string,
  organization_name?: string,
  invoice_item_groups?: {
    id?: number,
    invoice_id?: number,
    organization_name?: string,
    organization_id?: number,
    subtotal_cents?: number,
    created_at?: string,
    updated_at?: string,
    invoice_items?: {
      id?: number,
      invoice_id?: number,
      network_name?: string,
      network_id?: number,
      cents?: number,
      requests?: number,
      created_at?: string,
      updated_at?: string,
      stripe_id?: string,
      discounted?: boolean,
      invoice_item_group_id?: number
    }[]
  }[],
  invoice_items?: {
    id?: number,
    invoice_id?: number,
    network_name?: string,
    network_id?: number,
    cents?: number,
    requests?: number,
    created_at?: string,
    updated_at?: string,
    stripe_id?: string,
    discounted?: boolean,
    invoice_item_group_id?: number
  }[]
}[]

Ip Addresses

create

ipAddresses.create Create an IP address Risk: write

await corsair.dnsfilter.api.ipAddresses.create({});

Input

Name	Type	Required	Description
`ip_address`	`object`	Yes	—

ip_address full type

{
  address: string,
  organization_id: number,
  network_id: number,
  dynamic_hostname?: string
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    ip?: string,
    address?: string,
    network_id?: number,
    organization_id?: number
  },
  relationships?: {
    network?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    }
  }
}

delete

ipAddresses.delete Delete an IP address Risk: destructive · Irreversible

await corsair.dnsfilter.api.ipAddresses.delete({});

Input

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

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    ip?: string,
    address?: string,
    network_id?: number,
    organization_id?: number
  },
  relationships?: {
    network?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    }
  }
}

get

ipAddresses.get Get an IP address Risk: read

await corsair.dnsfilter.api.ipAddresses.get({});

Input

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

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    ip?: string,
    address?: string,
    network_id?: number,
    organization_id?: number
  },
  relationships?: {
    network?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    }
  }
}

list

ipAddresses.list List IP addresses Risk: read

await corsair.dnsfilter.api.ipAddresses.list({
	page: { number: 1, size: 25 },
});

Input

Name	Type	Required	Description
`page`	`object`	No	—
`search`	`string`	No	—

page full type

{
  number?: number,
  size?: number
}

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`links`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    ip?: string,
    address?: string,
    network_id?: number,
    organization_id?: number
  },
  relationships?: {
    network?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    }
  }
}[]

links full type

{
  self?: string,
  first?: string,
  prev?: string,
  next?: string,
  last?: string
}

listAll

ipAddresses.listAll List all IP addresses Risk: read

await corsair.dnsfilter.api.ipAddresses.listAll({});

Input

Name	Type	Required	Description
`page`	`object`	No	—

page full type

{
  number?: number,
  size?: number
}

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`links`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    ip?: string,
    address?: string,
    network_id?: number,
    organization_id?: number
  },
  relationships?: {
    network?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    }
  }
}[]

links full type

{
  self?: string,
  first?: string,
  prev?: string,
  next?: string,
  last?: string
}

myip

ipAddresses.myip My IP for IP addresses Risk: read

await corsair.dnsfilter.api.ipAddresses.myip({});

Input: empty object Output

Name	Type	Required	Description
`myip`	`string`	No	—

update

ipAddresses.update Update an IP address Risk: write

await corsair.dnsfilter.api.ipAddresses.update({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`ip_address`	`object`	Yes	—

ip_address full type

{
  address: string,
  organization_id: number,
  network_id: number,
  dynamic_hostname?: string
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    ip?: string,
    address?: string,
    network_id?: number,
    organization_id?: number
  },
  relationships?: {
    network?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    }
  }
}

verify

ipAddresses.verify Verify for IP addresses Risk: read

await corsair.dnsfilter.api.ipAddresses.verify({});

Input

Name	Type	Required	Description
`ip_address`	`object`	Yes	—

ip_address full type

{
  address: string,
  organization_id: number,
  network_id: number,
  dynamic_hostname?: string
}

Output

Name	Type	Required	Description
`status`	`string`	No	—
`data`	`object[]`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    ip?: string,
    address?: string,
    network_id?: number,
    organization_id?: number
  },
  relationships?: {
    network?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    }
  }
}[]

Mac Addresses

create

macAddresses.create Create a MAC address Risk: write

await corsair.dnsfilter.api.macAddresses.create({});

Input

Name	Type	Required	Description
`mac_address`	`object`	Yes	—

mac_address full type

{
  organization_id: number,
  address?: string,
  filter_value?: string,
  policy_id?: number,
  scheduled_policy_id?: number,
  block_page_id?: number
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    address?: string,
    filter_value?: string,
    created_at?: string,
    updated_at?: string
  },
  relationships?: {
    organization?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    scheduled_policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    block_page?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    }
  }
}

delete

macAddresses.delete Delete a MAC address Risk: destructive · Irreversible

await corsair.dnsfilter.api.macAddresses.delete({});

Input

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

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    address?: string,
    filter_value?: string,
    created_at?: string,
    updated_at?: string
  },
  relationships?: {
    organization?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    scheduled_policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    block_page?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    }
  }
}

get

macAddresses.get Get a MAC address Risk: read

await corsair.dnsfilter.api.macAddresses.get({});

Input

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

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    address?: string,
    filter_value?: string,
    created_at?: string,
    updated_at?: string
  },
  relationships?: {
    organization?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    scheduled_policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    block_page?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    }
  }
}

list

macAddresses.list List MAC addresses Risk: read

await corsair.dnsfilter.api.macAddresses.list({});

Input

Name	Type	Required	Description
`organization_ids`	`number[]`	No	—
`page`	`object`	No	—

page full type

{
  number?: number,
  size?: number
}

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`links`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    address?: string,
    filter_value?: string,
    created_at?: string,
    updated_at?: string
  },
  relationships?: {
    organization?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    scheduled_policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    block_page?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    }
  }
}[]

links full type

{
  self?: string,
  first?: string,
  prev?: string,
  next?: string,
  last?: string
}

listAll

macAddresses.listAll List all MAC addresses Risk: read

await corsair.dnsfilter.api.macAddresses.listAll({});

Input

Name	Type	Required	Description
`organization_ids`	`number[]`	No	—
`page`	`object`	No	—

page full type

{
  number?: number,
  size?: number
}

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`links`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    address?: string,
    filter_value?: string,
    created_at?: string,
    updated_at?: string
  },
  relationships?: {
    organization?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    scheduled_policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    block_page?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    }
  }
}[]

links full type

{
  self?: string,
  first?: string,
  prev?: string,
  next?: string,
  last?: string
}

update

macAddresses.update Update a MAC address Risk: write

await corsair.dnsfilter.api.macAddresses.update({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`mac_address`	`object`	Yes	—

mac_address full type

{
  organization_id: number,
  address?: string,
  filter_value?: string,
  policy_id?: number,
  scheduled_policy_id?: number,
  block_page_id?: number
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    address?: string,
    filter_value?: string,
    created_at?: string,
    updated_at?: string
  },
  relationships?: {
    organization?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    scheduled_policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    block_page?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    }
  }
}

Metrics

organizationUsage

metrics.organizationUsage Organization usage for metrics Risk: read

await corsair.dnsfilter.api.metrics.organizationUsage({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`from`	`string`	Yes	—
`to`	`string`	Yes	—

Output

Name	Type	Required	Description
`data`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  organization_id?: number,
  plan?: string,
  term?: string,
  user_count?: number,
  wifi_count?: number,
  total_requests?: number,
  estimated_users?: number,
  from?: string,
  to?: string,
  days_in_period?: number
}

meta full type

{
  queries_per_user?: number
}

organizationUsageDetailed

metrics.organizationUsageDetailed Organization usage detailed for metrics Risk: read

await corsair.dnsfilter.api.metrics.organizationUsageDetailed({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`from`	`string`	Yes	—
`to`	`string`	Yes	—

Output

Name	Type	Required	Description
`data`	`object`	No	—
`meta`	`object`	No	—

data full type

{
  organization_id?: number,
  plan?: string,
  term?: string,
  user_count?: number,
  wifi_count?: number,
  roaming_client_count?: number,
  mobile_roaming_client_count?: number,
  total_requests?: number,
  estimated_users?: number,
  from?: string,
  to?: string,
  days_in_period?: number
}

meta full type

{
  queries_per_user?: number
}

Network Lan Ips

get

networkLanIps.get Get a network LAN IP Risk: read

await corsair.dnsfilter.api.networkLanIps.get({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`lan_ip_id`	`number`	Yes	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    version?: number,
    address?: string,
    name?: string,
    first_seen?: string,
    last_seen?: string
  },
  relationships?: {
    network?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    }
  }
}

list

networkLanIps.list List network LAN IPs Risk: read

await corsair.dnsfilter.api.networkLanIps.list({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`page`	`object`	No	—

page full type

{
  number?: number,
  size?: number
}

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`links`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    version?: number,
    address?: string,
    name?: string,
    first_seen?: string,
    last_seen?: string
  },
  relationships?: {
    network?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    }
  }
}[]

links full type

{
  self?: string,
  first?: string,
  prev?: string,
  next?: string,
  last?: string
}

update

networkLanIps.update Update a network LAN IP Risk: write

await corsair.dnsfilter.api.networkLanIps.update({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`lan_ip_id`	`number`	Yes	—
`network_lan_ip`	`object`	Yes	—

network_lan_ip full type

{
  name?: string
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    version?: number,
    address?: string,
    name?: string,
    first_seen?: string,
    last_seen?: string
  },
  relationships?: {
    network?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    }
  }
}

Networks

bulkCreate

networks.bulkCreate Bulk create for networks Risk: write

await corsair.dnsfilter.api.networks.bulkCreate({});

Input

Name	Type	Required	Description
`Network`	`object`	No	—

Network full type

{
  networks?: {
    network: {
      name: string,
      organization_id: number,
      block_page_id?: number,
      policy_ids?: number[],
      external_id?: string,
      is_legacy_vpn_active?: boolean,
      physical_address?: string,
      ip_addresses_attributes?: {
        address?: string,
        key?: string
      }[],
      local_domains?: string[],
      local_resolvers?: string[]
    }
  }[]
}

Output

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

bulkCreateStatus

networks.bulkCreateStatus Bulk create status for networks Risk: read

await corsair.dnsfilter.api.networks.bulkCreateStatus({});

Input

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

Output

Name	Type	Required	Description
`total`	`number`	No	—
`successful`	`number`	No	—
`failed`	`number`	No	—
`skipped`	`number`	No	—
`failed_ids`	`string`	No	—
`skipped_ids`	`string`	No	—
`done`	`boolean`	No	—

bulkDestroy

networks.bulkDestroy Bulk destroy for networks Risk: destructive · Irreversible

await corsair.dnsfilter.api.networks.bulkDestroy({});

Input

Name	Type	Required	Description
`ids`	`string`	Yes	—
`organization_id`	`number`	No	—

Output

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

bulkDestroyStatus

networks.bulkDestroyStatus Bulk destroy status for networks Risk: read

await corsair.dnsfilter.api.networks.bulkDestroyStatus({});

Input

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

Output

Name	Type	Required	Description
`total`	`number`	No	—
`successful`	`number`	No	—
`failed`	`number`	No	—
`skipped`	`number`	No	—
`failed_ids`	`string`	No	—
`skipped_ids`	`string`	No	—
`done`	`boolean`	No	—

bulkUpdate

networks.bulkUpdate Bulk update for networks Risk: write

await corsair.dnsfilter.api.networks.bulkUpdate({});

Input

Name	Type	Required	Description
`ids`	`string`	Yes	—
`organization_id`	`number`	No	—
`policy_id`	`number`	No	—
`scheduled_policy_id`	`number`	No	—
`block_page_id`	`number`	No	—
`is_legacy_vpn_active`	`boolean`	No	—

Output

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

bulkUpdateStatus

networks.bulkUpdateStatus Bulk update status for networks Risk: read

await corsair.dnsfilter.api.networks.bulkUpdateStatus({});

Input

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

Output

Name	Type	Required	Description
`total`	`number`	No	—
`successful`	`number`	No	—
`failed`	`number`	No	—
`skipped`	`number`	No	—
`failed_ids`	`string`	No	—
`skipped_ids`	`string`	No	—
`done`	`boolean`	No	—

counts

networks.counts Counts for networks Risk: read

await corsair.dnsfilter.api.networks.counts({});

Input

Name	Type	Required	Description
`msp_id`	`number`	No	—
`organization_ids`	`number[]`	No	—

Output

Name	Type	Required	Description
`all`	`number`	No	—
`offline`	`number`	No	—
`protected`	`object`	No	—
`unprotected`	`object`	No	—

protected full type

{
  count?: number,
  network_ids?: number[]
}

unprotected full type

{
  count?: number,
  network_ids?: number[]
}

create

networks.create Create a network Risk: write

await corsair.dnsfilter.api.networks.create({
	network: { name: 'HQ', organization_id: 99 },
});

Input

Name	Type	Required	Description
`network`	`object`	Yes	—

network full type

{
  name: string,
  organization_id: number,
  block_page_id?: number,
  policy_ids?: number[],
  external_id?: string,
  is_legacy_vpn_active?: boolean,
  physical_address?: string,
  ip_addresses_attributes?: {
    address?: string,
    key?: string
  }[],
  local_domains?: string[],
  local_resolvers?: string[]
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    physical_address?: string,
    latitude?: number,
    longitude?: number,
    block_default_appearance?: boolean,
    block_org_name?: string,
    block_email_addr?: string,
    block_logo_uuid?: string,
    allow_all_policies?: boolean,
    billing_per_user?: boolean,
    billing_user_count?: number,
    network_type_units?: number,
    block_page_id?: number,
    scheduled_policy_id?: number,
    secret_key?: string,
    deleted_at?: string,
    external_id?: string,
    local_domains?: string[],
    local_resolvers?: string[]
  },
  relationships?: {
    organization?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    ip_addresses?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    },
    policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    scheduled_policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    block_page?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    policies?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    }
  }
}

delete

networks.delete Delete a network Risk: destructive · Irreversible

await corsair.dnsfilter.api.networks.delete({ id: 12345 });

Input

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

Output: undefined

generateSecretKey

networks.generateSecretKey Generate secret key for networks Risk: write

await corsair.dnsfilter.api.networks.generateSecretKey({});

Input

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

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    physical_address?: string,
    latitude?: number,
    longitude?: number,
    block_default_appearance?: boolean,
    block_org_name?: string,
    block_email_addr?: string,
    block_logo_uuid?: string,
    allow_all_policies?: boolean,
    billing_per_user?: boolean,
    billing_user_count?: number,
    network_type_units?: number,
    block_page_id?: number,
    scheduled_policy_id?: number,
    secret_key?: string,
    deleted_at?: string,
    external_id?: string,
    local_domains?: string[],
    local_resolvers?: string[]
  },
  relationships?: {
    organization?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    ip_addresses?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    },
    policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    scheduled_policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    block_page?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    policies?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    }
  }
}

geo

networks.geo Geo for networks Risk: read

await corsair.dnsfilter.api.networks.geo({});

Input: empty object Output

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

data full type

{
  id?: number,
  organization_id?: number,
  name?: string,
  latitude?: number,
  longitude?: number,
  physical_address?: string
}[]

get

networks.get Get a network Risk: read

await corsair.dnsfilter.api.networks.get({ id: 12345 });

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`count_network_ips`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    physical_address?: string,
    latitude?: number,
    longitude?: number,
    block_default_appearance?: boolean,
    block_org_name?: string,
    block_email_addr?: string,
    block_logo_uuid?: string,
    allow_all_policies?: boolean,
    billing_per_user?: boolean,
    billing_user_count?: number,
    network_type_units?: number,
    block_page_id?: number,
    scheduled_policy_id?: number,
    secret_key?: string,
    deleted_at?: string,
    external_id?: string,
    local_domains?: string[],
    local_resolvers?: string[]
  },
  relationships?: {
    organization?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    ip_addresses?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    },
    policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    scheduled_policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    block_page?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    policies?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    }
  }
}

list

networks.list List networks Risk: read

await corsair.dnsfilter.api.networks.list({
	page: { number: 1, size: 25 },
});

Input

Name	Type	Required	Description
`basic_info`	`boolean`	No	—
`count_network_ips`	`boolean`	No	—
`force_truncate_ips`	`boolean`	No	—
`page`	`object`	No	—
`protected`	`boolean`	No	—
`search`	`string`	No	—
`unprotected`	`boolean`	No	—

page full type

{
  number?: number,
  size?: number
}

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`included`	`object[]`	No	—
`links`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    physical_address?: string,
    latitude?: number,
    longitude?: number,
    block_default_appearance?: boolean,
    block_org_name?: string,
    block_email_addr?: string,
    block_logo_uuid?: string,
    allow_all_policies?: boolean,
    billing_per_user?: boolean,
    billing_user_count?: number,
    network_type_units?: number,
    block_page_id?: number,
    scheduled_policy_id?: number,
    secret_key?: string,
    deleted_at?: string,
    external_id?: string,
    local_domains?: string[],
    local_resolvers?: string[]
  },
  relationships?: {
    organization?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    ip_addresses?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    },
    policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    scheduled_policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    block_page?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    policies?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    }
  }
}[]

included full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    ip?: string,
    address?: string,
    network_id?: number,
    organization_id?: number
  },
  relationships?: {
    network?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    }
  }
}[]

links full type

{
  self?: string,
  first?: string,
  prev?: string,
  next?: string,
  last?: string
}

listAll

networks.listAll List all networks Risk: read

await corsair.dnsfilter.api.networks.listAll({});

Input

Name	Type	Required	Description
`basic_info`	`boolean`	No	—
`count_network_ips`	`boolean`	No	—
`force_truncate_ips`	`boolean`	No	—
`page`	`object`	No	—
`protected`	`boolean`	No	—
`search`	`string`	No	—
`unprotected`	`boolean`	No	—

page full type

{
  number?: number,
  size?: number
}

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`included`	`object[]`	No	—
`links`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    physical_address?: string,
    latitude?: number,
    longitude?: number,
    block_default_appearance?: boolean,
    block_org_name?: string,
    block_email_addr?: string,
    block_logo_uuid?: string,
    allow_all_policies?: boolean,
    billing_per_user?: boolean,
    billing_user_count?: number,
    network_type_units?: number,
    block_page_id?: number,
    scheduled_policy_id?: number,
    secret_key?: string,
    deleted_at?: string,
    external_id?: string,
    local_domains?: string[],
    local_resolvers?: string[]
  },
  relationships?: {
    organization?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    ip_addresses?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    },
    policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    scheduled_policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    block_page?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    policies?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    }
  }
}[]

included full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    ip?: string,
    address?: string,
    network_id?: number,
    organization_id?: number
  },
  relationships?: {
    network?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    }
  }
}[]

links full type

{
  self?: string,
  first?: string,
  prev?: string,
  next?: string,
  last?: string
}

lookup

networks.lookup Lookup for networks Risk: read

await corsair.dnsfilter.api.networks.lookup({});

Input

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

Output

Name	Type	Required	Description
`block_org_name`	`string`	No	—
`block_email_addr`	`string`	No	—
`block_logo_uuid`	`string`	No	—
`block_default_appearance`	`boolean`	No	—

msp

networks.msp List MSP networks Risk: read

await corsair.dnsfilter.api.networks.msp({});

Input

Name	Type	Required	Description
`basic_info`	`boolean`	No	—
`count_network_ips`	`boolean`	No	—
`force_truncate_ips`	`boolean`	No	—
`organization_id`	`number`	Yes	—
`page`	`object`	No	—
`protected`	`boolean`	No	—
`unprotected`	`boolean`	No	—

page full type

{
  number?: number,
  size?: number
}

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`included`	`object[]`	No	—
`links`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    physical_address?: string,
    latitude?: number,
    longitude?: number,
    block_default_appearance?: boolean,
    block_org_name?: string,
    block_email_addr?: string,
    block_logo_uuid?: string,
    allow_all_policies?: boolean,
    billing_per_user?: boolean,
    billing_user_count?: number,
    network_type_units?: number,
    block_page_id?: number,
    scheduled_policy_id?: number,
    secret_key?: string,
    deleted_at?: string,
    external_id?: string,
    local_domains?: string[],
    local_resolvers?: string[]
  },
  relationships?: {
    organization?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    ip_addresses?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    },
    policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    scheduled_policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    block_page?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    policies?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    }
  }
}[]

included full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    ip?: string,
    address?: string,
    network_id?: number,
    organization_id?: number
  },
  relationships?: {
    network?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    }
  }
}[]

links full type

{
  self?: string,
  first?: string,
  prev?: string,
  next?: string,
  last?: string
}

mspAll

networks.mspAll List all MSP networks Risk: read

await corsair.dnsfilter.api.networks.mspAll({});

Input

Name	Type	Required	Description
`count_network_ips`	`boolean`	No	—
`force_truncate_ips`	`boolean`	No	—
`organization_id`	`number`	Yes	—
`page`	`object`	No	—
`protected`	`boolean`	No	—
`unprotected`	`boolean`	No	—

page full type

{
  number?: number,
  size?: number
}

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`included`	`object[]`	No	—
`links`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    physical_address?: string,
    latitude?: number,
    longitude?: number,
    block_default_appearance?: boolean,
    block_org_name?: string,
    block_email_addr?: string,
    block_logo_uuid?: string,
    allow_all_policies?: boolean,
    billing_per_user?: boolean,
    billing_user_count?: number,
    network_type_units?: number,
    block_page_id?: number,
    scheduled_policy_id?: number,
    secret_key?: string,
    deleted_at?: string,
    external_id?: string,
    local_domains?: string[],
    local_resolvers?: string[]
  },
  relationships?: {
    organization?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    ip_addresses?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    },
    policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    scheduled_policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    block_page?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    policies?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    }
  }
}[]

included full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    ip?: string,
    address?: string,
    network_id?: number,
    organization_id?: number
  },
  relationships?: {
    network?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    }
  }
}[]

links full type

{
  self?: string,
  first?: string,
  prev?: string,
  next?: string,
  last?: string
}

revokeSecretKey

networks.revokeSecretKey Revoke secret key for networks Risk: destructive · Irreversible

await corsair.dnsfilter.api.networks.revokeSecretKey({});

Input

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

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    physical_address?: string,
    latitude?: number,
    longitude?: number,
    block_default_appearance?: boolean,
    block_org_name?: string,
    block_email_addr?: string,
    block_logo_uuid?: string,
    allow_all_policies?: boolean,
    billing_per_user?: boolean,
    billing_user_count?: number,
    network_type_units?: number,
    block_page_id?: number,
    scheduled_policy_id?: number,
    secret_key?: string,
    deleted_at?: string,
    external_id?: string,
    local_domains?: string[],
    local_resolvers?: string[]
  },
  relationships?: {
    organization?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    ip_addresses?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    },
    policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    scheduled_policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    block_page?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    policies?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    }
  }
}

rotateSecretKey

networks.rotateSecretKey Rotate secret key for networks Risk: write

await corsair.dnsfilter.api.networks.rotateSecretKey({});

Input

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

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    physical_address?: string,
    latitude?: number,
    longitude?: number,
    block_default_appearance?: boolean,
    block_org_name?: string,
    block_email_addr?: string,
    block_logo_uuid?: string,
    allow_all_policies?: boolean,
    billing_per_user?: boolean,
    billing_user_count?: number,
    network_type_units?: number,
    block_page_id?: number,
    scheduled_policy_id?: number,
    secret_key?: string,
    deleted_at?: string,
    external_id?: string,
    local_domains?: string[],
    local_resolvers?: string[]
  },
  relationships?: {
    organization?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    ip_addresses?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    },
    policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    scheduled_policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    block_page?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    policies?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    }
  }
}

update

networks.update Update a network Risk: write

await corsair.dnsfilter.api.networks.update({
	id: 12345,
	network: { name: 'HQ', organization_id: 99 },
});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`network`	`object`	Yes	—

network full type

{
  name: string,
  organization_id: number,
  block_page_id?: number,
  policy_ids?: number[],
  external_id?: string,
  is_legacy_vpn_active?: boolean,
  physical_address?: string,
  ip_addresses_attributes?: {
    id?: number,
    address?: string,
    key?: string
  }[],
  local_domains?: string[],
  local_resolvers?: string[]
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    physical_address?: string,
    latitude?: number,
    longitude?: number,
    block_default_appearance?: boolean,
    block_org_name?: string,
    block_email_addr?: string,
    block_logo_uuid?: string,
    allow_all_policies?: boolean,
    billing_per_user?: boolean,
    billing_user_count?: number,
    network_type_units?: number,
    block_page_id?: number,
    scheduled_policy_id?: number,
    secret_key?: string,
    deleted_at?: string,
    external_id?: string,
    local_domains?: string[],
    local_resolvers?: string[]
  },
  relationships?: {
    organization?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    ip_addresses?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    },
    policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    scheduled_policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    block_page?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    policies?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    }
  }
}

Network Subnets

create

networkSubnets.create Create a network subnet Risk: write

await corsair.dnsfilter.api.networkSubnets.create({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`network_subnet`	`object`	Yes	—

network_subnet full type

{
  name: string,
  from: string,
  to: string,
  policy_id?: number,
  scheduled_policy_id?: number,
  block_page_id?: number
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    version?: number,
    name?: string,
    from?: string,
    to?: string
  },
  relationships?: {
    network?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    scheduled_policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    }
  }
}

delete

networkSubnets.delete Delete a network subnet Risk: destructive · Irreversible

await corsair.dnsfilter.api.networkSubnets.delete({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`subnet_id`	`number`	Yes	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    version?: number,
    name?: string,
    from?: string,
    to?: string
  },
  relationships?: {
    network?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    scheduled_policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    }
  }
}

get

networkSubnets.get Get a network subnet Risk: read

await corsair.dnsfilter.api.networkSubnets.get({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`subnet_id`	`number`	Yes	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    version?: number,
    name?: string,
    from?: string,
    to?: string
  },
  relationships?: {
    network?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    scheduled_policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    }
  }
}

list

networkSubnets.list List network subnets Risk: read

await corsair.dnsfilter.api.networkSubnets.list({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`page`	`object`	No	—

page full type

{
  number?: number,
  size?: number
}

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`links`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    version?: number,
    name?: string,
    from?: string,
    to?: string
  },
  relationships?: {
    network?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    scheduled_policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    }
  }
}[]

links full type

{
  self?: string,
  first?: string,
  prev?: string,
  next?: string,
  last?: string
}

listAll

networkSubnets.listAll List all network subnets Risk: read

await corsair.dnsfilter.api.networkSubnets.listAll({});

Input

Name	Type	Required	Description
`organization_id`	`number`	No	—

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`links`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    version?: number,
    name?: string,
    from?: string,
    to?: string
  },
  relationships?: {
    network?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    scheduled_policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    }
  }
}[]

links full type

{
  self?: string,
  first?: string,
  prev?: string,
  next?: string,
  last?: string
}

update

networkSubnets.update Update a network subnet Risk: write

await corsair.dnsfilter.api.networkSubnets.update({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`subnet_id`	`number`	Yes	—
`network_subnet`	`object`	Yes	—

network_subnet full type

{
  name: string,
  from: string,
  to: string,
  policy_id?: number,
  scheduled_policy_id?: number,
  block_page_id?: number
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    version?: number,
    name?: string,
    from?: string,
    to?: string
  },
  relationships?: {
    network?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    scheduled_policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    }
  }
}

Organizations

bulkUpdate

organizations.bulkUpdate Bulk update for organizations Risk: write

await corsair.dnsfilter.api.organizations.bulkUpdate({});

Input

Name	Type	Required	Description
`organization_ids`	`number[]`	No	—
`msp_id`	`number`	No	—
`exclude_organization_ids`	`number[]`	No	—
`send_uninstall_notifications_to_admin_users`	`boolean`	No	—
`user_agent_uninstall_notification`	`boolean`	No	—
`user_agent_uninstall_notification_recipient_emails`	`string[]`	No	—
`user_agents_auto_update`	`boolean`	No	—
`vpn_settings_organization_attributes`	`object`	No	—

vpn_settings_organization_attributes full type

{
  vpn_settings_state_type_id?: number
}

Output

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

cancel

organizations.cancel Cancel an organization Risk: destructive · Irreversible

await corsair.dnsfilter.api.organizations.cancel({});

Input

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

Output: undefined

create

organizations.create Create an organization Risk: write

await corsair.dnsfilter.api.organizations.create({});

Input

Name	Type	Required	Description
`organization`	`object`	Yes	—

organization full type

{
  name: string,
  billing_contact_name?: string,
  billing_contact_phone?: string,
  billing_contact_email?: string,
  address?: string,
  managed_by_msp_id: number,
  unique_id?: string,
  sku?: string,
  quantity?: number,
  vpn_settings_organization_attributes?: {
    id?: number,
    vpn_settings_state_type_id?: number,
    _destroy?: boolean
  },
  privacy_mode?: inherit | standard | identify_devices | maximum,
  enable_cybersight?: boolean
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    id?: number,
    address?: string,
    allow_create_network?: boolean,
    allowlist_updated_at?: string,
    billing_address?: string,
    billing_contact_email?: string,
    billing_contact_name?: string,
    billing_contact_phone?: string,
    billing_manual?: boolean,
    blocklist_updated_at?: string,
    canceled?: boolean,
    canceled_at?: string,
    external_id?: string,
    feature_flags?: string[],
    fetched_onboard_details?: boolean,
    first_traffic_sent?: string,
    industry?: string,
    managed_by_msp_id?: number,
    metadata?: {
    },
    msp_feature_flags?: string[],
    name?: string,
    owned_msp_id?: number,
    plan_details?: string,
    release_channel?: string,
    role?: string,
    send_uninstall_notifications_to_admin_users?: boolean,
    sso_enabled?: boolean,
    stripe_customer_id?: string,
    summary_email_address?: string,
    summary_email_enabled?: boolean,
    sync_tools_auto_update?: boolean,
    trial_days?: number,
    unbounce_data?: string,
    unique_id?: string,
    update_payment?: boolean,
    usage_alert_cents?: string,
    user_agent_uninstall_notification?: boolean,
    user_agent_uninstall_notification_recipient_emails?: string[],
    user_agents_auto_update?: boolean,
    will_cancel_at?: string,
    active_psa_integration?: boolean,
    segment?: string,
    vpn_settings_organization?: {
      vpn_settings_state_type_id?: number
    }
  },
  relationships?: {
    networks?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    }
  }
}

delete

organizations.delete Delete an organization Risk: destructive · Irreversible

await corsair.dnsfilter.api.organizations.delete({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`clear_subscription_info`	`boolean`	No	—

Output: undefined

get

organizations.get Get an organization Risk: read

await corsair.dnsfilter.api.organizations.get({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`include_current_mrr`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    id?: number,
    address?: string,
    allow_create_network?: boolean,
    allowlist_updated_at?: string,
    billing_address?: string,
    billing_contact_email?: string,
    billing_contact_name?: string,
    billing_contact_phone?: string,
    billing_manual?: boolean,
    blocklist_updated_at?: string,
    canceled?: boolean,
    canceled_at?: string,
    external_id?: string,
    feature_flags?: string[],
    fetched_onboard_details?: boolean,
    first_traffic_sent?: string,
    industry?: string,
    managed_by_msp_id?: number,
    metadata?: {
    },
    msp_feature_flags?: string[],
    name?: string,
    owned_msp_id?: number,
    plan_details?: string,
    release_channel?: string,
    role?: string,
    send_uninstall_notifications_to_admin_users?: boolean,
    sso_enabled?: boolean,
    stripe_customer_id?: string,
    summary_email_address?: string,
    summary_email_enabled?: boolean,
    sync_tools_auto_update?: boolean,
    trial_days?: number,
    unbounce_data?: string,
    unique_id?: string,
    update_payment?: boolean,
    usage_alert_cents?: string,
    user_agent_uninstall_notification?: boolean,
    user_agent_uninstall_notification_recipient_emails?: string[],
    user_agents_auto_update?: boolean,
    will_cancel_at?: string,
    active_psa_integration?: boolean,
    segment?: string,
    vpn_settings_organization?: {
      vpn_settings_state_type_id?: number
    }
  },
  relationships?: {
    networks?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    }
  }
}

list

organizations.list List organizations Risk: read

await corsair.dnsfilter.api.organizations.list({});

Input

Name	Type	Required	Description
`basic_info`	`boolean`	No	—
`exclude_inherit_privacy_mode`	`boolean`	No	—
`managed_by_msp_id`	`number`	No	—
`name`	`string`	No	—
`owned_msp_id`	`number`	No	—
`page`	`object`	No	—
`pii_grid_search`	`string`	No	—
`type`	`normal \| msp \| sub_organization`	No	—

page full type

{
  number?: number,
  size?: number
}

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`links`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    id?: number,
    address?: string,
    allow_create_network?: boolean,
    allowlist_updated_at?: string,
    billing_address?: string,
    billing_contact_email?: string,
    billing_contact_name?: string,
    billing_contact_phone?: string,
    billing_manual?: boolean,
    blocklist_updated_at?: string,
    canceled?: boolean,
    canceled_at?: string,
    external_id?: string,
    feature_flags?: string[],
    fetched_onboard_details?: boolean,
    first_traffic_sent?: string,
    industry?: string,
    managed_by_msp_id?: number,
    metadata?: {
    },
    msp_feature_flags?: string[],
    name?: string,
    owned_msp_id?: number,
    plan_details?: string,
    release_channel?: string,
    role?: string,
    send_uninstall_notifications_to_admin_users?: boolean,
    sso_enabled?: boolean,
    stripe_customer_id?: string,
    summary_email_address?: string,
    summary_email_enabled?: boolean,
    sync_tools_auto_update?: boolean,
    trial_days?: number,
    unbounce_data?: string,
    unique_id?: string,
    update_payment?: boolean,
    usage_alert_cents?: string,
    user_agent_uninstall_notification?: boolean,
    user_agent_uninstall_notification_recipient_emails?: string[],
    user_agents_auto_update?: boolean,
    will_cancel_at?: string,
    active_psa_integration?: boolean,
    segment?: string,
    vpn_settings_organization?: {
      vpn_settings_state_type_id?: number
    }
  },
  relationships?: {
    networks?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    }
  }
}[]

links full type

{
  self?: string,
  first?: string,
  prev?: string,
  next?: string,
  last?: string
}

listAll

organizations.listAll List all organizations Risk: read

await corsair.dnsfilter.api.organizations.listAll({});

Input

Name	Type	Required	Description
`basic_info`	`boolean`	No	—
`managed_by_msp_id`	`number`	No	—
`name`	`string`	No	—
`owned_msp_id`	`number`	No	—
`page`	`object`	No	—
`type`	`normal \| msp \| sub_organization`	No	—

page full type

{
  number?: number,
  size?: number
}

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`links`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    id?: number,
    address?: string,
    allow_create_network?: boolean,
    allowlist_updated_at?: string,
    billing_address?: string,
    billing_contact_email?: string,
    billing_contact_name?: string,
    billing_contact_phone?: string,
    billing_manual?: boolean,
    blocklist_updated_at?: string,
    canceled?: boolean,
    canceled_at?: string,
    external_id?: string,
    feature_flags?: string[],
    fetched_onboard_details?: boolean,
    first_traffic_sent?: string,
    industry?: string,
    managed_by_msp_id?: number,
    metadata?: {
    },
    msp_feature_flags?: string[],
    name?: string,
    owned_msp_id?: number,
    plan_details?: string,
    release_channel?: string,
    role?: string,
    send_uninstall_notifications_to_admin_users?: boolean,
    sso_enabled?: boolean,
    stripe_customer_id?: string,
    summary_email_address?: string,
    summary_email_enabled?: boolean,
    sync_tools_auto_update?: boolean,
    trial_days?: number,
    unbounce_data?: string,
    unique_id?: string,
    update_payment?: boolean,
    usage_alert_cents?: string,
    user_agent_uninstall_notification?: boolean,
    user_agent_uninstall_notification_recipient_emails?: string[],
    user_agents_auto_update?: boolean,
    will_cancel_at?: string,
    active_psa_integration?: boolean,
    segment?: string,
    vpn_settings_organization?: {
      vpn_settings_state_type_id?: number
    }
  },
  relationships?: {
    networks?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    }
  }
}[]

links full type

{
  self?: string,
  first?: string,
  prev?: string,
  next?: string,
  last?: string
}

promoteToMsp

organizations.promoteToMsp Promote to MSP for organizations Risk: write

await corsair.dnsfilter.api.organizations.promoteToMsp({});

Input

Name	Type	Required	Description
`plan`	`string`	No	—
`zapier_params`	`object`	No	—

zapier_params full type

{
}

Output: object

Output full type

{
}

settings

organizations.settings Settings for organizations Risk: read

await corsair.dnsfilter.api.organizations.settings({});

Input

Name	Type	Required	Description
`msp_id`	`number`	No	—
`name`	`string`	No	—
`organization_id`	`number`	No	—
`organization_ids`	`string`	No	—

Output: object[]

Output full type

{
  id?: number,
  name?: string,
  user_agents_auto_update?: boolean,
  user_agent_uninstall_notification?: boolean,
  send_uninstall_notifications_to_admin_users?: boolean,
  diagnostics_sharing_enabled?: boolean,
  remote_diagnostics_enabled?: boolean,
  pin_protected_uninstall?: boolean,
  connection_method?: string,
  filtering_method?: string,
  fail_over_method?: string,
  enable_cybersight?: boolean,
  enable_browser_extension?: boolean,
  url_filtering?: boolean,
  ip_filtering?: boolean,
  privacy_mode?: string,
  diagnostics_level?: string,
  agent_shield_state?: string
}[]

update

organizations.update Update an organization Risk: write

await corsair.dnsfilter.api.organizations.update({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`organization`	`object`	Yes	—

organization full type

{
  name: string,
  billing_contact_name?: string,
  billing_contact_phone?: string,
  billing_contact_email?: string,
  address?: string,
  managed_by_msp_id: number,
  unique_id?: string,
  sku?: string,
  quantity?: number,
  vpn_settings_organization_attributes?: {
    id?: number,
    vpn_settings_state_type_id?: number,
    _destroy?: boolean
  },
  privacy_mode?: inherit | standard | identify_devices | maximum,
  enable_cybersight?: boolean
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    id?: number,
    address?: string,
    allow_create_network?: boolean,
    allowlist_updated_at?: string,
    billing_address?: string,
    billing_contact_email?: string,
    billing_contact_name?: string,
    billing_contact_phone?: string,
    billing_manual?: boolean,
    blocklist_updated_at?: string,
    canceled?: boolean,
    canceled_at?: string,
    external_id?: string,
    feature_flags?: string[],
    fetched_onboard_details?: boolean,
    first_traffic_sent?: string,
    industry?: string,
    managed_by_msp_id?: number,
    metadata?: {
    },
    msp_feature_flags?: string[],
    name?: string,
    owned_msp_id?: number,
    plan_details?: string,
    release_channel?: string,
    role?: string,
    send_uninstall_notifications_to_admin_users?: boolean,
    sso_enabled?: boolean,
    stripe_customer_id?: string,
    summary_email_address?: string,
    summary_email_enabled?: boolean,
    sync_tools_auto_update?: boolean,
    trial_days?: number,
    unbounce_data?: string,
    unique_id?: string,
    update_payment?: boolean,
    usage_alert_cents?: string,
    user_agent_uninstall_notification?: boolean,
    user_agent_uninstall_notification_recipient_emails?: string[],
    user_agents_auto_update?: boolean,
    will_cancel_at?: string,
    active_psa_integration?: boolean,
    segment?: string,
    vpn_settings_organization?: {
      vpn_settings_state_type_id?: number
    }
  },
  relationships?: {
    networks?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    }
  }
}

Organization Users

create

organizationUsers.create Create an organization user Risk: write

await corsair.dnsfilter.api.organizationUsers.create({});

Input

Name	Type	Required	Description
`organization_id`	`number`	Yes	—
`user`	`object`	Yes	—

user full type

{
  email?: string,
  first_name?: string,
  last_name?: string,
  phone?: string,
  role?: string,
  organization_permission_ids?: number[],
  is_include_only_list?: boolean
}

Output

Name	Type	Required	Description
`user`	`object`	No	—

user full type

{
  id?: number,
  email?: string,
  auth0_sub?: string,
  first_name?: string,
  last_name?: string,
  phone?: string,
  email_verified?: boolean,
  role?: string,
  organization_permission_ids?: number[],
  is_include_only_list?: boolean,
  mfa_enabled?: boolean
}

delete

organizationUsers.delete Delete an organization user Risk: destructive · Irreversible

await corsair.dnsfilter.api.organizationUsers.delete({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`organization_id`	`number`	Yes	—

Output: undefined

get

organizationUsers.get Get an organization user Risk: read

await corsair.dnsfilter.api.organizationUsers.get({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`organization_id`	`number`	Yes	—
`include_auth_providers`	`boolean`	No	—

Output

Name	Type	Required	Description
`user`	`object`	No	—

user full type

{
  id?: number,
  email?: string,
  auth0_sub?: string,
  first_name?: string,
  last_name?: string,
  phone?: string,
  email_verified?: boolean,
  role?: string,
  organization_permission_ids?: number[],
  is_include_only_list?: boolean,
  mfa_enabled?: boolean
}

list

organizationUsers.list List organization users Risk: read

await corsair.dnsfilter.api.organizationUsers.list({});

Input

Name	Type	Required	Description
`organization_id`	`number`	Yes	—
`include_auth_providers`	`boolean`	No	—

Output

Name	Type	Required	Description
`users`	`object[]`	No	—

users full type

{
  id?: number,
  email?: string,
  auth0_sub?: string,
  first_name?: string,
  last_name?: string,
  phone?: string,
  email_verified?: boolean,
  role?: string,
  organization_permission_ids?: number[],
  is_include_only_list?: boolean,
  mfa_enabled?: boolean
}[]

resendInvite

organizationUsers.resendInvite Resend invite for organization users Risk: write

await corsair.dnsfilter.api.organizationUsers.resendInvite({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`organization_id`	`number`	Yes	—

Output: undefined

update

organizationUsers.update Update an organization user Risk: write

await corsair.dnsfilter.api.organizationUsers.update({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`organization_id`	`number`	Yes	—
`user`	`object`	Yes	—

user full type

{
  email?: string,
  first_name?: string,
  last_name?: string,
  phone?: string,
  role?: string,
  organization_permission_ids?: number[],
  is_include_only_list?: boolean
}

Output

Name	Type	Required	Description
`user`	`object`	No	—

user full type

{
  id?: number,
  email?: string,
  auth0_sub?: string,
  first_name?: string,
  last_name?: string,
  phone?: string,
  email_verified?: boolean,
  role?: string,
  organization_permission_ids?: number[],
  is_include_only_list?: boolean,
  mfa_enabled?: boolean
}

Policies

addAllowedApplication

policies.addAllowedApplication Add allowed application for policies Risk: write

await corsair.dnsfilter.api.policies.addAllowedApplication({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`name`	`string`	Yes	—
`include_relationships`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    organization_id?: number,
    whitelist_domains?: string[],
    blacklist_domains?: string[],
    blacklist_categories?: number[],
    allow_unknown_domains?: boolean,
    google_safesearch?: boolean,
    bing_safe_search?: boolean,
    duck_duck_go_safe_search?: boolean,
    ecosia_safesearch?: boolean,
    yandex_safe_search?: boolean,
    youtube_restricted?: boolean,
    youtube_restricted_level?: strict | none | string,
    interstitial?: boolean,
    is_global_policy?: boolean,
    can_edit?: boolean,
    lock_version?: number,
    allow_list_only?: boolean
  },
  relationships?: {
    organization?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    network_policies?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    },
    networks?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    }
  }
}

addBlacklistCategory

policies.addBlacklistCategory Add blacklist category for policies Risk: write

await corsair.dnsfilter.api.policies.addBlacklistCategory({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`category_id`	`number`	Yes	—
`include_relationships`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    organization_id?: number,
    whitelist_domains?: string[],
    blacklist_domains?: string[],
    blacklist_categories?: number[],
    allow_unknown_domains?: boolean,
    google_safesearch?: boolean,
    bing_safe_search?: boolean,
    duck_duck_go_safe_search?: boolean,
    ecosia_safesearch?: boolean,
    yandex_safe_search?: boolean,
    youtube_restricted?: boolean,
    youtube_restricted_level?: strict | none | string,
    interstitial?: boolean,
    is_global_policy?: boolean,
    can_edit?: boolean,
    lock_version?: number,
    allow_list_only?: boolean
  },
  relationships?: {
    organization?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    network_policies?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    },
    networks?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    }
  }
}

addBlacklistDomain

policies.addBlacklistDomain Add blacklist domain for policies Risk: write

await corsair.dnsfilter.api.policies.addBlacklistDomain({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`domain`	`string`	Yes	—
`note`	`string`	Yes	—
`include_relationships`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    organization_id?: number,
    whitelist_domains?: string[],
    blacklist_domains?: string[],
    blacklist_categories?: number[],
    allow_unknown_domains?: boolean,
    google_safesearch?: boolean,
    bing_safe_search?: boolean,
    duck_duck_go_safe_search?: boolean,
    ecosia_safesearch?: boolean,
    yandex_safe_search?: boolean,
    youtube_restricted?: boolean,
    youtube_restricted_level?: strict | none | string,
    interstitial?: boolean,
    is_global_policy?: boolean,
    can_edit?: boolean,
    lock_version?: number,
    allow_list_only?: boolean
  },
  relationships?: {
    organization?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    network_policies?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    },
    networks?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    }
  }
}

addBlockedApplication

policies.addBlockedApplication Add blocked application for policies Risk: write

await corsair.dnsfilter.api.policies.addBlockedApplication({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`name`	`string`	Yes	—
`include_relationships`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    organization_id?: number,
    whitelist_domains?: string[],
    blacklist_domains?: string[],
    blacklist_categories?: number[],
    allow_unknown_domains?: boolean,
    google_safesearch?: boolean,
    bing_safe_search?: boolean,
    duck_duck_go_safe_search?: boolean,
    ecosia_safesearch?: boolean,
    yandex_safe_search?: boolean,
    youtube_restricted?: boolean,
    youtube_restricted_level?: strict | none | string,
    interstitial?: boolean,
    is_global_policy?: boolean,
    can_edit?: boolean,
    lock_version?: number,
    allow_list_only?: boolean
  },
  relationships?: {
    organization?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    network_policies?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    },
    networks?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    }
  }
}

addWhitelistDomain

policies.addWhitelistDomain Add whitelist domain for policies Risk: write

await corsair.dnsfilter.api.policies.addWhitelistDomain({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`domain`	`string`	Yes	—
`note`	`string`	Yes	—
`include_relationships`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    organization_id?: number,
    whitelist_domains?: string[],
    blacklist_domains?: string[],
    blacklist_categories?: number[],
    allow_unknown_domains?: boolean,
    google_safesearch?: boolean,
    bing_safe_search?: boolean,
    duck_duck_go_safe_search?: boolean,
    ecosia_safesearch?: boolean,
    yandex_safe_search?: boolean,
    youtube_restricted?: boolean,
    youtube_restricted_level?: strict | none | string,
    interstitial?: boolean,
    is_global_policy?: boolean,
    can_edit?: boolean,
    lock_version?: number,
    allow_list_only?: boolean
  },
  relationships?: {
    organization?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    network_policies?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    },
    networks?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    }
  }
}

application

policies.application Application for policies Risk: read

await corsair.dnsfilter.api.policies.application({});

Input

Name	Type	Required	Description
`application_id`	`number`	Yes	—
`name`	`string`	No	—
`organization_id`	`number`	Yes	—
`policy_ids`	`number[]`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  application?: {
    name?: string,
    display_name?: string,
    description?: string,
    home_page_url?: string,
    favicon?: string,
    icon?: string
  },
  organization?: {
    id?: number,
    address?: string,
    allow_create_network?: boolean,
    allowlist_updated_at?: string,
    billing_address?: string,
    billing_contact_email?: string,
    billing_contact_name?: string,
    billing_contact_phone?: string,
    billing_manual?: boolean,
    blocklist_updated_at?: string,
    canceled?: boolean,
    canceled_at?: string,
    external_id?: string,
    feature_flags?: string[],
    fetched_onboard_details?: boolean,
    first_traffic_sent?: string,
    industry?: string,
    managed_by_msp_id?: number,
    metadata?: {
    },
    msp_feature_flags?: string[],
    name?: string,
    owned_msp_id?: number,
    plan_details?: string,
    release_channel?: string,
    role?: string,
    send_uninstall_notifications_to_admin_users?: boolean,
    sso_enabled?: boolean,
    stripe_customer_id?: string,
    summary_email_address?: string,
    summary_email_enabled?: boolean,
    sync_tools_auto_update?: boolean,
    trial_days?: number,
    unbounce_data?: string,
    unique_id?: string,
    update_payment?: boolean,
    usage_alert_cents?: string,
    user_agent_uninstall_notification?: boolean,
    user_agent_uninstall_notification_recipient_emails?: string[],
    user_agents_auto_update?: boolean,
    will_cancel_at?: string,
    active_psa_integration?: boolean,
    segment?: string,
    vpn_settings_organization?: {
      vpn_settings_state_type_id?: number
    }
  },
  allow_policies?: {
    id?: string,
    type?: string,
    uuid?: string,
    attributes?: {
      name?: string,
      organization_id?: number,
      whitelist_domains?: string[],
      blacklist_domains?: string[],
      blacklist_categories?: number[],
      allow_unknown_domains?: boolean,
      google_safesearch?: boolean,
      bing_safe_search?: boolean,
      duck_duck_go_safe_search?: boolean,
      ecosia_safesearch?: boolean,
      yandex_safe_search?: boolean,
      youtube_restricted?: boolean,
      youtube_restricted_level?: strict | none | string,
      interstitial?: boolean,
      is_global_policy?: boolean,
      can_edit?: boolean,
      lock_version?: number,
      allow_list_only?: boolean
    },
    relationships?: {
      organization?: {
        data?: {
          id?: string,
          type?: string,
          uuid?: string
        }
      },
      network_policies?: {
        data?: {
          id?: string,
          type?: string,
          uuid?: string
        }[]
      },
      networks?: {
        data?: {
          id?: string,
          type?: string,
          uuid?: string
        }[]
      }
    }
  }[],
  block_policies?: {
    id?: string,
    type?: string,
    uuid?: string,
    attributes?: {
      name?: string,
      organization_id?: number,
      whitelist_domains?: string[],
      blacklist_domains?: string[],
      blacklist_categories?: number[],
      allow_unknown_domains?: boolean,
      google_safesearch?: boolean,
      bing_safe_search?: boolean,
      duck_duck_go_safe_search?: boolean,
      ecosia_safesearch?: boolean,
      yandex_safe_search?: boolean,
      youtube_restricted?: boolean,
      youtube_restricted_level?: strict | none | string,
      interstitial?: boolean,
      is_global_policy?: boolean,
      can_edit?: boolean,
      lock_version?: number,
      allow_list_only?: boolean
    },
    relationships?: {
      organization?: {
        data?: {
          id?: string,
          type?: string,
          uuid?: string
        }
      },
      network_policies?: {
        data?: {
          id?: string,
          type?: string,
          uuid?: string
        }[]
      },
      networks?: {
        data?: {
          id?: string,
          type?: string,
          uuid?: string
        }[]
      }
    }
  }[]
}

applicationUpdate

policies.applicationUpdate Application update for policies Risk: write

await corsair.dnsfilter.api.policies.applicationUpdate({});

Input

Name	Type	Required	Description
`allow_policies`	`number[]`	Yes	—
`application_id`	`number`	Yes	—
`block_policies`	`number[]`	Yes	—
`organization_id`	`number`	Yes	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  application?: {
    name?: string,
    display_name?: string,
    description?: string,
    home_page_url?: string,
    favicon?: string,
    icon?: string
  },
  organization?: {
    id?: number,
    address?: string,
    allow_create_network?: boolean,
    allowlist_updated_at?: string,
    billing_address?: string,
    billing_contact_email?: string,
    billing_contact_name?: string,
    billing_contact_phone?: string,
    billing_manual?: boolean,
    blocklist_updated_at?: string,
    canceled?: boolean,
    canceled_at?: string,
    external_id?: string,
    feature_flags?: string[],
    fetched_onboard_details?: boolean,
    first_traffic_sent?: string,
    industry?: string,
    managed_by_msp_id?: number,
    metadata?: {
    },
    msp_feature_flags?: string[],
    name?: string,
    owned_msp_id?: number,
    plan_details?: string,
    release_channel?: string,
    role?: string,
    send_uninstall_notifications_to_admin_users?: boolean,
    sso_enabled?: boolean,
    stripe_customer_id?: string,
    summary_email_address?: string,
    summary_email_enabled?: boolean,
    sync_tools_auto_update?: boolean,
    trial_days?: number,
    unbounce_data?: string,
    unique_id?: string,
    update_payment?: boolean,
    usage_alert_cents?: string,
    user_agent_uninstall_notification?: boolean,
    user_agent_uninstall_notification_recipient_emails?: string[],
    user_agents_auto_update?: boolean,
    will_cancel_at?: string,
    active_psa_integration?: boolean,
    segment?: string,
    vpn_settings_organization?: {
      vpn_settings_state_type_id?: number
    }
  },
  allow_policies?: {
    id?: string,
    type?: string,
    uuid?: string,
    attributes?: {
      name?: string,
      organization_id?: number,
      whitelist_domains?: string[],
      blacklist_domains?: string[],
      blacklist_categories?: number[],
      allow_unknown_domains?: boolean,
      google_safesearch?: boolean,
      bing_safe_search?: boolean,
      duck_duck_go_safe_search?: boolean,
      ecosia_safesearch?: boolean,
      yandex_safe_search?: boolean,
      youtube_restricted?: boolean,
      youtube_restricted_level?: strict | none | string,
      interstitial?: boolean,
      is_global_policy?: boolean,
      can_edit?: boolean,
      lock_version?: number,
      allow_list_only?: boolean
    },
    relationships?: {
      organization?: {
        data?: {
          id?: string,
          type?: string,
          uuid?: string
        }
      },
      network_policies?: {
        data?: {
          id?: string,
          type?: string,
          uuid?: string
        }[]
      },
      networks?: {
        data?: {
          id?: string,
          type?: string,
          uuid?: string
        }[]
      }
    }
  }[],
  block_policies?: {
    id?: string,
    type?: string,
    uuid?: string,
    attributes?: {
      name?: string,
      organization_id?: number,
      whitelist_domains?: string[],
      blacklist_domains?: string[],
      blacklist_categories?: number[],
      allow_unknown_domains?: boolean,
      google_safesearch?: boolean,
      bing_safe_search?: boolean,
      duck_duck_go_safe_search?: boolean,
      ecosia_safesearch?: boolean,
      yandex_safe_search?: boolean,
      youtube_restricted?: boolean,
      youtube_restricted_level?: strict | none | string,
      interstitial?: boolean,
      is_global_policy?: boolean,
      can_edit?: boolean,
      lock_version?: number,
      allow_list_only?: boolean
    },
    relationships?: {
      organization?: {
        data?: {
          id?: string,
          type?: string,
          uuid?: string
        }
      },
      network_policies?: {
        data?: {
          id?: string,
          type?: string,
          uuid?: string
        }[]
      },
      networks?: {
        data?: {
          id?: string,
          type?: string,
          uuid?: string
        }[]
      }
    }
  }[]
}

create

policies.create Create a policy Risk: write

await corsair.dnsfilter.api.policies.create({});

Input

Name	Type	Required	Description
`policy`	`object`	Yes	—
`include_relationships`	`boolean`	No	—
`append_domains`	`boolean`	No	—

policy full type

{
  name: string,
  organization_id: number,
  allow_unknown_domains?: boolean,
  google_safesearch?: boolean,
  bing_safe_search?: boolean,
  duck_duck_go_safe_search?: boolean,
  ecosia_safesearch?: boolean,
  youtube_restricted?: boolean,
  youtube_restricted_level?: strict | none,
  interstitial?: boolean,
  policy_ip_id?: number,
  whitelist_domains?: string[],
  blacklist_domains?: string[],
  blacklist_categories?: number[],
  is_global_policy?: boolean,
  allow_applications?: string[],
  block_applications?: string[],
  lock_version?: number,
  yandex_safe_search?: boolean,
  allow_list_only?: boolean
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    organization_id?: number,
    whitelist_domains?: string[],
    blacklist_domains?: string[],
    blacklist_categories?: number[],
    allow_unknown_domains?: boolean,
    google_safesearch?: boolean,
    bing_safe_search?: boolean,
    duck_duck_go_safe_search?: boolean,
    ecosia_safesearch?: boolean,
    yandex_safe_search?: boolean,
    youtube_restricted?: boolean,
    youtube_restricted_level?: strict | none | string,
    interstitial?: boolean,
    is_global_policy?: boolean,
    can_edit?: boolean,
    lock_version?: number,
    allow_list_only?: boolean
  },
  relationships?: {
    organization?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    network_policies?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    },
    networks?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    }
  }
}

delete

policies.delete Delete a policy Risk: destructive · Irreversible

await corsair.dnsfilter.api.policies.delete({});

Input

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

Output: undefined

get

policies.get Get a policy Risk: read

await corsair.dnsfilter.api.policies.get({ id: 321 });

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`include_relationships`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    organization_id?: number,
    whitelist_domains?: string[],
    blacklist_domains?: string[],
    blacklist_categories?: number[],
    allow_unknown_domains?: boolean,
    google_safesearch?: boolean,
    bing_safe_search?: boolean,
    duck_duck_go_safe_search?: boolean,
    ecosia_safesearch?: boolean,
    yandex_safe_search?: boolean,
    youtube_restricted?: boolean,
    youtube_restricted_level?: strict | none | string,
    interstitial?: boolean,
    is_global_policy?: boolean,
    can_edit?: boolean,
    lock_version?: number,
    allow_list_only?: boolean
  },
  relationships?: {
    organization?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    network_policies?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    },
    networks?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    }
  }
}

getPermissiveMode

policies.getPermissiveMode Get permissive mode for policies Risk: read

await corsair.dnsfilter.api.policies.getPermissiveMode({});

Input

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

Output

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

list

policies.list List policies Risk: read

await corsair.dnsfilter.api.policies.list({
	page: { number: 1, size: 25 },
});

Input

Name	Type	Required	Description
`include_global_policies`	`boolean`	No	—
`organization_id`	`number`	No	—
`page`	`object`	No	—

page full type

{
  number?: number,
  size?: number
}

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`links`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    organization_id?: number,
    whitelist_domains?: string[],
    blacklist_domains?: string[],
    blacklist_categories?: number[],
    allow_unknown_domains?: boolean,
    google_safesearch?: boolean,
    bing_safe_search?: boolean,
    duck_duck_go_safe_search?: boolean,
    ecosia_safesearch?: boolean,
    yandex_safe_search?: boolean,
    youtube_restricted?: boolean,
    youtube_restricted_level?: strict | none | string,
    interstitial?: boolean,
    is_global_policy?: boolean,
    can_edit?: boolean,
    lock_version?: number,
    allow_list_only?: boolean
  },
  relationships?: {
    organization?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    network_policies?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    },
    networks?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    }
  }
}[]

links full type

{
  self?: string,
  first?: string,
  prev?: string,
  next?: string,
  last?: string
}

listAll

policies.listAll List all policies Risk: read

await corsair.dnsfilter.api.policies.listAll({});

Input

Name	Type	Required	Description
`include_global_policies`	`boolean`	No	—
`organization_id`	`number`	No	—
`page`	`object`	No	—

page full type

{
  number?: number,
  size?: number
}

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`links`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    organization_id?: number,
    whitelist_domains?: string[],
    blacklist_domains?: string[],
    blacklist_categories?: number[],
    allow_unknown_domains?: boolean,
    google_safesearch?: boolean,
    bing_safe_search?: boolean,
    duck_duck_go_safe_search?: boolean,
    ecosia_safesearch?: boolean,
    yandex_safe_search?: boolean,
    youtube_restricted?: boolean,
    youtube_restricted_level?: strict | none | string,
    interstitial?: boolean,
    is_global_policy?: boolean,
    can_edit?: boolean,
    lock_version?: number,
    allow_list_only?: boolean
  },
  relationships?: {
    organization?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    network_policies?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    },
    networks?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    }
  }
}[]

links full type

{
  self?: string,
  first?: string,
  prev?: string,
  next?: string,
  last?: string
}

removeAllowedApplication

policies.removeAllowedApplication Remove allowed application for policies Risk: write

await corsair.dnsfilter.api.policies.removeAllowedApplication({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`name`	`string`	Yes	—
`include_relationships`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    organization_id?: number,
    whitelist_domains?: string[],
    blacklist_domains?: string[],
    blacklist_categories?: number[],
    allow_unknown_domains?: boolean,
    google_safesearch?: boolean,
    bing_safe_search?: boolean,
    duck_duck_go_safe_search?: boolean,
    ecosia_safesearch?: boolean,
    yandex_safe_search?: boolean,
    youtube_restricted?: boolean,
    youtube_restricted_level?: strict | none | string,
    interstitial?: boolean,
    is_global_policy?: boolean,
    can_edit?: boolean,
    lock_version?: number,
    allow_list_only?: boolean
  },
  relationships?: {
    organization?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    network_policies?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    },
    networks?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    }
  }
}

removeBlacklistCategory

policies.removeBlacklistCategory Remove blacklist category for policies Risk: write

await corsair.dnsfilter.api.policies.removeBlacklistCategory({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`category_id`	`number`	Yes	—
`include_relationships`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    organization_id?: number,
    whitelist_domains?: string[],
    blacklist_domains?: string[],
    blacklist_categories?: number[],
    allow_unknown_domains?: boolean,
    google_safesearch?: boolean,
    bing_safe_search?: boolean,
    duck_duck_go_safe_search?: boolean,
    ecosia_safesearch?: boolean,
    yandex_safe_search?: boolean,
    youtube_restricted?: boolean,
    youtube_restricted_level?: strict | none | string,
    interstitial?: boolean,
    is_global_policy?: boolean,
    can_edit?: boolean,
    lock_version?: number,
    allow_list_only?: boolean
  },
  relationships?: {
    organization?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    network_policies?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    },
    networks?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    }
  }
}

removeBlacklistDomain

policies.removeBlacklistDomain Remove blacklist domain for policies Risk: write

await corsair.dnsfilter.api.policies.removeBlacklistDomain({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`domain`	`string`	Yes	—
`note`	`string`	Yes	—
`include_relationships`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    organization_id?: number,
    whitelist_domains?: string[],
    blacklist_domains?: string[],
    blacklist_categories?: number[],
    allow_unknown_domains?: boolean,
    google_safesearch?: boolean,
    bing_safe_search?: boolean,
    duck_duck_go_safe_search?: boolean,
    ecosia_safesearch?: boolean,
    yandex_safe_search?: boolean,
    youtube_restricted?: boolean,
    youtube_restricted_level?: strict | none | string,
    interstitial?: boolean,
    is_global_policy?: boolean,
    can_edit?: boolean,
    lock_version?: number,
    allow_list_only?: boolean
  },
  relationships?: {
    organization?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    network_policies?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    },
    networks?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    }
  }
}

removeBlockedApplication

policies.removeBlockedApplication Remove blocked application for policies Risk: write

await corsair.dnsfilter.api.policies.removeBlockedApplication({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`name`	`string`	Yes	—
`include_relationships`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    organization_id?: number,
    whitelist_domains?: string[],
    blacklist_domains?: string[],
    blacklist_categories?: number[],
    allow_unknown_domains?: boolean,
    google_safesearch?: boolean,
    bing_safe_search?: boolean,
    duck_duck_go_safe_search?: boolean,
    ecosia_safesearch?: boolean,
    yandex_safe_search?: boolean,
    youtube_restricted?: boolean,
    youtube_restricted_level?: strict | none | string,
    interstitial?: boolean,
    is_global_policy?: boolean,
    can_edit?: boolean,
    lock_version?: number,
    allow_list_only?: boolean
  },
  relationships?: {
    organization?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    network_policies?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    },
    networks?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    }
  }
}

removeWhitelistDomain

policies.removeWhitelistDomain Remove whitelist domain for policies Risk: write

await corsair.dnsfilter.api.policies.removeWhitelistDomain({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`domain`	`string`	Yes	—
`note`	`string`	Yes	—
`include_relationships`	`boolean`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    organization_id?: number,
    whitelist_domains?: string[],
    blacklist_domains?: string[],
    blacklist_categories?: number[],
    allow_unknown_domains?: boolean,
    google_safesearch?: boolean,
    bing_safe_search?: boolean,
    duck_duck_go_safe_search?: boolean,
    ecosia_safesearch?: boolean,
    yandex_safe_search?: boolean,
    youtube_restricted?: boolean,
    youtube_restricted_level?: strict | none | string,
    interstitial?: boolean,
    is_global_policy?: boolean,
    can_edit?: boolean,
    lock_version?: number,
    allow_list_only?: boolean
  },
  relationships?: {
    organization?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    network_policies?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    },
    networks?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    }
  }
}

update

policies.update Update a policy Risk: write

await corsair.dnsfilter.api.policies.update({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`policy`	`object`	Yes	—
`include_relationships`	`boolean`	No	—
`append_domains`	`boolean`	No	—

policy full type

{
  name: string,
  organization_id: number,
  allow_unknown_domains?: boolean,
  google_safesearch?: boolean,
  bing_safe_search?: boolean,
  duck_duck_go_safe_search?: boolean,
  ecosia_safesearch?: boolean,
  youtube_restricted?: boolean,
  youtube_restricted_level?: strict | none,
  interstitial?: boolean,
  policy_ip_id?: number,
  whitelist_domains?: string[],
  blacklist_domains?: string[],
  blacklist_categories?: number[],
  is_global_policy?: boolean,
  allow_applications?: string[],
  block_applications?: string[],
  lock_version?: number,
  yandex_safe_search?: boolean,
  allow_list_only?: boolean
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    organization_id?: number,
    whitelist_domains?: string[],
    blacklist_domains?: string[],
    blacklist_categories?: number[],
    allow_unknown_domains?: boolean,
    google_safesearch?: boolean,
    bing_safe_search?: boolean,
    duck_duck_go_safe_search?: boolean,
    ecosia_safesearch?: boolean,
    yandex_safe_search?: boolean,
    youtube_restricted?: boolean,
    youtube_restricted_level?: strict | none | string,
    interstitial?: boolean,
    is_global_policy?: boolean,
    can_edit?: boolean,
    lock_version?: number,
    allow_list_only?: boolean
  },
  relationships?: {
    organization?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    network_policies?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    },
    networks?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }[]
    }
  }
}

updatePermissiveMode

policies.updatePermissiveMode Update permissive mode for policies Risk: write

await corsair.dnsfilter.api.policies.updatePermissiveMode({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`permissive_mode`	`boolean`	Yes	—

Output

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

Policies Bulk Actions

addAllowlistDomains

policiesBulkActions.addAllowlistDomains Add allowlist domains for policies bulk actions Risk: write

await corsair.dnsfilter.api.policiesBulkActions.addAllowlistDomains({});

Input

Name	Type	Required	Description
`domains`	`string[]`	No	—
`notes`	`object`	No	—
`policy_ids`	`number[]`	No	—

notes full type

{
  string?: string
}

Output

Name	Type	Required	Description
`success`	`number[]`	No	—
`failure`	`number[]`	No	—
`noop`	`number[]`	No	—

addBlocklistDomains

policiesBulkActions.addBlocklistDomains Add blocklist domains for policies bulk actions Risk: write

await corsair.dnsfilter.api.policiesBulkActions.addBlocklistDomains({});

Input

Name	Type	Required	Description
`domains`	`string[]`	No	—
`notes`	`object`	No	—
`policy_ids`	`number[]`	No	—

notes full type

{
  string?: string
}

Output

Name	Type	Required	Description
`success`	`number[]`	No	—
`failure`	`number[]`	No	—
`noop`	`number[]`	No	—

removeAllowlistDomains

policiesBulkActions.removeAllowlistDomains Remove allowlist domains for policies bulk actions Risk: write

await corsair.dnsfilter.api.policiesBulkActions.removeAllowlistDomains({});

Input

Name	Type	Required	Description
`domains`	`string[]`	No	—
`notes`	`object`	No	—
`policy_ids`	`number[]`	No	—

notes full type

{
  string?: string
}

Output

Name	Type	Required	Description
`success`	`number[]`	No	—
`failure`	`number[]`	No	—
`noop`	`number[]`	No	—

removeBlocklistDomains

policiesBulkActions.removeBlocklistDomains Remove blocklist domains for policies bulk actions Risk: write

await corsair.dnsfilter.api.policiesBulkActions.removeBlocklistDomains({});

Input

Name	Type	Required	Description
`domains`	`string[]`	No	—
`notes`	`object`	No	—
`policy_ids`	`number[]`	No	—

notes full type

{
  string?: string
}

Output

Name	Type	Required	Description
`success`	`number[]`	No	—
`failure`	`number[]`	No	—
`noop`	`number[]`	No	—

Policy Ips

get

policyIps.get Get a policy IP Risk: read

await corsair.dnsfilter.api.policyIps.get({});

Input

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

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    friendly_id?: number,
    primary_address?: string,
    secondary_address?: string
  }
}

list

policyIps.list List policy IPs Risk: read

await corsair.dnsfilter.api.policyIps.list({});

Input: empty object Output

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

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    friendly_id?: number,
    primary_address?: string,
    secondary_address?: string
  }
}[]

Psa Integrations

redirectLink

psaIntegrations.redirectLink Redirect link for PSA integrations Risk: read

await corsair.dnsfilter.api.psaIntegrations.redirectLink({});

Input

Name	Type	Required	Description
`organization_id`	`number`	No	—
`psa_name`	`string`	No	—

Output: string

Scheduled Policies

create

scheduledPolicies.create Create a scheduled policy Risk: write

await corsair.dnsfilter.api.scheduledPolicies.create({});

Input

Name	Type	Required	Description
`name`	`string`	No	—
`organization_id`	`number`	No	—
`policy_ids`	`number[]`	No	—
`timezone`	`string`	No	—

Output

Name	Type	Required	Description
`name`	`string`	No	—
`organization_id`	`number`	No	—
`policy_ids`	`number[]`	No	—
`timezone`	`string`	No	—

delete

scheduledPolicies.delete Delete a scheduled policy Risk: destructive · Irreversible

await corsair.dnsfilter.api.scheduledPolicies.delete({});

Input

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

Output: undefined

get

scheduledPolicies.get Get a scheduled policy Risk: read

await corsair.dnsfilter.api.scheduledPolicies.get({});

Input

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

Output

Name	Type	Required	Description
`name`	`string`	No	—
`organization_id`	`number`	No	—
`policy_ids`	`number[]`	No	—
`timezone`	`string`	No	—

list

scheduledPolicies.list List scheduled policies Risk: read

await corsair.dnsfilter.api.scheduledPolicies.list({});

Input

Name	Type	Required	Description
`page`	`object`	No	—

page full type

{
  number?: number,
  size?: number
}

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`links`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    organization_id?: number,
    policy_ids?: number[],
    timezone?: string
  }
}[]

links full type

{
  self?: string,
  first?: string,
  prev?: string,
  next?: string,
  last?: string
}

listAll

scheduledPolicies.listAll List all scheduled policies Risk: read

await corsair.dnsfilter.api.scheduledPolicies.listAll({});

Input

Name	Type	Required	Description
`page`	`object`	No	—

page full type

{
  number?: number,
  size?: number
}

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`links`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    organization_id?: number,
    policy_ids?: number[],
    timezone?: string
  }
}[]

links full type

{
  self?: string,
  first?: string,
  prev?: string,
  next?: string,
  last?: string
}

update

scheduledPolicies.update Update a scheduled policy Risk: write

await corsair.dnsfilter.api.scheduledPolicies.update({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`name`	`string`	No	—
`organization_id`	`number`	No	—
`policy_ids`	`number[]`	No	—
`timezone`	`string`	No	—

Output

Name	Type	Required	Description
`name`	`string`	No	—
`organization_id`	`number`	No	—
`policy_ids`	`number[]`	No	—
`timezone`	`string`	No	—

Scheduled Report Previews

create

scheduledReportPreviews.create Create a scheduled report preview Risk: write

await corsair.dnsfilter.api.scheduledReportPreviews.create({});

Input

Name	Type	Required	Description
`scheduled_report_preview`	`object`	No	—

scheduled_report_preview full type

{
  organization_id?: number,
  include_threat_summary?: boolean,
  include_content_category_summary?: boolean,
  content_categories_show_count?: all_categories | top5 | top10 | top15
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    organization_id?: number,
    include_threat_summary?: boolean,
    include_content_category_summary?: boolean,
    content_categories_show_count?: all_categories | top5 | top10 | top15 | string,
    url?: string
  }
}

get

scheduledReportPreviews.get Get a scheduled report preview Risk: read

await corsair.dnsfilter.api.scheduledReportPreviews.get({});

Input

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

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    organization_id?: number,
    include_threat_summary?: boolean,
    include_content_category_summary?: boolean,
    content_categories_show_count?: all_categories | top5 | top10 | top15 | string,
    url?: string
  }
}

Scheduled Reports

create

scheduledReports.create Create a scheduled report Risk: write

await corsair.dnsfilter.api.scheduledReports.create({});

Input

Name	Type	Required	Description
`scheduled_report`	`object`	No	—

scheduled_report full type

{
  organization_id?: number,
  frequency?: monthly | bi_weekly | weekly,
  day_of_week?: sunday | monday | tuesday | wednesday | thursday | friday | saturday,
  include_threat_summary?: boolean,
  include_content_category_summary?: boolean,
  content_categories_show_count?: all_categories | top5 | top10 | top15,
  send_to_dashboard_users?: boolean,
  scheduled_report_recipients?: {
    email?: string,
    organization?: {
      id?: string,
      name?: string
    }
  }[],
  selected_sub_orgs?: number[]
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    organization_id?: number,
    frequency?: monthly | bi_weekly | weekly | string,
    day_of_week?: sunday | monday | tuesday | wednesday | thursday | friday | saturday | string,
    include_threat_summary?: boolean,
    include_content_category_summary?: boolean,
    content_categories_show_count?: all_categories | top5 | top10 | top15 | string,
    send_to_dashboard_users?: boolean,
    scheduled_report_recipients?: {
      email?: string,
      organization?: {
        id?: string,
        name?: string
      }
    }[],
    selected_sub_orgs?: number[]
  }
}

delete

scheduledReports.delete Delete a scheduled report Risk: destructive · Irreversible

await corsair.dnsfilter.api.scheduledReports.delete({});

Input

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

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    organization_id?: number,
    frequency?: monthly | bi_weekly | weekly | string,
    day_of_week?: sunday | monday | tuesday | wednesday | thursday | friday | saturday | string,
    include_threat_summary?: boolean,
    include_content_category_summary?: boolean,
    content_categories_show_count?: all_categories | top5 | top10 | top15 | string,
    send_to_dashboard_users?: boolean,
    scheduled_report_recipients?: {
      email?: string,
      organization?: {
        id?: string,
        name?: string
      }
    }[],
    selected_sub_orgs?: number[]
  }
}

get

scheduledReports.get Get a scheduled report Risk: read

await corsair.dnsfilter.api.scheduledReports.get({});

Input

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

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    organization_id?: number,
    frequency?: monthly | bi_weekly | weekly | string,
    day_of_week?: sunday | monday | tuesday | wednesday | thursday | friday | saturday | string,
    include_threat_summary?: boolean,
    include_content_category_summary?: boolean,
    content_categories_show_count?: all_categories | top5 | top10 | top15 | string,
    send_to_dashboard_users?: boolean,
    scheduled_report_recipients?: {
      email?: string,
      organization?: {
        id?: string,
        name?: string
      }
    }[],
    selected_sub_orgs?: number[]
  }
}

list

scheduledReports.list List scheduled reports Risk: read

await corsair.dnsfilter.api.scheduledReports.list({});

Input

Name	Type	Required	Description
`organization_id`	`number`	Yes	—

Output

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

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    organization_id?: number,
    frequency?: monthly | bi_weekly | weekly | string,
    day_of_week?: sunday | monday | tuesday | wednesday | thursday | friday | saturday | string,
    include_threat_summary?: boolean,
    include_content_category_summary?: boolean,
    content_categories_show_count?: all_categories | top5 | top10 | top15 | string,
    send_to_dashboard_users?: boolean,
    scheduled_report_recipients?: {
      email?: string,
      organization?: {
        id?: string,
        name?: string
      }
    }[],
    selected_sub_orgs?: number[]
  }
}[]

update

scheduledReports.update Update a scheduled report Risk: write

await corsair.dnsfilter.api.scheduledReports.update({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`scheduled_report`	`object`	No	—

scheduled_report full type

{
  organization_id?: number,
  frequency?: monthly | bi_weekly | weekly,
  day_of_week?: sunday | monday | tuesday | wednesday | thursday | friday | saturday,
  include_threat_summary?: boolean,
  include_content_category_summary?: boolean,
  content_categories_show_count?: all_categories | top5 | top10 | top15,
  send_to_dashboard_users?: boolean,
  scheduled_report_recipients?: {
    email?: string,
    organization?: {
      id?: string,
      name?: string
    }
  }[],
  selected_sub_orgs?: number[]
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    organization_id?: number,
    frequency?: monthly | bi_weekly | weekly | string,
    day_of_week?: sunday | monday | tuesday | wednesday | thursday | friday | saturday | string,
    include_threat_summary?: boolean,
    include_content_category_summary?: boolean,
    content_categories_show_count?: all_categories | top5 | top10 | top15 | string,
    send_to_dashboard_users?: boolean,
    scheduled_report_recipients?: {
      email?: string,
      organization?: {
        id?: string,
        name?: string
      }
    }[],
    selected_sub_orgs?: number[]
  }
}

Scheduled Reports V2

bulkUpdate

scheduledReportsV2.bulkUpdate Bulk update for scheduled reports V2 Risk: write

await corsair.dnsfilter.api.scheduledReportsV2.bulkUpdate({});

Input

Name	Type	Required	Description
`msp_id`	`number`	No	—
`organization_id`	`number`	No	—
`organization_ids`	`number[]`	No	—
`search`	`string`	No	—
`status`	`string`	No	—
`ids`	`number[]`	No	—
`all`	`boolean`	No	—
`exclude_ids`	`number[]`	No	—
`active`	`boolean`	No	—

Output: object[]

Output full type

{
  id?: number,
  success?: boolean
}[]

create

scheduledReportsV2.create Create a scheduled reports V2 Risk: write

await corsair.dnsfilter.api.scheduledReportsV2.create({});

Input

Name	Type	Required	Description
`scheduled_report`	`object`	No	—

scheduled_report full type

{
  name?: string,
  organization_id?: number,
  report_type?: legacy_protection_summary_report | filter_protection_overview | cyber_sight_activity_overview | cyber_sight_timeline | cyber_sight_ai_usage | cyber_sight_threat_trends,
  frequency?: monthly | bi_weekly | weekly | daily | quarterly,
  day_of_week?: sunday | monday | tuesday | wednesday | thursday | friday | saturday,
  day_of_month?: number,
  active?: boolean,
  send_to_dashboard_users?: boolean,
  selected_sub_orgs?: number[],
  include_threat_summary?: boolean,
  include_content_category_summary?: boolean,
  content_categories_show_count?: all_categories | top5 | top10 | top15,
  scheduled_report_recipients?: {
    email?: string,
    external?: boolean,
    organization?: {
      id?: number
    }
  }[]
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: number | string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    organization?: {
      id?: number,
      name?: string
    },
    report_type?: legacy_protection_summary_report | filter_protection_overview | cyber_sight_activity_overview | cyber_sight_timeline | cyber_sight_ai_usage | cyber_sight_threat_trends | string,
    internal_recipients?: {
      id?: number,
      email?: string,
      external?: boolean,
      organization?: {
        id?: number,
        name?: string
      }
    }[],
    external_recipients?: {
      id?: number,
      email?: string,
      external?: boolean,
      organization?: {
        id?: number,
        name?: string
      }
    }[],
    recipients?: {
      id?: number,
      email?: string,
      external?: boolean,
      organization?: {
        id?: number,
        name?: string
      }
    }[],
    send_to_dashboard_users?: boolean,
    selected_sub_orgs?: number[],
    frequency?: monthly | bi_weekly | weekly | daily | quarterly | string,
    day_of_week?: sunday | monday | tuesday | wednesday | thursday | friday | saturday | string,
    day_of_month?: number,
    next_delivery?: string,
    last_delivery?: string,
    active?: boolean,
    created_at?: string,
    updated_at?: string
  }
}

delete

scheduledReportsV2.delete Delete a scheduled reports V2 Risk: destructive · Irreversible

await corsair.dnsfilter.api.scheduledReportsV2.delete({});

Input

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

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: number | string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    organization?: {
      id?: number,
      name?: string
    },
    report_type?: legacy_protection_summary_report | filter_protection_overview | cyber_sight_activity_overview | cyber_sight_timeline | cyber_sight_ai_usage | cyber_sight_threat_trends | string,
    internal_recipients?: {
      id?: number,
      email?: string,
      external?: boolean,
      organization?: {
        id?: number,
        name?: string
      }
    }[],
    external_recipients?: {
      id?: number,
      email?: string,
      external?: boolean,
      organization?: {
        id?: number,
        name?: string
      }
    }[],
    recipients?: {
      id?: number,
      email?: string,
      external?: boolean,
      organization?: {
        id?: number,
        name?: string
      }
    }[],
    send_to_dashboard_users?: boolean,
    selected_sub_orgs?: number[],
    frequency?: monthly | bi_weekly | weekly | daily | quarterly | string,
    day_of_week?: sunday | monday | tuesday | wednesday | thursday | friday | saturday | string,
    day_of_month?: number,
    next_delivery?: string,
    last_delivery?: string,
    active?: boolean,
    created_at?: string,
    updated_at?: string
  }
}

get

scheduledReportsV2.get Get a scheduled reports V2 Risk: read

await corsair.dnsfilter.api.scheduledReportsV2.get({});

Input

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

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: number | string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    organization?: {
      id?: number,
      name?: string
    },
    report_type?: legacy_protection_summary_report | filter_protection_overview | cyber_sight_activity_overview | cyber_sight_timeline | cyber_sight_ai_usage | cyber_sight_threat_trends | string,
    internal_recipients?: {
      id?: number,
      email?: string,
      external?: boolean,
      organization?: {
        id?: number,
        name?: string
      }
    }[],
    external_recipients?: {
      id?: number,
      email?: string,
      external?: boolean,
      organization?: {
        id?: number,
        name?: string
      }
    }[],
    recipients?: {
      id?: number,
      email?: string,
      external?: boolean,
      organization?: {
        id?: number,
        name?: string
      }
    }[],
    send_to_dashboard_users?: boolean,
    selected_sub_orgs?: number[],
    frequency?: monthly | bi_weekly | weekly | daily | quarterly | string,
    day_of_week?: sunday | monday | tuesday | wednesday | thursday | friday | saturday | string,
    day_of_month?: number,
    next_delivery?: string,
    last_delivery?: string,
    active?: boolean,
    created_at?: string,
    updated_at?: string
  }
}

list

scheduledReportsV2.list List scheduled reports V2 Risk: read

await corsair.dnsfilter.api.scheduledReportsV2.list({
	page: { number: 1, size: 25 },
});

Input

Name	Type	Required	Description
`active`	`string`	No	—
`msp_id`	`number`	No	—
`organization_id`	`number`	No	—
`organization_ids`	`number[]`	No	—
`page`	`object`	No	—
`search`	`string`	No	—
`sort`	`string`	No	—

page full type

{
  number?: number,
  size?: number
}

Output

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

data full type

{
  id?: number | string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    organization?: {
      id?: number,
      name?: string
    },
    report_type?: legacy_protection_summary_report | filter_protection_overview | cyber_sight_activity_overview | cyber_sight_timeline | cyber_sight_ai_usage | cyber_sight_threat_trends | string,
    recipients?: {
      id?: number,
      email?: string,
      external?: boolean,
      organization?: {
        id?: number,
        name?: string
      }
    }[],
    recipient_count?: number,
    send_to_dashboard_users?: boolean,
    frequency?: monthly | bi_weekly | weekly | daily | quarterly | string,
    day_of_week?: sunday | monday | tuesday | wednesday | thursday | friday | saturday | string,
    day_of_month?: number,
    next_delivery?: string,
    last_delivery?: string,
    active?: boolean
  }
}[]

meta full type

{
  total_count?: number,
  total_pages?: number,
  current_page?: number
}

update

scheduledReportsV2.update Update a scheduled reports V2 Risk: write

await corsair.dnsfilter.api.scheduledReportsV2.update({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`scheduled_report`	`object`	No	—

scheduled_report full type

{
  name?: string,
  organization_id?: number,
  report_type?: legacy_protection_summary_report | filter_protection_overview | cyber_sight_activity_overview | cyber_sight_timeline | cyber_sight_ai_usage | cyber_sight_threat_trends,
  frequency?: monthly | bi_weekly | weekly | daily | quarterly,
  day_of_week?: sunday | monday | tuesday | wednesday | thursday | friday | saturday,
  day_of_month?: number,
  active?: boolean,
  send_to_dashboard_users?: boolean,
  selected_sub_orgs?: number[],
  include_threat_summary?: boolean,
  include_content_category_summary?: boolean,
  content_categories_show_count?: all_categories | top5 | top10 | top15,
  scheduled_report_recipients?: {
    email?: string,
    external?: boolean,
    organization?: {
      id?: number
    }
  }[]
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: number | string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    organization?: {
      id?: number,
      name?: string
    },
    report_type?: legacy_protection_summary_report | filter_protection_overview | cyber_sight_activity_overview | cyber_sight_timeline | cyber_sight_ai_usage | cyber_sight_threat_trends | string,
    internal_recipients?: {
      id?: number,
      email?: string,
      external?: boolean,
      organization?: {
        id?: number,
        name?: string
      }
    }[],
    external_recipients?: {
      id?: number,
      email?: string,
      external?: boolean,
      organization?: {
        id?: number,
        name?: string
      }
    }[],
    recipients?: {
      id?: number,
      email?: string,
      external?: boolean,
      organization?: {
        id?: number,
        name?: string
      }
    }[],
    send_to_dashboard_users?: boolean,
    selected_sub_orgs?: number[],
    frequency?: monthly | bi_weekly | weekly | daily | quarterly | string,
    day_of_week?: sunday | monday | tuesday | wednesday | thursday | friday | saturday | string,
    day_of_month?: number,
    next_delivery?: string,
    last_delivery?: string,
    active?: boolean,
    created_at?: string,
    updated_at?: string
  }
}

Traffic Reports

qps

trafficReports.qps QPS for traffic reports Risk: read

await corsair.dnsfilter.api.trafficReports.qps({});

Input

Name	Type	Required	Description
`agent_ids`	`string`	No	—
`agent_types`	`string`	No	—
`application_ids`	`string`	No	—
`bucket_size`	`string`	No	—
`collection_ids`	`string`	No	—
`from`	`string`	No	—
`msp_id`	`number`	No	—
`network_ids`	`string`	No	—
`organization_ids`	`string`	No	—
`security_report`	`boolean`	No	—
`show_individual_networks`	`boolean`	No	—
`source`	`all \| networks \| agents \| proxies \| clientless`	No	—
`to`	`string`	No	—
`type`	`all \| allowed \| blocked`	No	—
`user_ids`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  organization_ids?: number[],
  organization_names?: string[],
  network_ids?: number[],
  network_names?: string[],
  values?: {
    network_id?: number,
    network_name?: string,
    bucket?: string,
    qps?: number,
    qps_networks?: number,
    qps_proxies?: number,
    qps_agents?: number
  }[]
}

qpsActiveAgents

trafficReports.qpsActiveAgents QPS active agents for traffic reports Risk: read

await corsair.dnsfilter.api.trafficReports.qpsActiveAgents({});

Input

Name	Type	Required	Description
`agent_ids`	`string`	No	—
`agent_types`	`string`	No	—
`application_ids`	`string`	No	—
`collection_ids`	`string`	No	—
`from`	`string`	No	—
`network_ids`	`string`	No	—
`organization_ids`	`string`	No	—
`security_report`	`boolean`	No	—
`source`	`all \| agents \| proxies`	No	—
`to`	`string`	No	—
`type`	`all \| allowed \| blocked`	No	—
`user_ids`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  organization_ids?: number[],
  organization_names?: string[],
  agent_ids?: string[],
  agent_names?: string[],
  values?: {
    agent_id?: string,
    agent_name?: string,
    bucket?: string,
    qps?: number,
    qps_networks?: number,
    qps_proxies?: number,
    qps_agents?: number
  }[]
}

qpsActiveOrganizations

trafficReports.qpsActiveOrganizations QPS active organizations for traffic reports Risk: read

await corsair.dnsfilter.api.trafficReports.qpsActiveOrganizations({});

Input

Name	Type	Required	Description
`agent_ids`	`string`	No	—
`agent_types`	`string`	No	—
`application_ids`	`string`	No	—
`collection_ids`	`string`	No	—
`from`	`string`	No	—
`msp_id`	`number`	No	—
`network_ids`	`string`	No	—
`organization_ids`	`string`	No	—
`security_report`	`boolean`	No	—
`source`	`all \| agents \| proxies`	No	—
`to`	`string`	No	—
`type`	`all \| allowed \| blocked`	No	—
`user_ids`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  organization_ids?: number[],
  organization_names?: string[],
  values?: {
    organization_id?: number,
    organization_name?: string,
    bucket?: string,
    qps?: number,
    qps_networks?: number,
    qps_proxies?: number,
    qps_agents?: number
  }[]
}

queryLogs

trafficReports.queryLogs Query logs for traffic reports Risk: read

await corsair.dnsfilter.api.trafficReports.queryLogs({});

Input

Name	Type	Required	Description
`agent_id`	`string`	No	—
`agent_ids`	`string`	No	—
`application_category_ids`	`string`	No	—
`application_ids`	`string`	No	—
`category_ids`	`string`	No	—
`collection_id`	`number`	No	—
`collection_ids`	`string`	No	—
`domain`	`string`	No	—
`exclude_category_ids`	`string`	No	—
`exclude_domain`	`string`	No	—
`fqdn`	`string`	No	—
`from`	`string`	No	—
`mac_addresses`	`string`	No	—
`nat_ips`	`string`	No	—
`network_id`	`number`	No	—
`network_ids`	`string`	No	—
`organization_id`	`number`	No	—
`page`	`object`	No	—
`policy_ids`	`string`	No	—
`private_ip`	`string`	No	—
`private_ip_from`	`string`	No	—
`private_ip_to`	`string`	No	—
`question_type`	`string`	No	—
`result`	`all \| allowed \| blocked`	No	—
`security_report`	`boolean`	No	—
`source`	`all \| networks \| agents \| proxies \| clientless`	No	—
`to`	`string`	No	—
`user_id`	`number`	No	—
`user_ids`	`string`	No	—

page full type

{
  number?: number,
  size?: number,
  cursor?: string,
  cursor_offset?: number
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  organization_id?: number,
  organization_ids?: (
    number | string
  )[],
  organization_name?: string,
  organization_names?: string[],
  network_id?: number,
  network_ids?: (
    number | string
  )[],
  client_id?: string,
  client_ids?: string[],
  user_id?: number,
  user_ids?: (
    number | string
  )[],
  collection_id?: number,
  collection_ids?: (
    number | string
  )[],
  values?: {
    time?: string,
    fqdn?: string,
    networkid?: number,
    request_address?: string,
    domain?: string,
    result?: allowed | blocked | string,
    threat?: boolean,
    categories?: number[],
    server_id?: number,
    server_address?: string,
    method?: number,
    responsetime?: number,
    agentid?: string,
    agentname?: string,
    agenttype?: proxy | agent | clientless | string,
    agent_type_raw?: string,
    local_ipv4_address?: string,
    local_ipv6_address?: string,
    local_user_id?: number,
    local_user_remote_id?: string,
    local_user_login?: string,
    local_user_name?: string,
    lan_device_name?: string,
    network_name?: string,
    server_name?: string,
    method_name?: string,
    categories_names?: string[],
    policy_id?: number,
    policy_name?: string,
    scheduled_policy_id?: number,
    scheduled_policy_name?: string,
    collection_id?: number,
    collection_name?: string,
    collections?: number[],
    collections_names?: string[],
    mac_address?: string,
    application_id?: number,
    application_name?: string,
    application_category_id?: number,
    application_category_name?: string,
    protocol?: string,
    question_type?: string,
    response_ips?: string[],
    region?: string
  }[],
  page?: {
    size?: number,
    total?: number,
    first?: number,
    last?: number,
    self?: number,
    prev?: number,
    next?: number,
    cursor?: string,
    cursor_offset?: number
  }
}

topAgents

trafficReports.topAgents Top agents for traffic reports Risk: read

await corsair.dnsfilter.api.trafficReports.topAgents({});

Input

Name	Type	Required	Description
`agent_ids`	`string`	No	—
`agent_types`	`string`	No	—
`application_ids`	`string`	No	—
`collection_ids`	`string`	No	—
`from`	`string`	No	—
`msp_id`	`number`	No	—
`name`	`string`	No	—
`network_ids`	`string`	No	—
`organization_ids`	`string`	No	—
`page`	`object`	No	—
`security_report`	`boolean`	No	—
`source`	`all \| networks \| agents \| proxies \| clientless`	No	—
`to`	`string`	No	—
`type`	`all \| allowed \| blocked`	No	—
`user_ids`	`string`	No	—

page full type

{
  number?: number,
  size?: number
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  organization_ids?: number[],
  organization_names?: string[],
  agent_ids?: string[],
  agent_names?: string[],
  values?: {
    agent_id?: string,
    agent_type?: string,
    agent_name?: string,
    total?: number,
    total_networks?: number,
    total_proxies?: number,
    total_agents?: number,
    policies?: number[],
    policies_names?: string[],
    scheduled_policies?: number[],
    scheduled_policies_names?: string[]
  }[],
  page?: {
    size?: number,
    total?: number,
    first?: number,
    last?: number,
    self?: number,
    prev?: number,
    next?: number
  }
}

topApplicationCategories

trafficReports.topApplicationCategories Top application categories for traffic reports Risk: read

await corsair.dnsfilter.api.trafficReports.topApplicationCategories({});

Input

Name	Type	Required	Description
`agent_ids`	`string`	No	—
`agent_types`	`string`	No	—
`application_ids`	`string`	No	—
`collection_ids`	`string`	No	—
`from`	`string`	No	—
`msp_id`	`number`	No	—
`name`	`string`	No	—
`network_ids`	`string`	No	—
`organization_ids`	`string`	No	—
`page`	`object`	No	—
`security_report`	`all \| true \| false`	No	—
`source`	`all \| networks \| agents \| proxies \| clientless`	No	—
`to`	`string`	No	—
`type`	`all \| allowed \| blocked`	No	—
`user_ids`	`string`	No	—

page full type

{
  number?: number,
  size?: number
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  organization_ids?: number[],
  organization_names?: string[],
  values?: {
    categoryid?: number,
    category_id?: number,
    category_name?: string,
    policies?: number[],
    policies_names?: string[],
    scheduled_policies?: number[],
    scheduled_policies_names?: string[],
    organizations?: number[],
    networks?: number[],
    agents?: string[],
    collections?: number[],
    users?: number[],
    total?: number,
    total_networks?: number,
    total_proxies?: number,
    total_agents?: number
  }[],
  page?: {
    size?: number,
    total?: number,
    first?: number,
    last?: number,
    self?: number,
    prev?: number,
    next?: number
  }
}

topCategories

trafficReports.topCategories Top categories for traffic reports Risk: read

await corsair.dnsfilter.api.trafficReports.topCategories({});

Input

Name	Type	Required	Description
`agent_ids`	`string`	No	—
`agent_types`	`string`	No	—
`application_ids`	`string`	No	—
`collection_ids`	`string`	No	—
`from`	`string`	No	—
`msp_id`	`number`	No	—
`name`	`string`	No	—
`network_ids`	`string`	No	—
`organization_ids`	`string`	No	—
`page`	`object`	No	—
`security_report`	`all \| true \| false`	No	—
`source`	`all \| networks \| agents \| proxies \| clientless`	No	—
`to`	`string`	No	—
`type`	`all \| allowed \| blocked`	No	—
`user_ids`	`string`	No	—

page full type

{
  number?: number,
  size?: number
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  organization_ids?: number[],
  organization_names?: string[],
  values?: {
    categoryid?: number,
    category_id?: number,
    category_name?: string,
    policies?: number[],
    policies_names?: string[],
    scheduled_policies?: number[],
    scheduled_policies_names?: string[],
    organizations?: number[],
    networks?: number[],
    agents?: string[],
    collections?: number[],
    users?: number[],
    total?: number,
    total_networks?: number,
    total_proxies?: number,
    total_agents?: number
  }[],
  page?: {
    size?: number,
    total?: number,
    first?: number,
    last?: number,
    self?: number,
    prev?: number,
    next?: number
  }
}

topCollections

trafficReports.topCollections Top collections for traffic reports Risk: read

await corsair.dnsfilter.api.trafficReports.topCollections({});

Input

Name	Type	Required	Description
`agent_ids`	`string`	No	—
`agent_types`	`string`	No	—
`application_ids`	`string`	No	—
`collection_ids`	`string`	No	—
`from`	`string`	No	—
`msp_id`	`number`	No	—
`name`	`string`	No	—
`network_ids`	`string`	No	—
`organization_ids`	`string`	No	—
`page`	`object`	No	—
`security_report`	`boolean`	No	—
`source`	`all \| networks \| agents \| proxies \| clientless`	No	—
`to`	`string`	No	—
`type`	`all \| allowed \| blocked`	No	—
`user_ids`	`string`	No	—

page full type

{
  number?: number,
  size?: number
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  organization_ids?: number[],
  organization_names?: string[],
  collection_ids?: number[],
  collection_names?: string[],
  values?: {
    collection_id?: number,
    collection_name?: string,
    total?: number,
    total_networks?: number,
    total_proxies?: number,
    total_agents?: number,
    policies?: number[],
    policies_names?: string[],
    scheduled_policies?: number[],
    scheduled_policies_names?: string[]
  }[],
  page?: {
    size?: number,
    total?: number,
    first?: number,
    last?: number,
    self?: number,
    prev?: number,
    next?: number
  }
}

topDomains

trafficReports.topDomains Top domains for traffic reports Risk: read

await corsair.dnsfilter.api.trafficReports.topDomains({});

Input

Name	Type	Required	Description
`agent_ids`	`string`	No	—
`agent_types`	`string`	No	—
`application_ids`	`string`	No	—
`category_ids`	`string`	No	—
`collection_ids`	`string`	No	—
`domain`	`string`	No	—
`fqdn`	`string`	No	—
`from`	`string`	No	—
`msp_id`	`number`	No	—
`network_ids`	`string`	No	—
`organization_ids`	`string`	No	—
`page`	`object`	No	—
`security_report`	`all \| true \| false`	No	—
`source`	`all \| networks \| agents \| proxies \| clientless`	No	—
`to`	`string`	No	—
`type`	`all \| allowed \| blocked`	No	—
`user_ids`	`string`	No	—

page full type

{
  number?: number,
  size?: number
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  organization_ids?: number[],
  organization_names?: string[],
  values?: {
    domain?: string,
    total?: number,
    total_networks?: number,
    total_proxies?: number,
    total_agents?: number,
    allowed?: number[],
    allowed_names?: string[],
    blocked?: number[],
    blocked_names?: string[],
    policies?: number[],
    policies_names?: string[],
    scheduled_policies?: number[],
    scheduled_policies_names?: string[],
    organizations?: number[],
    networks?: number[],
    agents?: string[],
    collections?: number[],
    users?: number[]
  }[],
  page?: {
    size?: number,
    total?: number,
    first?: number,
    last?: number,
    self?: number,
    prev?: number,
    next?: number
  }
}

topNetworks

trafficReports.topNetworks Top networks for traffic reports Risk: read

await corsair.dnsfilter.api.trafficReports.topNetworks({});

Input

Name	Type	Required	Description
`agent_ids`	`string`	No	—
`agent_types`	`string`	No	—
`application_ids`	`string`	No	—
`collection_ids`	`string`	No	—
`from`	`string`	No	—
`name`	`string`	No	—
`network_ids`	`string`	No	—
`organization_ids`	`string`	No	—
`page`	`object`	No	—
`security_report`	`boolean`	No	—
`source`	`all \| networks \| agents \| proxies \| clientless`	No	—
`to`	`string`	No	—
`type`	`all \| allowed \| blocked`	No	—
`user_ids`	`string`	No	—

page full type

{
  number?: number,
  size?: number
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  organization_ids?: number[],
  organization_names?: string[],
  network_ids?: number[],
  network_names?: string[],
  values?: {
    network_id?: number,
    network_name?: string,
    total?: number,
    total_networks?: number,
    total_proxies?: number,
    total_agents?: number,
    policies?: number[],
    policies_names?: string[],
    scheduled_policies?: number[],
    scheduled_policies_names?: string[]
  }[],
  page?: {
    size?: number,
    total?: number,
    first?: number,
    last?: number,
    self?: number,
    prev?: number,
    next?: number
  }
}

topOrganizationsRequests

trafficReports.topOrganizationsRequests Top organizations requests for traffic reports Risk: read

await corsair.dnsfilter.api.trafficReports.topOrganizationsRequests({});

Input

Name	Type	Required	Description
`bucket_size`	`string`	No	—
`from`	`string`	No	—
`msp_id`	`number`	No	—
`organization_id`	`number`	No	—
`page`	`object`	No	—
`to`	`string`	No	—

page full type

{
  number?: number,
  size?: number
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  values?: {
    organization_id?: number,
    organization_name?: string,
    total_requests?: number
  }[]
}

topUsers

trafficReports.topUsers Top users for traffic reports Risk: read

await corsair.dnsfilter.api.trafficReports.topUsers({});

Input

Name	Type	Required	Description
`agent_ids`	`string`	No	—
`agent_types`	`string`	No	—
`application_ids`	`string`	No	—
`collection_ids`	`string`	No	—
`from`	`string`	No	—
`msp_id`	`number`	No	—
`name`	`string`	No	—
`network_ids`	`string`	No	—
`organization_ids`	`string`	No	—
`page`	`object`	No	—
`security_report`	`boolean`	No	—
`source`	`all \| networks \| agents \| proxies \| clientless`	No	—
`to`	`string`	No	—
`type`	`all \| allowed \| blocked`	No	—
`user_ids`	`string`	No	—

page full type

{
  number?: number,
  size?: number
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  organization_ids?: number[],
  organization_names?: string[],
  user_ids?: number[],
  user_names?: string[],
  user_logins?: string[],
  values?: {
    user_id?: number,
    user_name?: string,
    user_login?: string,
    total?: number,
    total_networks?: number,
    total_proxies?: number,
    total_agents?: number,
    policies?: number[],
    policies_names?: string[],
    scheduled_policies?: number[],
    scheduled_policies_names?: string[]
  }[],
  page?: {
    size?: number,
    total?: number,
    first?: number,
    last?: number,
    self?: number,
    prev?: number,
    next?: number
  }
}

totalApplicationsAgentsStats

trafficReports.totalApplicationsAgentsStats Total applications agents stats for traffic reports Risk: read

await corsair.dnsfilter.api.trafficReports.totalApplicationsAgentsStats({});

Input

Name	Type	Required	Description
`agent_ids`	`string`	No	—
`agent_types`	`string`	No	—
`application_category_ids`	`string`	No	—
`application_ids`	`string`	No	—
`collection_ids`	`string`	No	—
`from`	`string`	No	—
`name`	`string`	No	—
`network_ids`	`string`	No	—
`organization_ids`	`string`	No	—
`security_report`	`boolean`	No	—
`source`	`all \| networks \| agents \| proxies \| clientless`	No	—
`to`	`string`	No	—
`type`	`all \| allowed \| blocked`	No	—
`user_ids`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  values?: {
    agent_id?: string,
    agent_type?: string,
    agent_name?: string,
    total_requests?: number,
    allowed_requests?: number,
    blocked_requests?: number,
    previous_total_requests?: number,
    most_recent_bucket?: string
  }[]
}

totalApplicationsCollectionsStats

trafficReports.totalApplicationsCollectionsStats Total applications collections stats for traffic reports Risk: read

await corsair.dnsfilter.api.trafficReports.totalApplicationsCollectionsStats({});

Input

Name	Type	Required	Description
`agent_ids`	`string`	No	—
`agent_types`	`string`	No	—
`application_category_ids`	`string`	No	—
`application_ids`	`string`	No	—
`collection_ids`	`string`	No	—
`from`	`string`	No	—
`name`	`string`	No	—
`network_ids`	`string`	No	—
`organization_ids`	`string`	No	—
`security_report`	`boolean`	No	—
`source`	`all \| networks \| agents \| proxies \| clientless`	No	—
`to`	`string`	No	—
`type`	`all \| allowed \| blocked`	No	—
`user_ids`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  values?: {
    collection_id?: number,
    collection_name?: string,
    total_requests?: number,
    allowed_requests?: number,
    blocked_requests?: number,
    previous_total_requests?: number,
    most_recent_bucket?: string
  }[]
}

totalApplicationsNetworksStats

trafficReports.totalApplicationsNetworksStats Total applications networks stats for traffic reports Risk: read

await corsair.dnsfilter.api.trafficReports.totalApplicationsNetworksStats({});

Input

Name	Type	Required	Description
`agent_ids`	`string`	No	—
`agent_types`	`string`	No	—
`application_category_ids`	`string`	No	—
`application_ids`	`string`	No	—
`collection_ids`	`string`	No	—
`from`	`string`	No	—
`name`	`string`	No	—
`network_ids`	`string`	No	—
`organization_ids`	`string`	No	—
`security_report`	`boolean`	No	—
`source`	`all \| networks \| agents \| proxies \| clientless`	No	—
`to`	`string`	No	—
`type`	`all \| allowed \| blocked`	No	—
`user_ids`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  values?: {
    network_id?: number,
    network_name?: string,
    total_requests?: number,
    allowed_requests?: number,
    blocked_requests?: number,
    previous_total_requests?: number,
    most_recent_bucket?: string
  }[]
}

totalApplicationsStats

trafficReports.totalApplicationsStats Total applications stats for traffic reports Risk: read

await corsair.dnsfilter.api.trafficReports.totalApplicationsStats({});

Input

Name	Type	Required	Description
`agent_ids`	`string`	No	—
`agent_types`	`string`	No	—
`application_category_ids`	`string`	No	—
`application_ids`	`string`	No	—
`collection_ids`	`string`	No	—
`from`	`string`	No	—
`msp_id`	`number`	No	—
`name`	`string`	No	—
`network_ids`	`string`	No	—
`organization_ids`	`string`	No	—
`security_report`	`boolean`	No	—
`source`	`all \| networks \| agents \| proxies \| clientless`	No	—
`to`	`string`	No	—
`type`	`all \| allowed \| blocked`	No	—
`user_ids`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  values?: {
    application_id?: number,
    application_name?: string,
    total_requests?: number,
    allowed_requests?: number,
    blocked_requests?: number,
    previous_total_requests?: number,
    most_recent_bucket?: string,
    application_category_id?: number,
    application_category_name?: string
  }[]
}

totalApplicationsUsersStats

trafficReports.totalApplicationsUsersStats Total applications users stats for traffic reports Risk: read

await corsair.dnsfilter.api.trafficReports.totalApplicationsUsersStats({});

Input

Name	Type	Required	Description
`agent_ids`	`string`	No	—
`agent_types`	`string`	No	—
`application_category_ids`	`string`	No	—
`application_ids`	`string`	No	—
`collection_ids`	`string`	No	—
`from`	`string`	No	—
`name`	`string`	No	—
`network_ids`	`string`	No	—
`organization_ids`	`string`	No	—
`security_report`	`boolean`	No	—
`source`	`all \| networks \| agents \| proxies \| clientless`	No	—
`to`	`string`	No	—
`type`	`all \| allowed \| blocked`	No	—
`user_ids`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  values?: {
    user_id?: number,
    user_name?: string,
    user_login?: string,
    total_requests?: number,
    allowed_requests?: number,
    blocked_requests?: number,
    previous_total_requests?: number,
    most_recent_bucket?: string
  }[]
}

totalCategories

trafficReports.totalCategories Total categories for traffic reports Risk: read

await corsair.dnsfilter.api.trafficReports.totalCategories({});

Input

Name	Type	Required	Description
`agent_ids`	`string`	No	—
`agent_types`	`string`	No	—
`application_ids`	`string`	No	—
`bucket_size`	`string`	No	—
`collection_ids`	`string`	No	—
`from`	`string`	No	—
`msp_id`	`number`	No	—
`network_ids`	`string`	No	—
`organization_ids`	`string`	No	—
`security_report`	`boolean`	No	—
`show_individual_networks`	`boolean`	No	—
`source`	`all \| networks \| agents \| proxies \| clientless`	No	—
`to`	`string`	No	—
`type`	`all \| allowed \| blocked`	No	—
`user_ids`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  organization_ids?: number[],
  organization_names?: string[],
  network_ids?: number[],
  network_names?: string[],
  category_ids?: number[],
  category_names?: string[],
  values?: {
    network_id?: number,
    network_name?: string,
    category_id?: number,
    category_name?: string,
    bucket?: string,
    policies?: number[],
    policies_names?: string[],
    scheduled_policies?: number[],
    scheduled_policies_names?: string[],
    total?: number,
    total_networks?: number,
    total_proxies?: number,
    total_agents?: number
  }[]
}

totalCategoriesOrganizations

trafficReports.totalCategoriesOrganizations Total categories organizations for traffic reports Risk: read

await corsair.dnsfilter.api.trafficReports.totalCategoriesOrganizations({});

Input

Name	Type	Required	Description
`agent_ids`	`string`	No	—
`agent_types`	`string`	No	—
`application_ids`	`string`	No	—
`bucket_size`	`string`	No	—
`collection_ids`	`string`	No	—
`from`	`string`	No	—
`network_ids`	`string`	No	—
`organization_ids`	`string`	No	—
`security_report`	`boolean`	No	—
`show_individual_organizations`	`boolean`	No	—
`source`	`all \| networks \| agents \| proxies \| clientless`	No	—
`to`	`string`	No	—
`type`	`all \| allowed \| blocked`	No	—
`user_ids`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  organization_ids?: number[],
  organization_names?: string[],
  category_ids?: number[],
  category_names?: string[],
  values?: {
    category_id?: number,
    category_name?: string,
    organization_id?: number,
    organization_name?: string,
    bucket?: string,
    policies?: number[],
    policies_names?: string[],
    scheduled_policies?: number[],
    scheduled_policies_names?: string[],
    total?: number,
    total_networks?: number,
    total_proxies?: number,
    total_agents?: number
  }[]
}

totalCategoryStats

trafficReports.totalCategoryStats Total category stats for traffic reports Risk: read

await corsair.dnsfilter.api.trafficReports.totalCategoryStats({});

Input

Name	Type	Required	Description
`category_ids`	`string`	No	—
`from`	`string`	No	—
`msp_id`	`number`	No	—
`network_ids`	`string`	No	—
`organization_id`	`number`	No	—
`to`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  organization_ids?: number[],
  organization_names?: string[],
  total_requests?: number,
  allowed_requests?: number,
  blocked_requests?: number,
  threat_requests?: number
}

totalClientStats

trafficReports.totalClientStats Total client stats for traffic reports Risk: read

await corsair.dnsfilter.api.trafficReports.totalClientStats({});

Input

Name	Type	Required	Description
`from`	`string`	No	—
`msp_id`	`number`	No	—
`network_ids`	`string`	No	—
`organization_id`	`number`	No	—
`to`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  organization_id?: number,
  organization_name?: string,
  total_users?: number,
  active_users?: number,
  total_sites?: number,
  active_sites?: number,
  total_roaming_clients?: number,
  active_roaming_clients?: number,
  total_relays?: number,
  active_relays?: number
}

totalDeployments

trafficReports.totalDeployments Total deployments for traffic reports Risk: read

await corsair.dnsfilter.api.trafficReports.totalDeployments({});

Input

Name	Type	Required	Description
`msp_id`	`number`	No	—
`network_ids`	`string`	No	—
`organization_id`	`number`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  organization_id?: number,
  organization_name?: string,
  collections?: number,
  user_agents?: number,
  sync_tools?: number,
  relays?: number,
  users?: number
}

totalDomains

trafficReports.totalDomains Total domains for traffic reports Risk: read

await corsair.dnsfilter.api.trafficReports.totalDomains({});

Input

Name	Type	Required	Description
`agent_ids`	`string`	No	—
`agent_types`	`string`	No	—
`application_ids`	`string`	No	—
`bucket_size`	`string`	No	—
`category_ids`	`string`	No	—
`collection_ids`	`string`	No	—
`domain`	`string`	No	—
`from`	`string`	No	—
`network_ids`	`string`	No	—
`organization_ids`	`string`	No	—
`security_report`	`boolean`	No	—
`show_individual_networks`	`boolean`	No	—
`source`	`all \| networks \| agents \| proxies \| clientless`	No	—
`to`	`string`	No	—
`type`	`all \| allowed \| blocked`	No	—
`user_ids`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  organization_ids?: number[],
  organization_names?: string[],
  network_ids?: number[],
  network_names?: string[],
  values?: {
    network_id?: number,
    network_name?: string,
    domain?: string,
    bucket?: string,
    policies?: number[],
    policies_names?: string[],
    scheduled_policies?: number[],
    scheduled_policies_names?: string[],
    total?: number,
    total_networks?: number,
    total_proxies?: number,
    total_agents?: number
  }[]
}

totalDomainsOrganizations

trafficReports.totalDomainsOrganizations Total domains organizations for traffic reports Risk: read

await corsair.dnsfilter.api.trafficReports.totalDomainsOrganizations({});

Input

Name	Type	Required	Description
`agent_ids`	`string`	No	—
`agent_types`	`string`	No	—
`application_ids`	`string`	No	—
`bucket_size`	`string`	No	—
`category_ids`	`string`	No	—
`collection_ids`	`string`	No	—
`domain`	`string`	No	—
`from`	`string`	No	—
`network_ids`	`string`	No	—
`organization_ids`	`string`	No	—
`security_report`	`boolean`	No	—
`show_individual_organizations`	`boolean`	No	—
`source`	`all \| networks \| agents \| proxies \| clientless`	No	—
`to`	`string`	No	—
`type`	`all \| allowed \| blocked`	No	—
`user_ids`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  organization_ids?: number[],
  organization_names?: string[],
  values?: {
    organization_id?: number,
    organization_name?: string,
    domain?: string,
    bucket?: string,
    policies?: number[],
    policies_names?: string[],
    scheduled_policies?: number[],
    scheduled_policies_names?: string[],
    total?: number,
    total_networks?: number,
    total_proxies?: number,
    total_agents?: number
  }[]
}

totalDomainStats

trafficReports.totalDomainStats Total domain stats for traffic reports Risk: read

await corsair.dnsfilter.api.trafficReports.totalDomainStats({});

Input

Name	Type	Required	Description
`domain`	`string`	No	—
`fqdn`	`string`	No	—
`from`	`string`	No	—
`msp_id`	`number`	No	—
`network_ids`	`string`	No	—
`organization_id`	`number`	No	—
`to`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  organization_ids?: number[],
  organization_names?: string[],
  total_requests?: number,
  allowed_requests?: number,
  blocked_requests?: number,
  threat_requests?: number
}

totalDomainsUsers

trafficReports.totalDomainsUsers Total domains users for traffic reports Risk: read

await corsair.dnsfilter.api.trafficReports.totalDomainsUsers({});

Input

Name	Type	Required	Description
`agent_ids`	`string`	No	—
`agent_types`	`string`	No	—
`application_ids`	`string`	No	—
`bucket_size`	`string`	No	—
`category_ids`	`string`	No	—
`collection_ids`	`string`	No	—
`domain`	`string`	No	—
`from`	`string`	No	—
`network_ids`	`string`	No	—
`organization_ids`	`string`	No	—
`security_report`	`boolean`	No	—
`show_individual_users`	`boolean`	No	—
`source`	`all \| networks \| agents \| proxies \| clientless`	No	—
`to`	`string`	No	—
`type`	`all \| allowed \| blocked`	No	—
`user_ids`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  organization_ids?: number[],
  organization_names?: string[],
  user_ids?: number[],
  user_names?: string[],
  user_logins?: string[],
  values?: {
    user_id?: number,
    user_name?: string,
    user_login?: string,
    domain?: string,
    bucket?: string,
    policies?: number[],
    policies_names?: string[],
    scheduled_policies?: number[],
    scheduled_policies_names?: string[],
    total?: number,
    total_networks?: number,
    total_proxies?: number,
    total_agents?: number
  }[]
}

totalOrganizationsRequests

trafficReports.totalOrganizationsRequests Total organizations requests for traffic reports Risk: read

await corsair.dnsfilter.api.trafficReports.totalOrganizationsRequests({});

Input

Name	Type	Required	Description
`agent_ids`	`string`	No	—
`agent_types`	`string`	No	—
`application_ids`	`string`	No	—
`bucket_size`	`string`	No	—
`category_ids`	`string`	No	—
`collection_ids`	`string`	No	—
`domain`	`string`	No	—
`fqdn`	`string`	No	—
`from`	`string`	No	—
`msp_id`	`number`	No	—
`name`	`string`	No	—
`network_ids`	`string`	No	—
`organization_id`	`number`	No	—
`organization_ids`	`string`	No	—
`security_report`	`boolean`	No	—
`to`	`string`	No	—
`type`	`all \| allowed \| blocked`	No	—
`user_ids`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  organization_ids?: number[],
  organization_names?: string[],
  values?: {
    bucket?: string,
    total_requests?: number,
    allowed_requests?: number,
    blocked_requests?: number,
    threat_requests?: number
  }[]
}

totalOrganizationsStats

trafficReports.totalOrganizationsStats Total organizations stats for traffic reports Risk: read

await corsair.dnsfilter.api.trafficReports.totalOrganizationsStats({});

Input

Name	Type	Required	Description
`agent_ids`	`string`	No	—
`agent_types`	`string`	No	—
`application_category_ids`	`string`	No	—
`bucket_size`	`string`	No	—
`collection_ids`	`string`	No	—
`from`	`string`	No	—
`msp_id`	`number`	No	—
`name`	`string`	No	—
`organization_id`	`number`	No	—
`security_report`	`boolean`	No	—
`to`	`string`	No	—
`type`	`all \| allowed \| blocked`	No	—
`user_ids`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  organization_ids?: number[],
  organization_names?: string[],
  total_requests?: number,
  allowed_requests?: number,
  blocked_requests?: number,
  threat_requests?: number
}

totalRequests

trafficReports.totalRequests Total requests for traffic reports Risk: read

await corsair.dnsfilter.api.trafficReports.totalRequests({});

Input

Name	Type	Required	Description
`agent_ids`	`string`	No	—
`agent_types`	`string`	No	—
`application_ids`	`string`	No	—
`bucket_size`	`string`	No	—
`collection_ids`	`string`	No	—
`from`	`string`	No	—
`msp_id`	`number`	No	—
`network_ids`	`string`	No	—
`organization_ids`	`string`	No	—
`security_report`	`boolean`	No	—
`show_individual_networks`	`boolean`	No	—
`source`	`all \| networks \| agents \| proxies \| clientless`	No	—
`to`	`string`	No	—
`type`	`all \| allowed \| blocked`	No	—
`user_ids`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  organization_ids?: number[],
  organization_names?: string[],
  network_ids?: number[],
  network_names?: string[],
  values?: {
    network_id?: number,
    network_name?: string,
    bucket?: string,
    policies?: number[],
    policies_names?: string[],
    scheduled_policies?: number[],
    scheduled_policies_names?: string[],
    total?: number,
    total_networks?: number,
    total_proxies?: number,
    total_agents?: number
  }[]
}

totalRequestsAgents

trafficReports.totalRequestsAgents Total requests agents for traffic reports Risk: read

await corsair.dnsfilter.api.trafficReports.totalRequestsAgents({});

Input

Name	Type	Required	Description
`agent_ids`	`string`	No	—
`agent_types`	`string`	No	—
`application_ids`	`string`	No	—
`bucket_size`	`string`	No	—
`collection_ids`	`string`	No	—
`from`	`string`	No	—
`msp_id`	`number`	No	—
`network_ids`	`string`	No	—
`organization_ids`	`string`	No	—
`security_report`	`boolean`	No	—
`show_individual_agents`	`boolean`	No	—
`source`	`all \| networks \| agents \| proxies \| clientless`	No	—
`to`	`string`	No	—
`type`	`all \| allowed \| blocked`	No	—
`user_ids`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  organization_ids?: number[],
  organization_names?: string[],
  agent_ids?: string[],
  agent_names?: string[],
  values?: {
    agent_id?: string,
    agent_type?: string,
    agent_name?: string,
    bucket?: string,
    policies?: number[],
    policies_names?: string[],
    scheduled_policies?: number[],
    scheduled_policies_names?: string[],
    total?: number,
    total_networks?: number,
    total_proxies?: number,
    total_agents?: number
  }[]
}

totalRequestsCollections

trafficReports.totalRequestsCollections Total requests collections for traffic reports Risk: read

await corsair.dnsfilter.api.trafficReports.totalRequestsCollections({});

Input

Name	Type	Required	Description
`agent_ids`	`string`	No	—
`agent_types`	`string`	No	—
`application_ids`	`string`	No	—
`bucket_size`	`string`	No	—
`collection_ids`	`string`	No	—
`from`	`string`	No	—
`network_ids`	`string`	No	—
`organization_ids`	`string`	No	—
`security_report`	`boolean`	No	—
`show_individual_collections`	`boolean`	No	—
`source`	`all \| networks \| agents \| proxies \| clientless`	No	—
`to`	`string`	No	—
`type`	`all \| allowed \| blocked`	No	—
`user_ids`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  collection_id?: number,
  collection_name?: string,
  bucket?: string,
  policies?: number[],
  policies_names?: string[],
  scheduled_policies?: number[],
  scheduled_policies_names?: string[],
  total?: number,
  total_networks?: number,
  total_proxies?: number,
  total_agents?: number
}

totalRequestsGeo

trafficReports.totalRequestsGeo Total requests geo for traffic reports Risk: read

await corsair.dnsfilter.api.trafficReports.totalRequestsGeo({});

Input

Name	Type	Required	Description
`from`	`string`	No	—
`limit`	`number`	Yes	—
`msp_id`	`number`	No	—
`organization_ids`	`string`	No	—
`to`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  organization_ids?: number[],
  organization_names?: string[],
  network_ids?: (
    number | string
  )[],
  network_names?: string[],
  values?: {
    network_id?: number,
    total_requests?: number,
    qps?: number
  }[]
}

totalRequestsOrganizations

trafficReports.totalRequestsOrganizations Total requests organizations for traffic reports Risk: read

await corsair.dnsfilter.api.trafficReports.totalRequestsOrganizations({});

Input

Name	Type	Required	Description
`agent_ids`	`string`	No	—
`agent_types`	`string`	No	—
`application_ids`	`string`	No	—
`bucket_size`	`string`	No	—
`collection_ids`	`string`	No	—
`from`	`string`	No	—
`msp_id`	`number`	No	—
`network_ids`	`string`	No	—
`organization_ids`	`string`	No	—
`security_report`	`boolean`	No	—
`show_individual_organizations`	`boolean`	No	—
`source`	`all \| networks \| agents \| proxies \| clientless`	No	—
`to`	`string`	No	—
`type`	`all \| allowed \| blocked`	No	—
`user_ids`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  organization_ids?: number[],
  organization_names?: string[],
  values?: {
    organization_id?: number,
    organization_name?: string,
    bucket?: string,
    policies?: number[],
    policies_names?: string[],
    scheduled_policies?: number[],
    scheduled_policies_names?: string[],
    total?: number,
    total_networks?: number,
    total_proxies?: number,
    total_agents?: number
  }[]
}

totalRequestsUsers

trafficReports.totalRequestsUsers Total requests users for traffic reports Risk: read

await corsair.dnsfilter.api.trafficReports.totalRequestsUsers({});

Input

Name	Type	Required	Description
`agent_ids`	`string`	No	—
`agent_types`	`string`	No	—
`application_ids`	`string`	No	—
`bucket_size`	`string`	No	—
`collection_ids`	`string`	No	—
`from`	`string`	No	—
`msp_id`	`number`	No	—
`network_ids`	`string`	No	—
`organization_ids`	`string`	No	—
`security_report`	`boolean`	No	—
`show_individual_users`	`boolean`	No	—
`source`	`all \| networks \| agents \| proxies \| clientless`	No	—
`to`	`string`	No	—
`type`	`all \| allowed \| blocked`	No	—
`user_ids`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  organization_ids?: number[],
  organization_names?: string[],
  values?: {
    user_id?: number,
    user_name?: string,
    user_login?: string,
    bucket?: string,
    total?: number,
    total_networks?: number,
    total_proxies?: number,
    total_agents?: number
  }[]
}

totalRoamingClients

trafficReports.totalRoamingClients Total roaming clients for traffic reports Risk: read

await corsair.dnsfilter.api.trafficReports.totalRoamingClients({});

Input

Name	Type	Required	Description
`msp_id`	`number`	No	—
`organization_id`	`number`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  organization_ids?: number[],
  organization_names?: string[],
  values?: {
    os?: string,
    value?: number
  }[]
}

totalThreats

trafficReports.totalThreats Total threats for traffic reports Risk: read

await corsair.dnsfilter.api.trafficReports.totalThreats({});

Input

Name	Type	Required	Description
`agent_ids`	`string`	No	—
`agent_types`	`string`	No	—
`application_ids`	`string`	No	—
`bucket_size`	`string`	No	—
`collection_ids`	`string`	No	—
`from`	`string`	No	—
`network_ids`	`string`	No	—
`organization_ids`	`string`	No	—
`show_individual_networks`	`boolean`	No	—
`source`	`all \| networks \| agents \| proxies \| clientless`	No	—
`to`	`string`	No	—
`type`	`all \| allowed \| blocked`	No	—
`user_ids`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  organization_ids?: number[],
  organization_names?: string[],
  network_ids?: number[],
  network_names?: string[],
  values?: {
    network_id?: number,
    network_name?: string,
    bucket?: string,
    policies?: number[],
    policies_names?: string[],
    scheduled_policies?: number[],
    scheduled_policies_names?: string[],
    total?: number,
    total_networks?: number,
    total_proxies?: number,
    total_agents?: number
  }[]
}

totalThreatsOrganizations

trafficReports.totalThreatsOrganizations Total threats organizations for traffic reports Risk: read

await corsair.dnsfilter.api.trafficReports.totalThreatsOrganizations({});

Input

Name	Type	Required	Description
`agent_ids`	`string`	No	—
`agent_types`	`string`	No	—
`application_ids`	`string`	No	—
`bucket_size`	`string`	No	—
`collection_ids`	`string`	No	—
`from`	`string`	No	—
`network_ids`	`string`	No	—
`organization_ids`	`string`	No	—
`show_individual_organizations`	`boolean`	No	—
`source`	`all \| networks \| agents \| proxies \| clientless`	No	—
`to`	`string`	No	—
`type`	`all \| allowed \| blocked`	No	—
`user_ids`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  organization_ids?: number[],
  organization_names?: string[],
  agent_ids?: string[],
  agent_names?: string[],
  values?: {
    organization_id?: number,
    organization_name?: string,
    bucket?: string,
    policies?: number[],
    policies_names?: string[],
    scheduled_policies?: number[],
    scheduled_policies_names?: string[],
    total?: number,
    total_networks?: number,
    total_proxies?: number,
    total_agents?: number
  }[]
}

totalThreatsUsers

trafficReports.totalThreatsUsers Total threats users for traffic reports Risk: read

await corsair.dnsfilter.api.trafficReports.totalThreatsUsers({});

Input

Name	Type	Required	Description
`agent_ids`	`string`	No	—
`agent_types`	`string`	No	—
`application_ids`	`string`	No	—
`bucket_size`	`string`	No	—
`collection_ids`	`string`	No	—
`from`	`string`	No	—
`network_ids`	`string`	No	—
`organization_ids`	`string`	No	—
`show_individual_users`	`boolean`	No	—
`source`	`all \| networks \| agents \| proxies \| clientless`	No	—
`to`	`string`	No	—
`type`	`all \| allowed \| blocked`	No	—
`user_ids`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  organization_ids?: number[],
  organization_names?: string[],
  values?: {
    user_id?: number,
    user_name?: string,
    user_login?: string,
    bucket?: string,
    total?: number,
    total_networks?: number,
    total_proxies?: number,
    total_agents?: number
  }[]
}

Trials

create

trials.create Create a trial Risk: write

await corsair.dnsfilter.api.trials.create({});

Input

Name	Type	Required	Description
`organization_id`	`number`	No	—
`sku`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  entitlement_key?: string,
  entitlement_name?: string,
  skus?: string[],
  addon?: string,
  addon_sku?: string,
  in_use?: boolean,
  start?: string,
  end?: string,
  grace_period?: string,
  active?: boolean
}

Unblock Requests

counts

unblockRequests.counts Counts for unblock requests Risk: read

await corsair.dnsfilter.api.unblockRequests.counts({});

Input

Name	Type	Required	Description
`msp_id`	`number`	No	—
`organization_id`	`number`	No	—
`organization_ids`	`number[]`	No	—

Output

Name	Type	Required	Description
`active`	`number`	No	—
`history`	`number`	No	—

decision

unblockRequests.decision Decision for unblock requests Risk: write

await corsair.dnsfilter.api.unblockRequests.decision({ id: '8f14e45f', decision: 'allow' });

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`decision`	`allow \| allow-universal \| deny \| deny-and-ignore \| resolve-already-allowed`	Yes	—
`domains`	`string[]`	No	—
`message`	`string`	No	—
`internal_notes`	`string`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  attributes?: {
    domain?: string,
    status?: allowed | denied | ignored | resolved_already_allowed | expired | string,
    decided_at?: string,
    decided_by?: {
      id?: number,
      name?: string,
      email?: string
    },
    response_message?: string,
    internal_notes?: string
  }
}

get

unblockRequests.get Get an unblock request Risk: read

await corsair.dnsfilter.api.unblockRequests.get({});

Input

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

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  attributes?: {
    domain?: string,
    requester_name?: string,
    requester_email?: string,
    request_reason?: string,
    organization?: {
      id?: number,
      name?: string
    },
    site?: {
      id?: number,
      name?: string
    },
    policy?: {
      id?: number,
      name?: string
    },
    logged_in_user?: string,
    category?: {
      ids?: number[],
      names?: string[],
      is_threat?: boolean
    },
    time_of_attempt?: string,
    already_covered?: {
      covered?: boolean,
      list?: policy | universal_org | universal_msp | string,
      date_added?: string
    },
    allow_list_targets?: {
      type?: policy | universal | string,
      id?: number,
      name?: string,
      affects_all?: boolean,
      blast_radius?: {
        sites?: number,
        users?: number
      },
      already_on_list?: boolean,
      date_added?: string
    }[]
  }
}

list

unblockRequests.list List unblock requests Risk: read

await corsair.dnsfilter.api.unblockRequests.list({
	page: { number: 1, size: 25 },
});

Input

Name	Type	Required	Description
`actioned_by`	`object`	No	—
`category`	`object`	No	—
`deployment`	`object`	No	—
`deployment_type`	`object`	No	—
`domain`	`object`	No	—
`email`	`object`	No	—
`logged_in_user`	`object`	No	—
`msp_id`	`number`	No	—
`organization`	`object`	No	—
`organization_id`	`number`	No	—
`organization_ids`	`number[]`	No	—
`page`	`object`	No	—
`policy`	`object`	No	—
`request_reason`	`object`	No	—
`resolved_date`	`object`	No	—
`search`	`string`	No	—
`site`	`object`	No	—
`sort`	`string`	No	—
`status`	`object`	No	—
`tab`	`string`	No	—
`time_of_attempt`	`object`	No	—

actioned_by full type

{
  value?: string,
  operator?: string
}

category full type

{
  value?: string,
  operator?: string
}

deployment full type

{
  value?: string,
  operator?: string
}

deployment_type full type

{
  value?: string,
  operator?: string
}

domain full type

{
  value?: string,
  operator?: string
}

email full type

{
  value?: string,
  operator?: string
}

logged_in_user full type

{
  value?: string,
  operator?: string
}

organization full type

{
  value?: string,
  operator?: string
}

page full type

{
  number?: number,
  size?: number
}

policy full type

{
  value?: string,
  operator?: string
}

request_reason full type

{
  value?: string,
  operator?: string
}

resolved_date full type

{
  value?: {
  },
  operator?: string
}

site full type

{
  value?: string,
  operator?: string
}

status full type

{
  value?: string,
  operator?: string
}

time_of_attempt full type

{
  value?: {
  },
  operator?: string
}

Output

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

data full type

{
  id?: string,
  attributes?: {
    domain?: string,
    organization?: {
      id?: number,
      name?: string
    },
    site?: {
      id?: number,
      name?: string
    },
    deployment?: string,
    deployment_type?: site | roaming_client | relay | clientless | string,
    policy?: {
      id?: number,
      name?: string,
      is_global_policy?: boolean
    },
    category?: {
      ids?: number[],
      names?: string[],
      is_threat?: boolean
    },
    blocked_by?: blocklist | appaware | category | security | unknown | string,
    time_of_attempt?: string,
    user_agent_id?: string,
    agent_local_user_id?: number,
    logged_in_user?: string,
    email?: string,
    request_reason?: string,
    can_action?: boolean,
    actioned_by?: {
      id?: number,
      name?: string,
      email?: string
    },
    resolved_date?: string,
    action?: allowed | denied | ignored | resolved_already_allowed | expired | string,
    response_message?: string,
    internal_notes?: string
  }
}[]

meta full type

{
  total_count?: number,
  total_pages?: number,
  current_page?: number
}

pendingCount

unblockRequests.pendingCount Pending count for unblock requests Risk: read

await corsair.dnsfilter.api.unblockRequests.pendingCount({});

Input

Name	Type	Required	Description
`msp_id`	`number`	No	—
`organization_id`	`number`	No	—
`organization_ids`	`number[]`	No	—

Output

Name	Type	Required	Description
`count`	`number`	No	—

User Agent Bulk Deletes

counts

userAgentBulkDeletes.counts Counts for user agent bulk deletes Risk: read

await corsair.dnsfilter.api.userAgentBulkDeletes.counts({});

Input

Name	Type	Required	Description
`agent_state`	`protected \| unprotected \| bypassed \| uninstalled`	No	—
`name_search`	`string`	No	—
`network_ids`	`number[]`	No	—
`organization_id`	`number`	No	—
`search`	`string`	No	—
`state`	`online \| offline`	No	—
`status`	`string`	No	—
`tags`	`string[]`	No	—
`traffic_received_last_15_mins`	`boolean`	No	—
`type`	`proxy \| agents`	No	—

Output

Name	Type	Required	Description
`uninstall_and_delete`	`number`	No	—
`delete`	`number`	No	—

create

userAgentBulkDeletes.create Bulk delete user agent Risk: destructive · Irreversible

await corsair.dnsfilter.api.userAgentBulkDeletes.create({});

Input

Name	Type	Required	Description
`agent_state`	`protected \| unprotected \| bypassed \| uninstalled`	No	—
`agent_version`	`string`	No	—
`block_page_id`	`number`	No	—
`name_search`	`string`	No	—
`network_ids`	`number[]`	No	—
`organization_id`	`number`	No	—
`organization_ids`	`number[]`	No	—
`policy_id`	`number`	No	—
`policy_schedule`	`string`	No	—
`queue_uninstall`	`boolean`	No	—
`release_channels`	`object`	No	—
`scheduled_policy_id`	`number`	No	—
`search`	`string`	No	—
`state`	`online \| offline`	No	—
`status`	`string`	No	—
`tags`	`string[]`	No	—
`traffic_received_last_15_mins`	`boolean`	No	—
`type`	`proxy \| agents`	No	—
`ids`	`string[]`	No	—
`exclude_ids`	`string[]`	No	—

release_channels full type

{
  value?: string
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  organization_id?: number,
  completed?: boolean,
  count?: number,
  queue_uninstall?: boolean
}

get

userAgentBulkDeletes.get Get a user agent bulk delete Risk: read

await corsair.dnsfilter.api.userAgentBulkDeletes.get({});

Input

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

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  organization_id?: number,
  completed?: boolean,
  count?: number,
  queue_uninstall?: boolean
}

User Agent Bulk Updates

counts

userAgentBulkUpdates.counts Counts for user agent bulk updates Risk: read

await corsair.dnsfilter.api.userAgentBulkUpdates.counts({});

Input

Name	Type	Required	Description
`agent_state`	`protected \| unprotected \| bypassed \| uninstalled`	No	—
`block_page_id`	`number`	No	—
`name_search`	`string`	No	—
`network_ids`	`number[]`	No	—
`organization_id`	`number`	No	—
`policy_id`	`number`	No	—
`release_channels`	`object`	No	—
`scheduled_policy_id`	`number`	No	—
`search`	`string`	No	—
`state`	`online \| offline`	No	—
`status`	`string`	No	—
`tags`	`string[]`	No	—
`traffic_received_last_15_mins`	`boolean`	No	—
`type`	`proxy \| agents`	No	—

release_channels full type

{
  value?: string
}

Output

Name	Type	Required	Description
`uninstall_and_delete`	`number`	No	—
`delete`	`number`	No	—

create

userAgentBulkUpdates.create Bulk update user agent Risk: write

await corsair.dnsfilter.api.userAgentBulkUpdates.create({});

Input

Name	Type	Required	Description
`agent_state`	`protected \| unprotected \| bypassed \| uninstalled`	No	—
`agent_version`	`string`	No	—
`block_page_id`	`number`	No	—
`name_search`	`string`	No	—
`network_ids`	`number[]`	No	—
`organization_id`	`number`	No	—
`organization_ids`	`number[]`	No	—
`policy_id`	`number`	No	—
`policy_schedule`	`string`	No	—
`release_channels`	`object`	No	—
`scheduled_policy_id`	`number`	No	—
`search`	`string`	No	—
`state`	`online \| offline`	No	—
`status`	`string`	No	—
`tags`	`string[]`	No	—
`traffic_received_last_15_mins`	`boolean`	No	—
`type`	`proxy \| agents`	No	—
`ids`	`string[]`	No	—
`exclude_ids`	`string[]`	No	—
`changeset`	`object`	No	—

release_channels full type

{
  value?: string
}

changeset full type

{
  network_id?: number,
  policy_id?: number,
  scheduled_policy_id?: number,
  block_page_id?: number,
  friendly_name?: string,
  tags?: string[],
  release_channels?: string[],
  device_setting_attributes?: {
    enable_cyber_sight?: boolean,
    enable_filtering_client?: boolean,
    diagnostics_level?: unknown | trace | debug | information | warning | error | critical
  },
  filtering_client_setting_attributes?: {
    connection_method?: unknown | transparent_proxy | loopback,
    filtering_method?: unknown | precheck | dns_filtering,
    fail_over_method?: unknown | fail_open | fail_close
  },
  vpn_settings_user_agent?: {
    _destroy?: boolean,
    vpn_settings_state_type_id?: number
  }
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  organization_id?: number,
  completed?: boolean,
  count?: number
}

get

userAgentBulkUpdates.get Get a user agent bulk update Risk: read

await corsair.dnsfilter.api.userAgentBulkUpdates.get({});

Input

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

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  organization_id?: number,
  completed?: boolean,
  count?: number
}

hasMixed

userAgentBulkUpdates.hasMixed Has mixed for user agent bulk updates Risk: write

await corsair.dnsfilter.api.userAgentBulkUpdates.hasMixed({});

Input

Name	Type	Required	Description
`agent_state`	`protected \| unprotected \| bypassed \| uninstalled`	No	—
`name_search`	`string`	No	—
`network_ids`	`number[]`	No	—
`organization_ids`	`number[]`	No	—
`search`	`string`	No	—
`state`	`online \| offline`	No	—
`status`	`string`	No	—
`tags`	`string[]`	No	—
`traffic_received_last_15_mins`	`boolean`	No	—
`type`	`proxy \| agents`	No	—
`ids`	`string[]`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  siteMixed?: boolean,
  tagsMixed?: boolean,
  policyMixed?: boolean,
  blockPageMixed?: boolean
}

User Agent Cleanups

create

userAgentCleanups.create Clean up user agent Risk: destructive · Irreversible

await corsair.dnsfilter.api.userAgentCleanups.create({});

Input

Name	Type	Required	Description
`organization_id`	`number`	No	—
`organization_ids`	`number[]`	Yes	—
`inactive_for`	`number`	Yes	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  inactive_for?: number,
  organization_id?: number,
  organization_ids?: number[],
  query_completed?: boolean,
  started?: boolean,
  completed?: boolean,
  to_delete?: string[],
  agents_to_delete?: {
    id?: string,
    name?: string,
    organization_name?: string
  }[]
}

get

userAgentCleanups.get Get a user agent cleanup Risk: read

await corsair.dnsfilter.api.userAgentCleanups.get({});

Input

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

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  inactive_for?: number,
  organization_id?: number,
  organization_ids?: number[],
  query_completed?: boolean,
  started?: boolean,
  completed?: boolean,
  to_delete?: string[],
  agents_to_delete?: {
    id?: string,
    name?: string,
    organization_name?: string
  }[]
}

update

userAgentCleanups.update Update a user agent cleanup Risk: destructive · Irreversible

await corsair.dnsfilter.api.userAgentCleanups.update({});

Input

Name	Type	Required	Description
`id`	`number`	Yes	—
`start`	`boolean`	No	—
`inactive_for`	`number`	No	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  inactive_for?: number,
  organization_id?: number,
  organization_ids?: number[],
  query_completed?: boolean,
  started?: boolean,
  completed?: boolean,
  to_delete?: string[],
  agents_to_delete?: {
    id?: string,
    name?: string,
    organization_name?: string
  }[]
}

User Agent Releases

list

userAgentReleases.list List user agent releases Risk: read

await corsair.dnsfilter.api.userAgentReleases.list({});

Input: empty object Output

Name	Type	Required	Description
`user_agent_releases`	`object[]`	No	—

user_agent_releases full type

{
  agent_type?: windows | macos | string,
  architecture?: x86 | x86_64 | string,
  version?: string,
  platform?: string,
  agent_version?: string,
  white_label?: boolean,
  release_channels?: {
    label?: string,
    value?: string,
    visible?: boolean
  }[],
  url?: string
}[]

relay

userAgentReleases.relay Relay for user agent releases Risk: read

await corsair.dnsfilter.api.userAgentReleases.relay({});

Input: empty object Output

Name	Type	Required	Description
`user_agent_releases`	`object[]`	No	—

user_agent_releases full type

{
  agent_type?: windows | macos | string,
  architecture?: x86 | x86_64 | string,
  version?: string,
  platform?: string,
  agent_version?: string,
  white_label?: boolean,
  release_channels?: {
    label?: string,
    value?: string,
    visible?: boolean
  }[],
  url?: string
}[]

User Agents

counts

userAgents.counts Counts for user agents Risk: read

await corsair.dnsfilter.api.userAgents.counts({});

Input

Name	Type	Required	Description
`msp_id`	`number`	No	—
`name_search`	`string`	No	—
`network_ids`	`number[]`	No	—
`new_agent_states`	`boolean`	No	—
`organization_ids`	`number[]`	No	—
`release_channels`	`object`	No	—
`search`	`string`	No	—
`state`	`online \| offline`	No	—
`status`	`string`	No	—
`tags`	`string[]`	No	—
`type`	`proxy \| agents`	No	—

release_channels full type

{
  value?: string,
  operator?: string
}

Output

Name	Type	Required	Description
`all`	`number`	No	—
`protected`	`number`	No	—
`unprotected`	`number`	No	—
`bypassed`	`number`	No	—
`pending_uninstall`	`number`	No	—
`uninstalled`	`number`	No	—

delete

userAgents.delete Delete a user agent Risk: destructive · Irreversible

await corsair.dnsfilter.api.userAgents.delete({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`clear_registry`	`boolean`	No	—
`queue_uninstall`	`boolean`	No	—

Output: undefined

dequeueUninstall

userAgents.dequeueUninstall Dequeue uninstall for user agents Risk: write

await corsair.dnsfilter.api.userAgents.dequeueUninstall({});

Input

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

Output

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

get

userAgents.get Get a user agent Risk: read

await corsair.dnsfilter.api.userAgents.get({});

Input

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

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    agent_type?: proxy | windows | macos | linux | android | ios | embedded | dnsmasq | fingbox | string,
    agent_version?: string,
    client_id?: string,
    hostname?: string,
    status?: active | disabled | uninstalled | uninstalled_from_client | created | string,
    os_version?: string,
    os_name?: string,
    friendly_name?: string,
    tags?: string[],
    meta?: string,
    created_at?: string,
    updated_at?: string,
    uninstalled_at?: string,
    id_hex?: string,
    id_binary?: number[],
    last_sync?: string,
    agent_state?: protected | unprotected | bypassed | uninstalled | string,
    cyber_sight_client?: {
      service_state?: not_installed | operational | disabled | error | string,
      chrome_extension_status?: not_installed | operational | disabled | error | outdated | install_disabled | browser_not_installed | not_communicating | string,
      edge_extension_status?: not_installed | operational | disabled | error | outdated | install_disabled | browser_not_installed | not_communicating | string
    },
    cyber_sight_client_setting?: {
      enable_browser_extension?: boolean
    },
    device_setting?: {
      auto_updates?: boolean,
      enable_cyber_sight?: boolean
    },
    filtering_client_setting?: {
      auto_updates?: boolean,
      connection_method?: inherit | transparent_prox | loopback | string,
      filtering_method?: inherit | precheck | dns_filtering | string,
      fail_over_method?: inherit | fail_open | fail_close | string
    }
  },
  relationships?: {
    network?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    scheduled_policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    }
  }
}

list

userAgents.list List user agents Risk: read

await corsair.dnsfilter.api.userAgents.list({});

Input

Name	Type	Required	Description
`agent_local_user_uuids`	`string[]`	No	—
`agent_state`	`protected \| unprotected \| bypassed \| pending_uninstall \| uninstalled \| offline`	No	—
`agent_type`	`object`	No	—
`agent_version`	`object`	No	—
`auto_update`	`boolean`	No	—
`block_page_id`	`number`	No	—
`browser_extension_status`	`object`	No	—
`cybersight_enabled`	`boolean`	No	—
`cybersight_status`	`object`	No	—
`end_at`	`string`	No	—
`msp_id`	`number`	No	—
`name_search`	`object`	No	—
`network_ids`	`number[]`	No	—
`new_agent_states`	`boolean`	No	—
`organization_ids`	`number[]`	No	—
`page`	`object`	No	—
`policy_id`	`number`	No	—
`policy_schedule`	`string`	No	—
`release_channels`	`object`	No	—
`scheduled_policy_id`	`number`	No	—
`search`	`string`	No	—
`sort`	`string`	No	—
`start_at`	`string`	No	—
`state`	`online \| offline`	No	—
`status`	`string`	No	—
`tags`	`string[]`	No	—
`traffic_received_last_15_mins`	`boolean`	No	—
`type`	`proxy \| agents`	No	—
`vpn_mode`	`object`	No	—
`vpn_status`	`object`	No	—

agent_type full type

{
  value?: string,
  operator?: string
}

agent_version full type

{
  value?: string,
  operator?: string
}

browser_extension_status full type

{
  value?: string,
  operator?: string
}

cybersight_status full type

{
  value?: string,
  operator?: string
}

name_search full type

{
  value?: string,
  operator?: string
}

page full type

{
  number?: number,
  size?: number
}

release_channels full type

{
  value?: string,
  operator?: string
}

vpn_mode full type

{
  value?: string,
  operator?: string
}

vpn_status full type

{
  value?: string,
  operator?: string
}

Output

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

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    agent_type?: proxy | windows | macos | linux | android | ios | embedded | dnsmasq | fingbox | string,
    agent_version?: string,
    client_id?: string,
    hostname?: string,
    status?: active | disabled | uninstalled | uninstalled_from_client | created | string,
    os_version?: string,
    os_name?: string,
    friendly_name?: string,
    tags?: string[],
    meta?: string,
    created_at?: string,
    updated_at?: string,
    uninstalled_at?: string,
    id_hex?: string,
    id_binary?: number[],
    last_sync?: string,
    agent_state?: protected | unprotected | bypassed | uninstalled | string,
    cyber_sight_client?: {
      service_state?: not_installed | operational | disabled | error | string,
      chrome_extension_status?: not_installed | operational | disabled | error | outdated | install_disabled | browser_not_installed | not_communicating | string,
      edge_extension_status?: not_installed | operational | disabled | error | outdated | install_disabled | browser_not_installed | not_communicating | string
    },
    cyber_sight_client_setting?: {
      enable_browser_extension?: boolean
    },
    device_setting?: {
      auto_updates?: boolean,
      enable_cyber_sight?: boolean
    },
    filtering_client_setting?: {
      auto_updates?: boolean,
      connection_method?: inherit | transparent_prox | loopback | string,
      filtering_method?: inherit | precheck | dns_filtering | string,
      fail_over_method?: inherit | fail_open | fail_close | string
    }
  },
  relationships?: {
    network?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    scheduled_policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    }
  }
}[]

links full type

{
  self?: string,
  first?: string,
  prev?: string,
  next?: string,
  last?: string
}

meta full type

{
}

listAll

userAgents.listAll List all user agents Risk: read

await corsair.dnsfilter.api.userAgents.listAll({});

Input

Name	Type	Required	Description
`agent_local_user_uuids`	`string[]`	No	—
`cybersight_enabled`	`boolean`	No	—
`end_at`	`string`	No	—
`network_ids`	`number[]`	No	—
`organization_id`	`number`	No	—
`page`	`object`	No	—
`search`	`string`	No	—
`sort`	`string`	No	—
`start_at`	`string`	No	—
`state`	`online \| offline`	No	—
`status`	`string`	No	—
`tags`	`string[]`	No	—
`type`	`proxy \| agents`	No	—

page full type

{
  number?: number,
  size?: number
}

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`links`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    agent_type?: proxy | windows | macos | linux | android | ios | embedded | dnsmasq | fingbox | string,
    agent_version?: string,
    client_id?: string,
    hostname?: string,
    status?: active | disabled | uninstalled | uninstalled_from_client | created | string,
    os_version?: string,
    os_name?: string,
    friendly_name?: string,
    tags?: string[],
    meta?: string,
    created_at?: string,
    updated_at?: string,
    uninstalled_at?: string,
    id_hex?: string,
    id_binary?: number[],
    last_sync?: string,
    agent_state?: protected | unprotected | bypassed | uninstalled | string,
    cyber_sight_client?: {
      service_state?: not_installed | operational | disabled | error | string,
      chrome_extension_status?: not_installed | operational | disabled | error | outdated | install_disabled | browser_not_installed | not_communicating | string,
      edge_extension_status?: not_installed | operational | disabled | error | outdated | install_disabled | browser_not_installed | not_communicating | string
    },
    cyber_sight_client_setting?: {
      enable_browser_extension?: boolean
    },
    device_setting?: {
      auto_updates?: boolean,
      enable_cyber_sight?: boolean
    },
    filtering_client_setting?: {
      auto_updates?: boolean,
      connection_method?: inherit | transparent_prox | loopback | string,
      filtering_method?: inherit | precheck | dns_filtering | string,
      fail_over_method?: inherit | fail_open | fail_close | string
    }
  },
  relationships?: {
    network?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    scheduled_policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    }
  }
}[]

links full type

{
  self?: string,
  first?: string,
  prev?: string,
  next?: string,
  last?: string
}

uninstallPin

userAgents.uninstallPin Uninstall pin for user agents Risk: read

await corsair.dnsfilter.api.userAgents.uninstallPin({});

Input

Name	Type	Required	Description
`organization_id`	`number`	Yes	—

Output

Name	Type	Required	Description
`pin`	`string`	No	—

update

userAgents.update Update a user agent Risk: write

await corsair.dnsfilter.api.userAgents.update({});

Input

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

user_agent full type

{
  friendly_name?: string,
  status?: active | disabled | uninstalled,
  network_id?: number,
  policy_id?: number,
  scheduled_policy_id?: number,
  block_page_id?: number,
  tags?: string[],
  vpn_settings_user_agent_attributes?: {
    _destroy?: boolean,
    vpn_settings_state_type_id?: number
  }
}

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    agent_type?: proxy | windows | macos | linux | android | ios | embedded | dnsmasq | fingbox | string,
    agent_version?: string,
    client_id?: string,
    hostname?: string,
    status?: active | disabled | uninstalled | uninstalled_from_client | created | string,
    os_version?: string,
    os_name?: string,
    friendly_name?: string,
    tags?: string[],
    meta?: string,
    created_at?: string,
    updated_at?: string,
    uninstalled_at?: string,
    id_hex?: string,
    id_binary?: number[],
    last_sync?: string,
    agent_state?: protected | unprotected | bypassed | uninstalled | string,
    cyber_sight_client?: {
      service_state?: not_installed | operational | disabled | error | string,
      chrome_extension_status?: not_installed | operational | disabled | error | outdated | install_disabled | browser_not_installed | not_communicating | string,
      edge_extension_status?: not_installed | operational | disabled | error | outdated | install_disabled | browser_not_installed | not_communicating | string
    },
    cyber_sight_client_setting?: {
      enable_browser_extension?: boolean
    },
    device_setting?: {
      auto_updates?: boolean,
      enable_cyber_sight?: boolean
    },
    filtering_client_setting?: {
      auto_updates?: boolean,
      connection_method?: inherit | transparent_prox | loopback | string,
      filtering_method?: inherit | precheck | dns_filtering | string,
      fail_over_method?: inherit | fail_open | fail_close | string
    }
  },
  relationships?: {
    network?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    },
    scheduled_policy?: {
      data?: {
        id?: string,
        type?: string,
        uuid?: string
      }
    }
  }
}

User Agents V2

updateSettings

userAgentsV2.updateSettings Update settings for user agents V2 Risk: write

await corsair.dnsfilter.api.userAgentsV2.updateSettings({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	—
`user_agent`	`object`	No	—

user_agent full type

{
  device_setting_attributes?: {
    id?: string,
    enable_cyber_sight?: boolean,
    enable_filtering_client?: boolean,
    diagnostics_level?: unknown | trace | debug | information | warning | error | critical
  },
  filtering_client_setting_attributes?: {
    id?: string,
    connection_method?: unknown | transparent_proxy | loopback,
    filtering_method?: unknown | precheck | dns_filtering,
    fail_over_method?: unknown | fail_open | fail_close
  }
}

Output

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

Users

changePassword

users.changePassword Change password for users Risk: write

await corsair.dnsfilter.api.users.changePassword({});

Input

Name	Type	Required	Description
`new_password`	`string`	No	—

Output

Name	Type	Required	Description
`message`	`string`	No	—

get

users.get Get a user Risk: read

await corsair.dnsfilter.api.users.get({});

Input

Name	Type	Required	Description
`id`	`number \| self`	Yes	—

Output

Name	Type	Required	Description
`data`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    email?: string,
    email_verified?: boolean,
    created_at?: string,
    updated_at?: string,
    has_agreements_to_sign?: boolean,
    can_add_org_to_msps?: {
      id?: number,
      name?: string
    }[]
  }
}

list

users.list List users Risk: read

await corsair.dnsfilter.api.users.list({
	page: { number: 1, size: 25 },
});

Input

Name	Type	Required	Description
`page`	`object`	No	—

page full type

{
  number?: number,
  size?: number
}

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`links`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    email?: string,
    email_verified?: boolean,
    created_at?: string,
    updated_at?: string,
    has_agreements_to_sign?: boolean,
    can_add_org_to_msps?: {
      id?: number,
      name?: string
    }[]
  }
}[]

links full type

{
  self?: string,
  first?: string,
  prev?: string,
  next?: string,
  last?: string
}

listAll

users.listAll List all users Risk: read

await corsair.dnsfilter.api.users.listAll({});

Input

Name	Type	Required	Description
`page`	`object`	No	—

page full type

{
  number?: number,
  size?: number
}

Output

Name	Type	Required	Description
`data`	`object[]`	No	—
`links`	`object`	No	—

data full type

{
  id?: string,
  type?: string,
  uuid?: string,
  attributes?: {
    name?: string,
    email?: string,
    email_verified?: boolean,
    created_at?: string,
    updated_at?: string,
    has_agreements_to_sign?: boolean,
    can_add_org_to_msps?: {
      id?: number,
      name?: string
    }[]
  }
}[]

links full type

{
  self?: string,
  first?: string,
  prev?: string,
  next?: string,
  last?: string
}

​Agent Local User Bulk Deletes

​counts

​create

​get

​Agent Local Users

​delete

​get

​list

​listAll

​update

​Agent Local Users V2

​counts

​Api Keys

​create

​delete

​get

​list

​revoke

​Application Categories

​get

​list

​Applications

​get

​list

​listAll

​Billings

​addressShow

​addressUpdate

​create

​get

​Block Pages

​create

​delete

​get

​list

​listAll

​update

​Categories

​get

​list

​listAll

​Collection Users

​create

​delete

​get

​list

​Csv Exports

​agentLocalUsersCreate

​agentLocalUsersGet

​cyberSightCreate

​cyberSightGet

​networksCreate

​networksGet

​unblockRequestsCreate

​unblockRequestsGet

​userAgentCreate

​userAgentGet

​userAgentsCsv

​Current User Org Ui Settings

​suppressLicenseWarning

​Current Users

​get

​update

​Current User Ui Settings

​get

​update

​Dashboards

​available

​create

​delete

​link

​list

​makePrivate

​makePublic

​owned

​unlink

​update

​Dictionary

​qpMethods

​Dictionary V2

Agent Local User Bulk Deletes

counts

create

get

Agent Local Users

delete

get

list

listAll

update

Agent Local Users V2

counts

Api Keys

create

delete

get

list

revoke

Application Categories

get

list

Applications

get

list

listAll

Billings

addressShow

addressUpdate

create

get

Block Pages

create

delete

get

list

listAll

update

Categories

get

list

listAll

Collection Users

create

delete

get

list

Csv Exports

agentLocalUsersCreate

agentLocalUsersGet

cyberSightCreate

cyberSightGet

networksCreate

networksGet

unblockRequestsCreate

unblockRequestsGet

userAgentCreate

userAgentGet

userAgentsCsv

Current User Org Ui Settings

suppressLicenseWarning

Current Users

get

update

Current User Ui Settings

get

update

Dashboards

available

create

delete

link

list

makePrivate

makePublic

owned

unlink

update

Dictionary

qpMethods

Dictionary V2