Network Scan Global Configs

Operations for the Network Scan Global Configs service collection.

Language	Last Update
Python	v1.6.5
PowerShell
Go	v0.22.0
TypeScript	v0.6.0
Rust
Ruby	v1.4.0

---

---

Table of Contents

Operation	Description
get-global-configs get_global_configs	Get “global-configs” for the CID
update-global-configs update_global_configs	Update “global-configs” using provided specifications

---

get-global-configs

Get “global-configs” for the CID

Method GET

Route /netscan/entities/global-configs/v1

Scope Network scanning: READ

PEP 8 get_global_configs

Code Examples

Python

PEP 8

from falconpy import NetworkScanGlobalConfigs

falcon = NetworkScanGlobalConfigs(client_id=CLIENT_ID,
                                  client_secret=CLIENT_SECRET
                                  )

response = falcon.get_global_configs()
print(response)

Operation ID

from falconpy import NetworkScanGlobalConfigs

falcon = NetworkScanGlobalConfigs(client_id=CLIENT_ID,
                                  client_secret=CLIENT_SECRET
                                  )

response = falcon.get_global_configs()
print(response)

Uber

from falconpy import APIHarnessV2

falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

response = falcon.command("get_global_configs")
print(response)

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/network_scan_global_configs"
)

func main() {
  client, err := falcon.NewClient(&falcon.ApiConfig{
    ClientId:     os.Getenv("FALCON_CLIENT_ID"),
    ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"),
    Context:      context.Background(),
  })
  if err != nil {
    panic(err)
  }

  xCSUSERUUID := "string"

  response, err := client.NetworkScanGlobalConfigs.GetGlobalConfigs(
    &network_scan_global_configs.GetGlobalConfigsParams{
      XCSUSERUUID: &xCSUSERUUID,
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: process.env.FALCON_CLOUD!,
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.networkScanGlobalConfigs.getGlobalConfigs();

console.log(response);

Rust

Examples coming soon.

Ruby

require "crimson-falcon"

Falcon.configure do |config|
  config.client_id = ENV["FALCON_CLIENT_ID"]
  config.client_secret = ENV["FALCON_CLIENT_SECRET"]
  config.cloud = ENV["FALCON_CLOUD"]
end

api = Falcon::NetworkScanGlobalConfigs.new

response = api.get_global_configs

puts response

Responses

200 OK

[
  {
    "auto_confirm_ownership": {},
    "cid": "string",
    "created_by": "string",
    "created_timestamp": "string",
    "managed_host_group": {},
    "max_concurrent_tasks": 0,
    "network_scanning_enabled": false,
    "scan_exclusion": {},
    "scanners": [],
    "scanners_exclusion": [],
    "updated_by": "string",
    "updated_timestamp": "string"
  }
]

400 Bad Request

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

403 Forbidden

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

404 Forbidden

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

429 Too Many Requests

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

500 Internal Server Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

---

---

update-global-configs

Update “global-configs” using provided specifications

Method PATCH

Route /netscan/entities/global-configs/v1

Scope Network scanning: WRITE

PEP 8 update_global_configs

Parameters

body body · dictionary

Full body payload as JSON formatted dictionary.

auto_confirm_ownership body · object

Conditions for auto confirmation of network ownership

max_concurrent_tasks body · integer

Maximum scan tasks to run in parallel

network_scanning_enabled body · boolean

Attempts to stop ongoing network scans and disables further scans from being executed

scan_exclusion body · object

Describes scan target exclusions including common as well as zone-level like individual IPs, IP ranges, CIDRs (and CIDRs from Network subnets)

scanners body · array

Describes the list of assets that will act as eligible scanners

scanners_exclusion body · array

Describes the list of assets that will always be excluded from being selected as scanners

Code Examples

Python

PEP 8

from falconpy import NetworkScanGlobalConfigs

falcon = NetworkScanGlobalConfigs(client_id=CLIENT_ID,
                                  client_secret=CLIENT_SECRET
                                  )

auto_confirm_ownership = {
    "min_managed_assets": "integer"
}

scan_exclusion = {
    "exclude_all_managed_hosts": "boolean",
    "host_groups": [
        "string"
    ],
    "hosts": [
        "string"
    ],
    "zone_level_scan_exclusions": [
        {
            "cidrs": [
                "string"
            ],
            "host_groups": [
                "string"
            ],
            "hosts": [
                "string"
            ],
            "scan_zone_id": "string"
        }
    ]
}

scanners = [
    {
        "enabled": "boolean",
        "id": "string",
        "type": "string"
    }
]

scanners_exclusion = [
    {
        "enabled": "boolean",
        "id": "string",
        "type": "string"
    }
]

response = falcon.update_global_configs(auto_confirm_ownership=auto_confirm_ownership,
                                        max_concurrent_tasks=integer,
                                        network_scanning_enabled=boolean,
                                        scan_exclusion=scan_exclusion,
                                        scanners=scanners,
                                        scanners_exclusion=scanners_exclusion)
print(response)

Operation ID

from falconpy import NetworkScanGlobalConfigs

falcon = NetworkScanGlobalConfigs(client_id=CLIENT_ID,
                                  client_secret=CLIENT_SECRET
                                  )

auto_confirm_ownership = {
    "min_managed_assets": "integer"
}

scan_exclusion = {
    "exclude_all_managed_hosts": "boolean",
    "host_groups": [
        "string"
    ],
    "hosts": [
        "string"
    ],
    "zone_level_scan_exclusions": [
        {
            "cidrs": [
                "string"
            ],
            "host_groups": [
                "string"
            ],
            "hosts": [
                "string"
            ],
            "scan_zone_id": "string"
        }
    ]
}

scanners = [
    {
        "enabled": "boolean",
        "id": "string",
        "type": "string"
    }
]

scanners_exclusion = [
    {
        "enabled": "boolean",
        "id": "string",
        "type": "string"
    }
]

response = falcon.update_global_configs(auto_confirm_ownership=auto_confirm_ownership,
                                        max_concurrent_tasks=integer,
                                        network_scanning_enabled=boolean,
                                        scan_exclusion=scan_exclusion,
                                        scanners=scanners,
                                        scanners_exclusion=scanners_exclusion)
print(response)

Uber

from falconpy import APIHarnessV2

falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

body_payload = {
    "auto_confirm_ownership": {
        "min_managed_assets": integer
    },
    "max_concurrent_tasks": integer,
    "network_scanning_enabled": boolean,
    "scan_exclusion": {
        "exclude_all_managed_hosts": boolean,
        "host_groups": ["string"],
        "hosts": ["string"],
        "zone_level_scan_exclusions": [
            {
                "cidrs": ["string"],
                "ip_ranges": ["string"],
                "ips": ["string"],
                "zone_id": "string"
            }
        ]
    },
    "scanners": [
        {
            "enabled": boolean,
            "id": "string",
            "type": "string"
        }
    ],
    "scanners_exclusion": [
        {
            "enabled": boolean,
            "id": "string",
            "type": "string"
        }
    ]
}

response = falcon.command("update_global_configs", body=body_payload)
print(response)

PowerShell

Examples coming soon.

Go

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/network_scan_global_configs"
  "github.com/crowdstrike/gofalcon/falcon/models"
)

func main() {
  client, err := falcon.NewClient(&falcon.ApiConfig{
    ClientId:     os.Getenv("FALCON_CLIENT_ID"),
    ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"),
    Context:      context.Background(),
  })
  if err != nil {
    panic(err)
  }

  max_concurrent_tasks := integer
  network_scanning_enabled := boolean
  enabled := boolean
  id := "string"
  typeVar := "string"

  response, err := client.NetworkScanGlobalConfigs.UpdateGlobalConfigs(
    &network_scan_global_configs.UpdateGlobalConfigsParams{
      Body: &models.DomainGlobalConfigUpdateRequest{
        AutoConfirmOwnership: &struct{}{},
        MaxConcurrentTasks: &max_concurrent_tasks,
        NetworkScanningEnabled: &network_scanning_enabled,
        ScanExclusion: &struct{}{},
        Scanners: []interface{}{
          {
          Enabled: &enabled,
          ID: &id,
          Type: &typeVar,
          },
        },
        ScannersExclusion: []interface{}{
          {
          Enabled: &enabled,
          ID: &id,
          Type: &typeVar,
          },
        },
      },
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

TypeScript

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: process.env.FALCON_CLOUD!,
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.networkScanGlobalConfigs.updateGlobalConfigs(
  {
    autoConfirmOwnership: {
      minManagedAssets: integer
    },
    maxConcurrentTasks: integer,
    networkScanningEnabled: boolean,
    scanExclusion: {
      excludeAllManagedHosts: boolean,
      hostGroups: [],
      hosts: [],
      zoneLevelScanExclusions: [{
          cidrs: [],
          ipRanges: [],
          ips: [],
          zoneId: "string"
        }]
    },
    scanners: [{
        enabled: boolean,
        id: "string",
        type: "string"
      }],
    scannersExclusion: [{
        enabled: boolean,
        id: "string",
        type: "string"
      }]
}  // body
);

console.log(response);

Rust

Examples coming soon.

Ruby

require "crimson-falcon"

Falcon.configure do |config|
  config.client_id = ENV["FALCON_CLIENT_ID"]
  config.client_secret = ENV["FALCON_CLIENT_SECRET"]
  config.cloud = ENV["FALCON_CLOUD"]
end

api = Falcon::NetworkScanGlobalConfigs.new

body = Falcon::DomainGlobalConfigUpdateRequest.new(
  auto_confirm_ownership: {
    min_managed_assets: integer
  },
  max_concurrent_tasks: integer,
  network_scanning_enabled: boolean,
  scan_exclusion: {
    exclude_all_managed_hosts: boolean,
    host_groups: [],
    hosts: [],
    zone_level_scan_exclusions: [{
        cidrs: [],
        ip_ranges: [],
        ips: [],
        zone_id: 'string'
      }]
  },
  scanners: [{
      enabled: boolean,
      id: 'string',
      type: 'string'
    }],
  scanners_exclusion: [{
      enabled: boolean,
      id: 'string',
      type: 'string'
    }]
)

response = api.update_global_configs(body)

puts response

Responses

200 OK

[
  {
    "auto_confirm_ownership": {},
    "cid": "string",
    "created_by": "string",
    "created_timestamp": "string",
    "managed_host_group": {},
    "max_concurrent_tasks": 0,
    "network_scanning_enabled": false,
    "scan_exclusion": {},
    "scanners": [],
    "scanners_exclusion": [],
    "updated_by": "string",
    "updated_timestamp": "string"
  }
]

400 Bad Request

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

403 Forbidden

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

404 Forbidden

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

409 Conflict

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

413 Request Entity Too Large

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

429 Too Many Requests

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

500 Internal Server Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}