Sign in

v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Provider Configurations API

Test a Provider Configuration

Use this endpoint to test connectivity, authentication, and end-to-end communication with the configured provider.

post/v1/provider-configurations/{id}/test

Path parameters

idstring uuid required

Unique identifier of the provider configuration.

Response

Indicates that the request was successful and the response contains the requested data.

completedAtstring date-time

Timestamp when the test finished.

durationMsinteger

Total test duration in milliseconds.

overallStatusstring

Aggregate result: passed if all stages succeeded, failed if any stage failed.

providerConfigIdstring uuid

ID of the provider configuration that was tested.

providerIdstring

Catalog provider ID.

startedAtstring date-time

Timestamp when the test started.

summarystring

Human-readable summary of the test results.

Example response

{
  "providerConfigId": "c3d4e5f6-a7b8-9012-cdef-345678901234",
  "providerId": "clearsale",
  "overallStatus": "passed",
  "stages": [
    {
      "name": "dns_resolution",
      "status": "passed",
      "message": "DNS resolved successfully to 104.21.32.15",
      "durationMs": 45,
      "details": {
        "resolvedIP": "104.21.32.15"
      }
    },
    {
      "name": "authentication",
      "status": "passed",
      "message": "API key accepted (HTTP 200)",
      "durationMs": 320
    },
    {
      "name": "end_to_end",
      "status": "passed",
      "message": "Health endpoint returned OK",
      "durationMs": 280
    }
  ],
  "summary": "All 3 stages passed. Provider is reachable and authenticated.",
  "durationMs": 645,
  "startedAt": "2026-03-17T14:01:00Z",
  "completedAt": "2026-03-17T14:01:01Z"
}