Scans

ScansResults

Get the Latest Scan Result

cloudforce_one.scans.results.get(, ) -> ResultGetResponse

GET/accounts/{account_id}/cloudforce-one/scans/results/{config_id}

ModelsExpand Collapse

class ScanResult: …

number: Optional[float]

proto: Optional[str]

status: Optional[str]

class ResultGetResponse: …

_1_1_1_1: List[ScanResult]

number: Optional[float]

proto: Optional[str]

status: Optional[str]

ScansConfig

List Scan Configs

cloudforce_one.scans.config.list() -> SyncSinglePage[ConfigListResponse]

GET/accounts/{account_id}/cloudforce-one/scans/config

Create a new Scan Config

cloudforce_one.scans.config.create() -> ConfigCreateResponse

POST/accounts/{account_id}/cloudforce-one/scans/config

Update an existing Scan Config

cloudforce_one.scans.config.edit(, ) -> ConfigEditResponse

PATCH/accounts/{account_id}/cloudforce-one/scans/config/{config_id}

Delete a Scan Config

cloudforce_one.scans.config.delete(, ) -> object

DELETE/accounts/{account_id}/cloudforce-one/scans/config/{config_id}

ModelsExpand Collapse

class ConfigListResponse: …

id: str

Defines the Config ID.

account_id: str

frequency: float

Defines the number of days between each scan (0 = One-off scan).

ips: List[str]

Defines a list of IP addresses or CIDR blocks to scan. The maximum number of total IP addresses allowed is 5000.

ports: List[str]

Defines a list of ports to scan. Valid values are:"default", "all", or a comma-separated list of ports or range of ports (e.g. ["1-80", "443"]). "default" scans the 100 most commonly open ports.

class ConfigCreateResponse: …

id: str

Defines the Config ID.

account_id: str

frequency: float

Defines the number of days between each scan (0 = One-off scan).

ips: List[str]

Defines a list of IP addresses or CIDR blocks to scan. The maximum number of total IP addresses allowed is 5000.

ports: List[str]

Defines a list of ports to scan. Valid values are:"default", "all", or a comma-separated list of ports or range of ports (e.g. ["1-80", "443"]). "default" scans the 100 most commonly open ports.

class ConfigEditResponse: …

id: str

Defines the Config ID.

account_id: str

frequency: float

Defines the number of days between each scan (0 = One-off scan).

ips: List[str]

Defines a list of IP addresses or CIDR blocks to scan. The maximum number of total IP addresses allowed is 5000.

ports: List[str]

Defines a list of ports to scan. Valid values are:"default", "all", or a comma-separated list of ports or range of ports (e.g. ["1-80", "443"]). "default" scans the 100 most commonly open ports.