Connectors
List Connectors
Fetch Connector
Create Connector
Replace Connector
Update Connector
Delete Connector
ModelsExpand Collapse
ConnectorsEvents
List Events
Fetch Event
ModelsExpand Collapse
class EventGetResponse: …Recorded Event
Recorded Event
e: EEvent kind plus event-specific payload fields.
Event kinds:
Init: Initialized process
Leave: Stopped process
StartAttestation: Started attestation
FinishAttestationSuccess: Finished attestation
FinishAttestationFailure: Failed attestation
StartRotateCryptKey: Started crypt key rotation
FinishRotateCryptKeySuccess: Finished crypt key rotation
FinishRotateCryptKeyFailure: Failed crypt key rotation
StartRotatePki: Started PKI rotation
FinishRotatePkiSuccess: Finished PKI rotation
FinishRotatePkiFailure: Failed PKI rotation
StartUpgrade: Started upgrade
FinishUpgradeSuccess: Finished upgrade
FinishUpgradeFailure: Failed upgrade
Reconcile: Reconciled
ConfigureCloudflaredTunnel: Configured Cloudflared tunnel
RekeyInstallBoth: Installed initial inbound and outbound keys
RekeyStart: Installed new inbound key, kept old outbound
RekeyRestart: Restarted in-progress rekey with newer key material
RekeyAdvance: Confirmed traffic on new inbound key, swapped outbound to new
RekeyComplete: Deleted old keys
RekeyReset: Deleted all keys after receiving an unexpected key
Event kind plus event-specific payload fields.
Event kinds:
Init: Initialized processLeave: Stopped processStartAttestation: Started attestationFinishAttestationSuccess: Finished attestationFinishAttestationFailure: Failed attestationStartRotateCryptKey: Started crypt key rotationFinishRotateCryptKeySuccess: Finished crypt key rotationFinishRotateCryptKeyFailure: Failed crypt key rotationStartRotatePki: Started PKI rotationFinishRotatePkiSuccess: Finished PKI rotationFinishRotatePkiFailure: Failed PKI rotationStartUpgrade: Started upgradeFinishUpgradeSuccess: Finished upgradeFinishUpgradeFailure: Failed upgradeReconcile: ReconciledConfigureCloudflaredTunnel: Configured Cloudflared tunnelRekeyInstallBoth: Installed initial inbound and outbound keysRekeyStart: Installed new inbound key, kept old outboundRekeyRestart: Restarted in-progress rekey with newer key materialRekeyAdvance: Confirmed traffic on new inbound key, swapped outbound to newRekeyComplete: Deleted old keysRekeyReset: Deleted all keys after receiving an unexpected key
ConnectorsEventsLatest
Fetch latest Events
ModelsExpand Collapse
class LatestListResponse: …
items: List[Item]
e: ItemEEvent kind plus event-specific payload fields.
Event kinds:
Init: Initialized process
Leave: Stopped process
StartAttestation: Started attestation
FinishAttestationSuccess: Finished attestation
FinishAttestationFailure: Failed attestation
StartRotateCryptKey: Started crypt key rotation
FinishRotateCryptKeySuccess: Finished crypt key rotation
FinishRotateCryptKeyFailure: Failed crypt key rotation
StartRotatePki: Started PKI rotation
FinishRotatePkiSuccess: Finished PKI rotation
FinishRotatePkiFailure: Failed PKI rotation
StartUpgrade: Started upgrade
FinishUpgradeSuccess: Finished upgrade
FinishUpgradeFailure: Failed upgrade
Reconcile: Reconciled
ConfigureCloudflaredTunnel: Configured Cloudflared tunnel
RekeyInstallBoth: Installed initial inbound and outbound keys
RekeyStart: Installed new inbound key, kept old outbound
RekeyRestart: Restarted in-progress rekey with newer key material
RekeyAdvance: Confirmed traffic on new inbound key, swapped outbound to new
RekeyComplete: Deleted old keys
RekeyReset: Deleted all keys after receiving an unexpected key
Event kind plus event-specific payload fields.
Event kinds:
Init: Initialized processLeave: Stopped processStartAttestation: Started attestationFinishAttestationSuccess: Finished attestationFinishAttestationFailure: Failed attestationStartRotateCryptKey: Started crypt key rotationFinishRotateCryptKeySuccess: Finished crypt key rotationFinishRotateCryptKeyFailure: Failed crypt key rotationStartRotatePki: Started PKI rotationFinishRotatePkiSuccess: Finished PKI rotationFinishRotatePkiFailure: Failed PKI rotationStartUpgrade: Started upgradeFinishUpgradeSuccess: Finished upgradeFinishUpgradeFailure: Failed upgradeReconcile: ReconciledConfigureCloudflaredTunnel: Configured Cloudflared tunnelRekeyInstallBoth: Installed initial inbound and outbound keysRekeyStart: Installed new inbound key, kept old outboundRekeyRestart: Restarted in-progress rekey with newer key materialRekeyAdvance: Confirmed traffic on new inbound key, swapped outbound to newRekeyComplete: Deleted old keysRekeyReset: Deleted all keys after receiving an unexpected key
ConnectorsSnapshots
List Snapshots
Fetch Snapshot
ModelsExpand Collapse
class SnapshotGetResponse: …Snapshot
Snapshot
Numeric value associated with high availability state (0 = disabled, 1 = active, 2 = standby, 3 = stopped, 4 = fault)
Percentage of time over a 10 second window that all tasks were stalled
Percentage of time over a 5 minute window that all tasks were stalled
Percentage of time over a 1 minute window that all tasks were stalled
Percentage of time over a 10 second window that some tasks were stalled
Percentage of time over a 3 minute window that some tasks were stalled
Percentage of time over a 1 minute window that some tasks were stalled
Number of kernel scheduling entities that currently exist on the system
Non-file backed huge pages mapped into user-space page tables
Estimate of how much memory is available for starting new applications
Total amount of memory currently available to be allocated on the system
The number of huge pages in the pool that are not yet allocated
Number of huge pages for which a commitment has been made, but no allocation has yet been made
Kernel allocations that the kernel will attempt to reclaim under memory pressure
Amount of memory dedicated to the lowest level of page tables
Memory allocated to the per-cpu alloctor used to back per-cpu allocations
Percentage of time over a 10 second window that all tasks were stalled
Percentage of time over a 5 minute window that all tasks were stalled
Percentage of time over a 1 minute window that all tasks were stalled
Percentage of time over a 10 second window that some tasks were stalled
Percentage of time over a 5 minute window that some tasks were stalled
Percentage of time over a 1 minute window that some tasks were stalled
Amount of memory dedicated to the lowest level of page tables
Memory used by shmem and tmpfs, allocated with huge pages
Number of ICMP messages which this entity did not send due to ICMP-specific errors
Number of input datagrams discarded due to errors in the IP address
Number of input datagrams successfully delivered to IP user-protocols
Number of input datagrams discarded due to errors in the IP header
Number of input datagrams discarded due unknown or unsupported protocol
Number of seconds fragments are held while awaiting reassembly
Number of times TCP transitions to CLOSED from SYN-SENT or SYN-RCVD, plus transitions to LISTEN from SYN-RCVD
Number of times TCP transitions to CLOSED from ESTABLISHED or CLOSE-WAIT
Maximum value permitted by a TCP implementation for the retransmission timeout (milliseconds)
Minimum value permitted by a TCP implementation for the retransmission timeout (milliseconds)
Number of UDP datagrams failed to be delivered for reasons other than lack of application at the destination port
Number of UDP datagrams received for which there was not application at the destination port
tunnels: Optional[List[Tunnel]]
Numeric value associated with tunnel state (0 = unknown, 1 = healthy, 2 = degraded, 3 = down)
Numeric NAT detector state (0 = detected, 1 = missing result, 2 = stale result)
ConnectorsSnapshotsLatest
Fetch latest Snapshots
ModelsExpand Collapse
class LatestListResponse: …
items: List[Item]
Numeric value associated with high availability state (0 = disabled, 1 = active, 2 = standby, 3 = stopped, 4 = fault)
Percentage of time over a 10 second window that all tasks were stalled
Percentage of time over a 5 minute window that all tasks were stalled
Percentage of time over a 1 minute window that all tasks were stalled
Percentage of time over a 10 second window that some tasks were stalled
Percentage of time over a 3 minute window that some tasks were stalled
Percentage of time over a 1 minute window that some tasks were stalled
Number of kernel scheduling entities that currently exist on the system
Non-file backed huge pages mapped into user-space page tables
Estimate of how much memory is available for starting new applications
Total amount of memory currently available to be allocated on the system
The number of huge pages in the pool that are not yet allocated
Number of huge pages for which a commitment has been made, but no allocation has yet been made
Kernel allocations that the kernel will attempt to reclaim under memory pressure
Amount of memory dedicated to the lowest level of page tables
Memory allocated to the per-cpu alloctor used to back per-cpu allocations
Percentage of time over a 10 second window that all tasks were stalled
Percentage of time over a 5 minute window that all tasks were stalled
Percentage of time over a 1 minute window that all tasks were stalled
Percentage of time over a 10 second window that some tasks were stalled
Percentage of time over a 5 minute window that some tasks were stalled
Percentage of time over a 1 minute window that some tasks were stalled
Amount of memory dedicated to the lowest level of page tables
Memory used by shmem and tmpfs, allocated with huge pages
Number of ICMP messages which this entity did not send due to ICMP-specific errors
Number of input datagrams discarded due to errors in the IP address
Number of input datagrams successfully delivered to IP user-protocols
Number of input datagrams discarded due to errors in the IP header
Number of input datagrams discarded due unknown or unsupported protocol
Number of seconds fragments are held while awaiting reassembly
Number of times TCP transitions to CLOSED from SYN-SENT or SYN-RCVD, plus transitions to LISTEN from SYN-RCVD
Number of times TCP transitions to CLOSED from ESTABLISHED or CLOSE-WAIT
Maximum value permitted by a TCP implementation for the retransmission timeout (milliseconds)
Minimum value permitted by a TCP implementation for the retransmission timeout (milliseconds)
Number of UDP datagrams failed to be delivered for reasons other than lack of application at the destination port
Number of UDP datagrams received for which there was not application at the destination port
tunnels: Optional[List[ItemTunnel]]
Numeric value associated with tunnel state (0 = unknown, 1 = healthy, 2 = degraded, 3 = down)
Numeric NAT detector state (0 = detected, 1 = missing result, 2 = stale result)