Skip to main content
POST /api/v2/storefront/inventory-sources/{sourceId}/test-connection Probes the upstream adapter for reachability against the provisioned ad-server credentials. Use it after saving config or rotating credentials to confirm the source can authenticate. The same probe refreshes vendor currency evidence: GAM reads its authoritative network currency, and FreeWheel samples the currency on existing insertion orders. It does not guess or change a seller’s FreeWheel execution-currency declaration.

​
Request

​
Parameters

​
Response

On failure, success is false and errorCode classifies the problem — for example ADAPTER_PERMISSION_DENIED (GAM grant still propagating) or ADAPTER_NETWORK_NOT_FOUND (wrong network code). remediation carries an operator-facing next step when available. capabilityChecks is an optional array of per-capability probe results — each entry has { capability, status, message?, errorCode?, remediation?, details? } where status is passed, failed, or not_checked:

​
Every probe is recorded

Whatever the outcome, the probe updates lastTestedAt on the source’s ad-server connection, along with lastError and lastErrorCode. That holds for a probe that succeeded, one that returned success: false, and one that failed to reach the ad server at all and returned an HTTP error. So lastTestedAt answers “when did anyone last probe this connection”, and null means nobody ever has. It is not evidence that the connection works — only the result of a probe you just ran is. A connection that reports connected in its status while lastTestedAt is null has never been checked against the live ad server.

​
Errors

  • 401 UNAUTHORIZED — missing or invalid API key.
  • 404 NOT_FOUND — no ad-server-backed source with this sourceId.
A failed probe returns 200 with success: false — it is not an HTTP error. See Errors for the full error contract.

Inventory source tasks

All operations

Replace ad-server config

Fix the config, then re-test

Rotate credentials

Rotate, then re-test

Get status

Operational snapshot