> ## Documentation Index > Fetch the complete documentation index at: https://docs.aixy-gateway.com/llms.txt > Use this file to discover all available pages before exploring further. # Test Connection > Test a draft or exact saved connection without sending a model request. Known provider failures return structured stage results. Saving valid configuration does not require a successful check. Saved checks are bound to the credential revision and are invalidated when configuration changes. ## OpenAPI ````yaml /openapi.json post /api/provider-credentials/{provider}/test openapi: 3.1.0 info: title: Aixy Gateway API version: 0.1.0 description: >- Route requests to configured AI providers through OpenAI- and Anthropic-compatible APIs. Aixy applies project access, model policies, guardrails, routing, budgets, and usage attribution before forwarding inference traffic. servers: - url: https://api.aixy-gateway.com description: Aixy production gateway security: [] tags: - name: operations description: Check process liveness and traffic readiness. - name: authentication description: Authenticate trusted server-side clients. - name: organizations description: Manage the organization and its lifecycle. - name: projects description: Create projects and manage project membership. - name: users description: Manage organization users, roles, and invitations. - name: teams description: Manage teams and team membership. - name: api-keys description: Manage project-scoped gateway API keys. - name: provider-credentials description: Manage organization and project provider credentials. - name: provider-catalog description: Discover providers supported by the gateway. - name: provider-models description: Discover and control models exposed by configured providers. - name: routing description: Configure stable model aliases, routing strategies, and fallbacks. - name: guardrails description: Configure prompt and sensitive-data protection policies. - name: identity connections description: Configure tenant-scoped enterprise identity federation. - name: playground description: Exercise configured models through the gateway. - name: cost-control description: Inspect spend and enforce budgets across tenant scopes. - name: metrics description: Inspect usage, token, latency, and error metrics. - name: activity description: Diagnose individual model requests and manage opt-in content capture. - name: monitors description: Configure operational monitors and notification channels. - name: audit description: Query, verify, and export the organization audit log. - name: telemetry exports description: Export telemetry to organization-owned destinations. - name: billing description: Inspect and manage the organization subscription. - name: models description: List models available to a project-scoped gateway API key. - name: inference description: Run model inference through the Aixy data plane. - name: pricing description: Manage versioned pricing attribution rules. - name: system description: Discover gateway capabilities and providers. - name: MCP beta description: Mcp beta operations exposed by the gateway. - name: cost-optimization description: Cost optimization operations exposed by the gateway. - name: custom domains description: Custom domains operations exposed by the gateway. - name: data processing description: Data processing operations exposed by the gateway. - name: feature flags description: Feature flags operations exposed by the gateway. - name: privacy description: Privacy operations exposed by the gateway. - name: roles description: Roles operations exposed by the gateway. paths: /api/provider-credentials/{provider}/test: post: tags: - provider-credentials summary: Test Connection description: >- Test a draft or exact saved connection without sending a model request. Known provider failures return structured stage results. Saving valid configuration does not require a successful check. Saved checks are bound to the credential revision and are invalidated when configuration changes. operationId: test_provider_connection parameters: - name: provider in: path required: true schema: type: string title: Provider requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ProviderConnectionTestRequest' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ProviderConnectionCheckResponse' '400': description: The request is invalid. content: application/json: schema: $ref: '#/components/schemas/GatewayErrorResponse' '401': description: Authentication is required or invalid. content: application/json: schema: $ref: '#/components/schemas/GatewayErrorResponse' '403': description: The authenticated account cannot perform this operation. content: application/json: schema: $ref: '#/components/schemas/GatewayErrorResponse' '404': description: The requested resource does not exist. content: application/json: schema: $ref: '#/components/schemas/GatewayErrorResponse' '409': description: The request conflicts with the current resource state. content: application/json: schema: $ref: '#/components/schemas/GatewayErrorResponse' '413': description: The request body exceeds the endpoint limit. content: application/json: schema: $ref: '#/components/schemas/GatewayErrorResponse' '422': description: The request is semantically invalid. content: application/json: schema: $ref: '#/components/schemas/GatewayErrorResponse' '429': description: The request was rate limited. content: application/json: schema: $ref: '#/components/schemas/GatewayErrorResponse' '503': description: The control-plane capability is unavailable. content: application/json: schema: $ref: '#/components/schemas/GatewayErrorResponse' 4XX: description: The request was rejected by validation or authorization. content: application/json: schema: $ref: '#/components/schemas/GatewayErrorResponse' security: - BrowserSession: [] components: schemas: ProviderConnectionTestRequest: properties: use_saved: type: boolean title: Use Saved default: false project_id: anyOf: - type: string - type: 'null' title: Project Id credential: anyOf: - type: string - additionalProperties: type: string type: object - type: 'null' title: Credential writeOnly: true credential_type: anyOf: - $ref: '#/components/schemas/ProviderCredentialType' - type: 'null' connection: anyOf: - $ref: '#/components/schemas/ProviderConnectionRequest' - type: 'null' display_name: anyOf: - type: string - type: 'null' title: Display Name base_url: anyOf: - type: string - type: 'null' title: Base Url additionalProperties: false type: object title: ProviderConnectionTestRequest ProviderConnectionCheckResponse: properties: checked_at: type: string format: date-time title: Checked At status: type: string enum: - passed - failed title: Status stages: items: $ref: '#/components/schemas/ConnectionCheckStageResponse' type: array title: Stages model_count: anyOf: - type: integer - type: 'null' title: Model Count type: object required: - checked_at - status - stages - model_count title: ProviderConnectionCheckResponse GatewayErrorResponse: properties: error: $ref: '#/components/schemas/GatewayErrorDetail' type: object required: - error title: GatewayErrorResponse ProviderCredentialType: type: string enum: - api_key - google_service_account - aws_credentials - aws_assume_role ProviderConnectionRequest: properties: project_id: anyOf: - type: string - type: 'null' title: Project Id region: anyOf: - type: string - type: 'null' title: Region location: anyOf: - type: string - type: 'null' title: Location resource_name: anyOf: - type: string - type: 'null' title: Resource Name additionalProperties: true type: object title: ProviderConnectionRequest ConnectionCheckStageResponse: properties: name: type: string enum: - configuration - authentication - catalog - inference title: Name status: type: string enum: - passed - failed - not_tested title: Status code: type: string title: Code message: type: string title: Message next_step: anyOf: - type: string - type: 'null' title: Next Step type: object required: - name - status - code - message title: ConnectionCheckStageResponse GatewayErrorDetail: properties: code: type: string title: Code message: type: string title: Message details: anyOf: - additionalProperties: true type: object - type: 'null' title: Details type: object required: - code - message title: GatewayErrorDetail securitySchemes: BrowserSession: type: apiKey description: Secure same-origin browser session cookie. in: cookie name: gateway_session ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.