Module schema 

Wire types and per-endpoint methods generated from canopy’s OpenAPI document.

Regenerate with just gen-api after changing the public API; the generated source is committed, so a change to this surface appears in the change that causes it.

Modules

error

Error types.

Structs

ApplicationEntitlements

What one application on the asking machine may act on.

ApplicationEntitlementsBuilder

Use builder syntax to set the inputs and finish with build().

ApplicationReport

One application within a push, as the reporter found it.

ApplicationReportBuilder

Use builder syntax to set the inputs and finish with build().

ApplicationType

What an application is: the software and the role it plays, as a slug. The set is open — a report carrying a type Canopy does not know creates an application of that type, which simply carries no per-type capabilities.

Artifact

A downloadable artifact belonging to a release version: an installer, package, or other file published for a given type and platform.

ArtifactBuilder

Use builder syntax to set the inputs and finish with build().

BTreeMap

BTreeMap

BTreeMapValue

Describes one configurable parameter that a replica of a restore intent accepts.

BTreeMapValueBuilder

Use builder syntax to set the inputs and finish with build().

BackupCapabilitiesArgs

Request body for registering the backup types a server can run.

BackupCapabilitiesArgsBuilder

Use builder syntax to set the inputs and finish with build().

BackupCredentialsArgs

Request body for minting short-lived S3 credentials for a backup or restore run.

BackupCredentialsArgsBuilder

Use builder syntax to set the inputs and finish with build().

BackupTarget

The backup storage target for the calling server’s group: where the backup repository lives and the passphrase to open it.

BackupTargetBuilder

Use builder syntax to set the inputs and finish with build().

BeginArgs

Request to start device enrollment against a machine.

BeginArgsBuilder

Use builder syntax to set the inputs and finish with build().

BeginResponse

A freshly-issued enrollment challenge to sign and return.

BeginResponseBuilder

Use builder syntax to set the inputs and finish with build().

CertificateResponse

Where a certificate request stands, and the chain once there is one.

CertificateResponseBuilder

Use builder syntax to set the inputs and finish with build().

CompleteArgs

Request to complete device enrollment by presenting a signed challenge obtained from the start-enrollment endpoint.

CompleteArgsBuilder

Use builder syntax to set the inputs and finish with build().

CompleteResponse

Result of a successful enrollment.

CompleteResponseBuilder

Use builder syntax to set the inputs and finish with build().

CredentialProcessOutput

Short-lived AWS credentials in the AWS credential_process output format, so they can be consumed directly by AWS SDKs and tools. Field names use the exact casing (Version, AccessKeyId, …) that format requires.

CredentialProcessOutputBuilder

Use builder syntax to set the inputs and finish with build().

Entitlements

What a server is entitled to do with names, and what it already holds.

EntitlementsBuilder

Use builder syntax to set the inputs and finish with build().

HealthCheck

One health-check result within a status push.

HealthCheckBuilder

Use builder syntax to set the inputs and finish with build().

HeldCertificate

A certificate Canopy holds for the asking server, as the server needs to see it: enough to decide whether to renew, and nothing about anyone else.

HeldCertificateBuilder

Use builder syntax to set the inputs and finish with build().

IntentDescriptor

One restore purpose a consumer advertises support for: the behaviours it opts into and the settings it accepts per replica.

IntentDescriptorBuilder

Use builder syntax to set the inputs and finish with build().

MachineSelfResponse

The calling identity, the box it is enrolled as, and what runs on that box.

MachineSelfResponseBuilder

Use builder syntax to set the inputs and finish with build().

MigrationArgs

How the target version’s migrations went against the restored replica.

MigrationArgsBuilder

Use builder syntax to set the inputs and finish with build().

MigrationTimingArgs

How long one migration took.

MigrationTimingArgsBuilder

Use builder syntax to set the inputs and finish with build().

ProblemDetailsSchema

Standard error response body, returned for every non-2xx response.

ProblemDetailsSchemaBuilder

Use builder syntax to set the inputs and finish with build().

ProgressArgs

A progress sample from a run still in flight.

ProgressArgsBuilder

Use builder syntax to set the inputs and finish with build().

PublicServer

A publicly-listed central server that a client can connect to.

PublicServerBuilder

Use builder syntax to set the inputs and finish with build().

RedactionArgs

How the masking manifest went against the restored replica.

RedactionArgsBuilder

Use builder syntax to set the inputs and finish with build().

RegisterNameArgs

The name a server should be reachable at, and where.

RegisterNameArgsBuilder

Use builder syntax to set the inputs and finish with build().

RegisteredName

What Canopy holds for a registered name.

RegisteredNameBuilder

Use builder syntax to set the inputs and finish with build().

ReportArgs

Report of a completed backup or restore run.

ReportArgsBuilder

Use builder syntax to set the inputs and finish with build().

RequestCertificateArgs

A request to certify a key for a name.

RequestCertificateArgsBuilder

Use builder syntax to set the inputs and finish with build().

RestoreCapabilitiesArgs

Request body for registering the restore intents a consumer device can satisfy.

RestoreCapabilitiesArgsBuilder

Use builder syntax to set the inputs and finish with build().

RestoreCredentials

Read-only S3 credentials plus the repository passphrase for one group and backup type: everything needed to open the group’s backup repository and read a snapshot out of it.

RestoreCredentialsArgs

Request body for minting read-only restore credentials.

RestoreCredentialsArgsBuilder

Use builder syntax to set the inputs and finish with build().

RestoreCredentialsBuilder

Use builder syntax to set the inputs and finish with build().

SelfResponse

The calling device’s own identity, as assigned at enrollment.

SelfResponseBuilder

Use builder syntax to set the inputs and finish with build().

SnippetResponse

A single named SQL snippet from the bestool snippet library.

SnippetResponseBuilder

Use builder syntax to set the inputs and finish with build().

StatusPayload

A status push: a server’s periodic heartbeat carrying its self-reported health.

StatusPayloadBuilder

Use builder syntax to set the inputs and finish with build().

StatusResponse

The status-push response: only the return-path instructions the device can act on. The stored status record is deliberately not echoed back — the device already has everything it sent.

StatusResponseBuilder

Use builder syntax to set the inputs and finish with build().

TagMap

Free-form key/value tags, as a JSON object whose values are all strings.

TargetReport

One target’s material within a push: its health checks and its detail.

TargetReportBuilder

Use builder syntax to set the inputs and finish with build().

TargetResponse

What Canopy answers about one target the push described.

TargetResponseBuilder

Use builder syntax to set the inputs and finish with build().

UrlField

A URL, given as a plain string. Any trailing slash is stripped when the value is returned.

VerificationArgs

Report of a restore attempt and the health of the resulting replica.

VerificationArgsBuilder

Use builder syntax to set the inputs and finish with build().

Version

A release version of the monitored software, with its publication status and changelog.

VersionBuilder

Use builder syntax to set the inputs and finish with build().

ViewVersion

A release version as returned by the version-listing endpoints: the version numbers, publication status, and changelog.

ViewVersionBuilder

Use builder syntax to set the inputs and finish with build().

WorklistEntry

One replica the consumer device should currently maintain: an operator declaration expanded against a single server, carrying the snapshot to restore and the repository coordinates to find it. S3 credentials and the repository passphrase are obtained separately via POST /restore-credentials.

WorklistEntryBuilder

Use builder syntax to set the inputs and finish with build().

Enums

BackupPurpose

Why a backup credential was issued, or what a reported run was for. Determines the access the credential grants: a backup credential can write new data but not delete existing data, while a restore credential is read-only.

CheckResult

Outcome of a single health check reported in a server’s status update.

CheckSeverity

How a server should treat one of its healthchecks, distilled from canopy’s operator-side configuration (the policy catalog and the silences) into a three-level device-facing vocabulary.

ParamType

The data type of a restore-replica configuration parameter, which determines how its value is validated. duration and bytes values must be non-negative integers (a count of seconds and of bytes, respectively); integer accepts any whole number, positive or negative; boolean is a JSON boolean; text is a JSON string.

RunOutcome

Outcome of a reported backup or restore run.

ServerRank

The environment tier of a server, from production down to dev.

VersionStatus

Publication status of a release version.

Constants

OPENAPI_BLAKE3

BLAKE3 digest of that document, so a document that changed without the version moving with it can be told from one that did not.

OPENAPI_VERSION

Version of the OpenAPI document this source was generated from, which is also this crate’s own version.