runzero.types

types provides the Pydantic data model representations of the runZero Platform API schema, as well as other data types which wrap looser runZero API data.

Public, SDK-supported runZero API types contained inside this package are made available here. Not all objects in the private module, which is generated from OpenAPI specs, are usable in this project today.

Submodules

Package Contents

Classes

BaseCustomIntegration

CustomAttribute

DEPRECATION NOTICE:

CustomIntegration

CustomIntegration represents a custom asset data source for custom integrations use

Explorer

A deployed service which performs scan tasks.

ExplorerSiteID

HostedZone

A hosted service which performs scan tasks. Hosted zones are only available to

Hostname

Hostname the dns name the asset is assigned or reachable at.

ImportAsset

Represents a custom asset to be created or merged after import.

ImportTask

Information which describes the task created when asset data is imported.

NetworkInterface

Represents the Network Interface of an asset to be imported.

NewAssetImport

Represents a request to import asset data described by the specified custom integration into the specified site.

NewCustomIntegration

OrgOptions

Organization

Problem

RFC7807 Problem JSON object from https://opensource.zalando.com/restful-api-guidelines/models/problem-1.0.1.yaml without the standard 'type' and 'instance' fields.

RateLimitInformation

Describes rate limits to API users.

ScanOptions

Options which can be set to create or modify a scan.

ScanTemplate

A scan template object

ScanTemplateOptions

Options which can be set to create or modify a scan template.

Service

A service running on an asset.

ServiceProtocolData

ServiceProtocolData represents the attributes associated with a given service protocol

Site

SiteOptions

Software

Represents a piece of installed software on a particular asset.

Tag

Tag is an arbitrary string classifier applied to the asset.

Task

A task object

TaskOptions

Options which can be set to create or modify a task.

Vulnerability

Represents a vulnerability present on a particular asset.