runzero.api.hosted_zones#

Management of an Organization’s hosted zones, which perform scan activity.

Module Contents#

Classes#

HostedZones

Management of runZero hosted zones.
class runzero.api.hosted_zones.HostedZones(client: runzero.client.Client)[source]#

Management of runZero hosted zones.

A hosted zone is a pool of cloud-hosted runzero.api.Explorers available to Enterprise customers.

Instead of specifing a single manually deployed explorer, a hosted zone may be specified when working with runzero.api.Tasks or runzero.api.Templates. Hosted zones can only reach public IP space.

Parameters:

client (runzero.client.Client) – A handle to the runzero.Client client which manages interactions with the runZero server.

Constructor method

get(org_id: uuid.UUID, name: str | None = None, hosted_zone_id: uuid.UUID | None = None) → runzero.types.HostedZone | None[source]#

Retrieves the runZero hosted zone with the provided name or id, if it is active and exists in the Organization.

Parameters:

  • org_id (uuid.UUID) – The ID of the organization to operate against

  • name (Optional[str]) – Optional name of the hosted zone to retrieve. This is a case-insensitive match. If not provided, must provide hosted_zone_id.

  • hosted_zone_id (Optional[uuid.UUID]) – Optional id of the hosted zone to retrieve. If not provided, must provide name.

Returns:

HostedZone requested or None

Raises:

AuthError, ClientError, ServerError, ValueError if neither hosted_zone_id nor name are provided.

Return type:

Optional[runzero.types.HostedZone]

get_all(org_id: uuid.UUID) → List[runzero.types.HostedZone][source]#

Retrieves all active runZero hosted zones available within the given organization.

Parameters:

org_id (uuid.UUID) – The ID of the organization to operate against

Returns:

list of HostedZones

Raises:

AuthError, ClientError, ServerError

Return type:

List[runzero.types.HostedZone]