> ## Documentation Index > Fetch the complete documentation index at: https://docs.maia.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get Connection Schema > Returns the schema describing the connection properties and vault secret format required to create a connection for the given auth provider, auth type and platform connection type. ## OpenAPI ````yaml /openapi/public-api-endpoint-reference.yaml get /v1/connections/schema openapi: 3.1.0 info: title: Maia Public REST API version: '1.0' servers: - description: EU1 url: https://eu1.api.matillion.com/dpc - description: US1 url: https://us1.api.matillion.com/dpc security: - bearerAuth: [] tags: - description: Manage Schedules name: Schedules - description: Manage Connections name: Connections - description: Operations for managing Project Variables name: Project Variables - description: Manage Pipelines name: Pipelines - description: Review pipelines against quality rules name: Pipeline Quality Review - description: >- Describe how to configure a connection for a given auth provider, auth type and platform connection type. name: Connection Schema - description: Execute tests within a project name: Test Execution - description: Manage your AI agent tasks name: AI Agent Tasks - description: SCIM endpoints for user/group permission management name: Directory Integration - description: Publish shared pipeline artifacts name: Shared Pipeline Artifacts - description: Manage Repositories name: Repositories - description: Report on Credit Consumption name: Consumption - description: >- Start and track the migration of a Git repository into a project's working tree. name: Repository Migration - description: Manage Artifacts name: Artifacts - description: Operations for data lineage and governance name: Data Lineage - description: Manage Streaming Pipelines name: Streaming Pipelines - description: Execute a pipeline name: Pipeline Execution - description: '' name: Environments - description: '' name: Projects - description: Manage Agents name: Agents - description: Operations for managing Environment-level Overrides of Project Variables name: Project Variable Environment Overrides - description: Query audit events name: Audit Events - description: Connector Profiles name: Connectors paths: /v1/connections/schema: get: tags: - Connection Schema summary: Get Connection Schema description: >- Returns the schema describing the connection properties and vault secret format required to create a connection for the given auth provider, auth type and platform connection type. operationId: getConnectionSchema parameters: - description: >- The auth provider to retrieve the connection schema for — for example `salesforce`. in: query name: authProvider required: true schema: type: string minLength: 1 - description: >- The auth type to retrieve the connection schema for — for example `OAUTH_CLIENT_CRED`. in: query name: authType required: true schema: type: string minLength: 1 - description: >- The platform connection type — one of `COMPONENT`, `COMPONENT_BASIC`, or `CLOUD_PLATFORM_CREDENTIALS`. in: query name: platformConnectionType required: true schema: type: string minLength: 1 responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConnectionSchemaResponse' description: Connection schema returned successfully '400': content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetail' description: Invalid request '403': content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetail' description: Forbidden '404': content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetail' description: Connection schema not found '500': content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetail' description: Unexpected error occurred '504': content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetail' description: Gateway timeout components: schemas: ConnectionSchemaResponse: type: object description: >- The schema describing how to configure a connection for a given auth provider, auth type and platform connection type. properties: authProvider: type: string description: The auth provider the schema applies to. authType: type: string description: The auth type the schema applies to. connectionPropertiesFields: type: array description: The connection properties required to configure the connection. items: $ref: '#/components/schemas/ConnectionPropertyField' platformConnectionType: type: string description: The platform connection type the schema applies to. vaultSecretFormat: type: array description: Describes how connection properties map onto vault secrets. items: $ref: '#/components/schemas/VaultSecretFormat' ProblemDetail: type: object properties: detail: type: string instance: type: string status: type: integer format: int32 title: type: string type: type: string format: uri violations: type: array items: type: string ConnectionPropertyField: type: object description: >- A single connection property field — either a simple value or a nested object. properties: description: type: string description: A human-readable description of the connection property. example: description: >- An example value for the property — a string for value types, an object for object types. example: fields: type: array description: >- The nested fields within an object property; absent for value properties. items: $ref: '#/components/schemas/ConnectionPropertyField' key: type: string description: The key identifying the connection property. required: type: boolean description: Whether the connection property is required. type: type: string description: >- The structural type of the property. One of `value` (simple scalar) or `object` (nested structure). VaultSecretFormat: type: object description: Describes how a connection property maps onto a vault secret. properties: connectionProperty: type: string description: The connection property the vault secret maps to. secretKeys: type: array description: >- The keys within a multi-key vault secret; absent for single-key secrets. items: $ref: '#/components/schemas/VaultSecretKey' secretType: type: string description: The vault secret type. One of `scalar` or `structured`. VaultSecretKey: type: object description: A single key within a multi-key vault secret. properties: description: type: string description: A human-readable description of the vault secret key. key: type: string description: The key within the vault secret. required: type: boolean description: Whether the vault secret key is required. securitySchemes: bearerAuth: bearerFormat: JWT description: a valid bearer token scheme: bearer type: http ````