Type Alias DirectAccessAgentsAPI

Index
clearCache: typeof directAccessAgents.clearCache

Clears the cache for direct-access-agents api requests.

createDirectAccessAgentBenchmark: typeof directAccessAgents.createDirectAccessAgentBenchmark

Starts a background benchmark task that measures the throughput and latency of a Direct Access agent. Use the returned benchmarkId to monitor progress and retrieve performance metrics for capacity planning or performance optimization. The requestor must have the TenantAdmin role and be either the gateway's space owner or a member of the gateway's space with the Can Consume Data role. Available in Direct Access Gateway V1.7.8+.

The agent ID

an object with query parameters

CreateDirectAccessAgentBenchmarkHttpError

getDirectAccessAgentBenchmarks: typeof getDirectAccessAgentBenchmarks

Retrieves paginated statuses for benchmarks run by the specified Direct Access agent. Use the filters and sort order to find benchmark runs and review their progress or completed results. The requestor must have the TenantAdmin role and be either the gateway's space owner or a member of the gateway's space with the Can Consume Data role. Available in Direct Access Gateway V1.7.17+.

The agent ID

an object with query parameters

GetDirectAccessAgentBenchmarksHttpError

getDirectAccessAgentLoadPerformanceMetrics: typeof getDirectAccessAgentLoadPerformanceMetrics

Retrieves performance metrics for loads processed by the gateway, either for all loads or a filtered subset. Use these metrics to evaluate reload throughput, connector latency, and concurrent reload activity. The requestor must have the TenantAdmin role and be either the gateway's space owner or a member of the gateway's space with the Can Consume Data role. Load performance recording is disabled by default and is controlled by the BENCHMARK_LOAD_PERFORMANCE_METRICS_RECORDING_ENABLED configuration property. Available in Direct Access Gateway V1.7.17+.

The agent ID

an object with query parameters

GetDirectAccessAgentLoadPerformanceMetricsHttpError