POST/api/v1/admin/telemetry-settings

Check telemetry settings update status

No-op endpoint for telemetry settings. The handler authenticates the current user, verifies the tenant-scoped users.role is admin or owner, ignores the request body, performs no database write, and returns the current ALGA_USAGE_STATS-derived status with a message explaining that telemetry cannot be changed through the API. Because this session-authenticated route is not currently in apiKeySkipPaths, API middleware also requires an x-api-key header to be present before the handler can run.

Response body

Success response 200 · schema TelemetrySettingsPostResponse

usageStatsEnabledbooleanRequired

Whether usage statistics are enabled by the ALGA_USAGE_STATS environment variable.

controlledBystringRequired

Telemetry is controlled by process environment, not runtime API writes.

Enum: environment

messagestringRequired

Explains that telemetry settings cannot be changed through this API.

Response codes

200

Telemetry status returned; no setting was changed.

401

No authenticated current user, no tenant context, or x-api-key missing at middleware.

403

Authenticated user is not an admin or owner in the tenant.

500

Unexpected failure while processing the no-op update request.

POST /api/v1/admin/telemetry-settings

cURL

curl -X POST "https://algapsa.com/api/v1/admin/telemetry-settings" \
  -H "X-API-Key: $ALGA_API_KEY"

TypeScript

const response = await fetch("https://algapsa.com/api/v1/admin/telemetry-settings", {
  method: "POST",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
  }
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://algapsa.com/api/v1/admin/telemetry-settings");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "usageStatsEnabled": false,
  "controlledBy": "environment",
  "message": "string"
}