PostQ.Sdk 0.5.0

PostQ.Sdk

Official PostQ SDK for .NET. Submit quantum-risk scans and read results from the PostQ API.

dotnet add package PostQ.Sdk

Quickstart

using PostQ;

using var pq = new PostQClient(new PostQClientOptions
{
    ApiKey = Environment.GetEnvironmentVariable("POSTQ_API_KEY")!,
});

// Submit a scan
var result = await pq.Scans.SubmitAsync(new ScanSubmitInput
{
    Type = "url",
    Target = "example.com",
    RiskScore = 85,
    RiskLevel = "High",
    Findings = new[]
    {
        new Finding { Severity = "high", Title = "RSA-2048 public key" },
    },
});
Console.WriteLine(result.Url); // https://app.postq.dev/scans/...

// List recent scans
var page = await pq.Scans.ListAsync(limit: 10);
foreach (var scan in page.Data)
{
    Console.WriteLine($"{scan.Target}\t{scan.RiskLevel}");
}

// Iterate every scan with automatic pagination
await foreach (var scan in pq.Scans.IterAllAsync())
{
    // ...
}

// Fetch a full scan record (HNDL, certificate, TLS, normalized findings)
ScanDetail detail = await pq.Scans.GetAsync(result.Id);
Console.WriteLine($"{detail.Hndl?.Severity} cert expires in {detail.Certificate?.DaysUntilExpiry} days");

// Download the CycloneDX 1.6 CBOM for a scan
JsonElement cbom = await pq.Scans.GetCbomAsync(result.Id);

Assets and keys (0.3.0+)

// Browse your cryptographic inventory
var assets = await pq.Assets.ListAsync(new AssetsListInput
{
    Provider = "aws",
    Risk = "high",
    Limit = 50,
});
foreach (var a in assets.Data)
{
    Console.WriteLine($"{a.Name}\t{a.Algorithm}\t{a.RiskLevel}");
}

// Or stream every asset
await foreach (var a in pq.Assets.IterAllAsync(new AssetsListInput { Environment = "production" }))
{
    // ...
}

// Browse keys discovered by cloud scans
var keys = await pq.Keys.ListAsync(new KeysListInput { Algorithm = "RSA", QuantumVulnerable = true });
foreach (var k in keys.Data)
{
    Console.WriteLine($"{k.Provider}\t{k.Region}\t{k.KeyId}\t{k.Algorithm}");
}

Configuration

You can also pass your own HttpClient (useful for IHttpClientFactory integration):

var pq = new PostQClient(options, httpClient);

Errors

All exceptions extend PostQException:

try
{
    await pq.Scans.ListAsync();
}
catch (PostQAuthException) { /* 401 */ }
catch (PostQRateLimitException) { /* 429 */ }
catch (PostQException ex) { /* fallback — ex.Status, ex.Code */ }

Requirements

• .NET 8.0+
• Zero runtime dependencies (uses System.Net.Http and System.Text.Json).

License

MIT — see LICENSE.