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

Test a Provider Configuration

cURL

curl --request POST \
  --url https://flowker.sandbox.lerian.net/v1/provider-configurations/{id}/test \
  --header 'X-API-Key: <api-key>'

200

{
  "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"
}

Authorizations

X-API-Key · string · header · required

API key for authenticating requests to the Flowker API. Provisioned via the API_KEY environment variable during deployment.

Path Parameters

id · string<uuid> · required

Unique identifier of the provider configuration.

Response

200

application/json

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

completedAt · string<date-time>

Timestamp when the test finished.

Example:

"2026-03-17T14:01:02Z"

durationMs · integer

Total test duration in milliseconds.

Example:

645

overallStatus · string

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

Example:

"passed"

providerConfigId · string<uuid>

ID of the provider configuration that was tested.

Example:

"c3d4e5f6-a7b8-9012-cdef-345678901234"

providerId · string

Catalog provider ID.

Example:

"clearsale"

stages · object[]

Ordered list of test stages with individual results.

Show child attributes

startedAt · string<date-time>

Timestamp when the test started.

Example:

"2026-03-17T14:01:00Z"

summary · string

Human-readable summary of the test results.

Example:

"All 3 stages passed. Provider is reachable and authenticated."