> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Test a Provider Configuration

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



## OpenAPI

````yaml /en/openapi/v3-current/flowker.yaml post /v1/provider-configurations/{id}/test
openapi: 3.1.0
info:
  description: >-
    Complete API reference for Flowker workflow orchestration services including
    catalog management, workflow definitions, executor configurations, provider
    configurations, and workflow executions.
  title: Flowker API
  version: 1.1.0
servers:
  - url: https://flowker.sandbox.lerian.net
security:
  - ApiKeyAuth: []
tags:
  - name: Health API
    description: Health and version endpoints for monitoring the Flowker service.
  - name: Catalog API
    description: >-
      Browse built-in providers, executors, and triggers available in the
      Flowker catalog.
  - name: Workflows API
    description: >-
      Create, update, activate, deactivate, clone, and delete workflow
      definitions.
  - name: Executions API
    description: Start workflow executions and track their status and results.
  - name: Executor Configurations API
    description: >-
      Configure, test, and manage external executor connections used by workflow
      nodes.
  - name: Provider Configurations API
    description: Configure, test, enable, and disable provider integrations.
  - name: Dashboard API
    description: >-
      Retrieve aggregated summaries of workflows and executions for operational
      dashboards.
  - name: Audit API
    description: Query and verify audit events for compliance and operational visibility.
  - name: Webhooks API
    description: >-
      Receive webhook callbacks from external systems to trigger workflow
      executions.
paths:
  /v1/provider-configurations/{id}/test:
    post:
      tags:
        - Provider Configurations API
      summary: Test a Provider Configuration
      description: >-
        Use this endpoint to test connectivity, authentication, and end-to-end
        communication with the configured provider.
      operationId: testProviderConfiguration
      parameters:
        - description: Unique identifier of the provider configuration.
          in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProviderConfigTestResultOutput'
          description: >-
            Indicates that the request was successful and the response contains
            the requested data.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Indicates that the request was malformed or contained invalid
            parameters.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Indicates that the requested resource could not be found.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Indicates that the request was well-formed but contains semantic
            errors that prevent processing.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: >-
            Indicates an unexpected internal error. If this persists, please
            contact support.
components:
  schemas:
    ProviderConfigTestResultOutput:
      example:
        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'
      properties:
        completedAt:
          description: Timestamp when the test finished.
          example: '2026-03-17T14:01:02Z'
          format: date-time
          type: string
        durationMs:
          description: Total test duration in milliseconds.
          example: 645
          type: integer
        overallStatus:
          description: >-
            Aggregate result: `passed` if all stages succeeded, `failed` if any
            stage failed.
          example: passed
          type: string
        providerConfigId:
          description: ID of the provider configuration that was tested.
          example: c3d4e5f6-a7b8-9012-cdef-345678901234
          format: uuid
          type: string
        providerId:
          description: Catalog provider ID.
          example: clearsale
          type: string
        stages:
          description: Ordered list of test stages with individual results.
          items:
            $ref: '#/components/schemas/StageTestResultOutput'
          type: array
        startedAt:
          description: Timestamp when the test started.
          example: '2026-03-17T14:01:00Z'
          format: date-time
          type: string
        summary:
          description: Human-readable summary of the test results.
          example: All 3 stages passed. Provider is reachable and authenticated.
          type: string
      type: object
    ErrorResponse:
      properties:
        code:
          description: Machine-readable error code with the FLK prefix.
          example: FLK-0001
          type: string
        message:
          description: Human-readable explanation of the error.
          example: Invalid input provided
          type: string
        title:
          description: Short error category title.
          example: Bad Request
          type: string
      required:
        - code
        - message
        - title
      type: object
    StageTestResultOutput:
      properties:
        details:
          additionalProperties:
            type: object
          description: Additional details about the stage result.
          example:
            resolvedIP: 104.21.32.15
            ttl: 300
          type: object
        durationMs:
          description: Stage duration in milliseconds.
          example: 45
          type: integer
        error:
          description: Error message if the stage failed.
          type: string
        message:
          description: Human-readable description of the stage result.
          example: DNS resolved successfully to 104.21.32.15
          type: string
        name:
          description: Name of the test stage.
          example: dns_resolution
          type: string
        status:
          description: 'Stage result: `passed` or `failed`.'
          example: passed
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        API key for authenticating requests to the Flowker API. Provisioned via
        the API_KEY environment variable during deployment.

````