Skip to main content
POST
/
inventory-sources
/
{sourceId}
/
test-connection
Test the ad-server source connection
curl --request POST \
  --url https://api.interchange.io/api/v2/storefront/inventory-sources/{sourceId}/test-connection \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "error": "<string>",
  "testedAt": "2023-11-07T05:31:56Z",
  "errorCode": "<string>",
  "remediation": "<string>",
  "details": {},
  "capabilityChecks": [
    {
      "capability": "<string>",
      "status": "passed",
      "message": "<string>",
      "errorCode": "<string>",
      "remediation": "<string>",
      "details": {}
    }
  ]
}

Authorizations

​
Authorization
string
header
required

API key or access token

Path Parameters

​
sourceId
string
required

Inventory source ID

Minimum string length: 1

Response

Test the ad-server source connection

Result of probing the upstream managed ad-server source for reachability.

​
success
boolean
required
​
error
string | null
required
​
testedAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
​
errorCode
string | null
​
remediation
string | null
​
details
object
​
capabilityChecks
object[]