Interface IAtlasFirewallClient

Namespace

Quilt4Net.Toolkit.Features.Atlas

Assembly

Quilt4Net.Toolkit.dll

Typed client over Quilt4Net's firewall proxy endpoints for a single Atlas project, bound to one AtlasFirewallProxyKeyEntry (from a value-group bundle). Quilt4Net performs the Atlas change; the caller never holds an Atlas credential. Create via IAtlasFirewallClientFactory.

public interface IAtlasFirewallClient

Methods

CloseAsync(string, CancellationToken)

Close (remove) ip from the access list. Requires a manage key.

Task<FirewallCloseResult> CloseAsync(string ip, CancellationToken cancellationToken = default)

Parameters

ip string

cancellationToken CancellationToken

Returns

Task<FirewallCloseResult>

GetStateAsync(string, CancellationToken)

Current state of ip, or null if it is neither tracked nor open. Works with any firewall key.

Task<FirewallStateResult> GetStateAsync(string ip, CancellationToken cancellationToken = default)

Parameters

ip string

cancellationToken CancellationToken

Returns

Task<FirewallStateResult>

OpenAsync(string, string, CancellationToken)

Open ip (IP or CIDR) on the project's access list. Requires a manage key. Idempotent.

Task<FirewallOpenResult> OpenAsync(string ip, string name = null, CancellationToken cancellationToken = default)

Parameters

ip string

name string

cancellationToken CancellationToken

Returns

Task<FirewallOpenResult>

ReportUsedAsync(string, CancellationToken)

Report that ip is in use so Quilt4Net defers auto-closing it (heartbeat). Works with any firewall key.

Task<FirewallUsageResult> ReportUsedAsync(string ip, CancellationToken cancellationToken = default)

Parameters

ip string

cancellationToken CancellationToken

Returns

Task<FirewallUsageResult>