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

# Validate catalog connection

> validate catalog connection. POST /api/v1/catalogs/validate. Uses the same payload, validation, revision checks and response as the unified HTTP API.

ReferenceApplies to: Unified engine deployments

## Related guidance

[Addresses and access](https://docs.e6data.com/transformation/http/access.md) · [Request identity](https://docs.e6data.com/transformation/http/request-identity.md) · [Errors and recovery](https://docs.e6data.com/transformation/http/errors.md) · [Pagination and results](https://docs.e6data.com/transformation/http/results.md)


## OpenAPI

````yaml openapi/transformation.json POST /api/v1/catalogs/validate
openapi: 3.1.0
info:
  description: >-
    HTTP contracts for the Unified engine. Requests use the connected
    deployment's access model and configured owner. Response examples are
    illustrative; inspect your engine response in your client. SQL-managed
    secrets, credentials, streaming pipelines and maintenance run through
    session operations.
  title: Laminar Unified HTTP API
  version: v1
servers:
  - url: https://engine.example.com
    description: >-
      Example engine origin. Replace it with your deployment URL and any API
      mount prefix.
security: []
paths:
  /api/v1/catalogs/validate:
    post:
      tags:
        - Catalogs and tables
      summary: validate catalog connection
      description: >-
        validate catalog connection. POST /api/v1/catalogs/validate. Uses the
        same payload, validation, revision checks and response as the unified
        HTTP API.
      operationId: validate_catalog_connection
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              additionalProperties: false
              properties:
                configuration:
                  additionalProperties: false
                  properties:
                    credential_references:
                      additionalProperties:
                        type: string
                      type: object
                    options:
                      additionalProperties:
                        type: string
                      type: object
                    provider:
                      type: string
                  required:
                    - provider
                    - options
                    - credential_references
                  type: object
              required:
                - configuration
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/data_catalog_core_src_models_introspection_rs_CatalogConnectionValidateResponse
          description: Successful response.
        default:
          content:
            application/json:
              example:
                error:
                  code: invalid_request
                  message: Check the request fields
              schema:
                $ref: '#/components/schemas/ApiError'
          description: A rejected or failed request. Inspect error.code before retrying.
components:
  schemas:
    data_catalog_core_src_models_introspection_rs_CatalogConnectionValidateResponse:
      properties:
        capabilities:
          $ref: >-
            #/components/schemas/data_catalog_core_src_models_introspection_rs_CatalogCapabilities
        checked_at_unix_millis:
          type: integer
        namespace_probe:
          $ref: >-
            #/components/schemas/data_catalog_core_src_models_introspection_rs_CatalogConnectionProbe
        valid:
          type: boolean
      required:
        - valid
        - checked_at_unix_millis
        - namespace_probe
        - capabilities
      type: object
    ApiError:
      properties:
        error:
          properties:
            code:
              type: string
            message:
              type: string
          required:
            - code
            - message
          type: object
      required:
        - error
      type: object
    data_catalog_core_src_models_introspection_rs_CatalogCapabilities:
      properties:
        constraints:
          items:
            type: string
          type: array
        namespaces:
          $ref: >-
            #/components/schemas/data_catalog_core_src_models_introspection_rs_NamespaceCapabilities
        permissions_verified:
          type: boolean
        provider:
          type: string
        tables:
          $ref: >-
            #/components/schemas/data_catalog_core_src_models_introspection_rs_TableCapabilities
        views:
          $ref: >-
            #/components/schemas/data_catalog_core_src_models_introspection_rs_ViewCapabilities
      required:
        - provider
        - permissions_verified
        - namespaces
        - tables
        - views
        - constraints
      type: object
    data_catalog_core_src_models_introspection_rs_CatalogConnectionProbe:
      properties:
        has_more:
          type: boolean
        returned:
          minimum: 0
          type: integer
      required:
        - returned
        - has_more
      type: object
    data_catalog_core_src_models_introspection_rs_NamespaceCapabilities:
      properties:
        alter_properties:
          type: boolean
        cascade_delete:
          type: boolean
        create:
          type: boolean
        drop_empty:
          type: boolean
        guarded_mutations:
          type: boolean
        list:
          type: boolean
        maximum_depth:
          anyOf:
            - minimum: 0
              type: integer
            - type: 'null'
          description: >-
            None means the engine does not impose a known provider-specific
            depth limit.
        nested:
          type: boolean
        read:
          type: boolean
      required:
        - list
        - read
        - create
        - alter_properties
        - drop_empty
        - nested
        - maximum_depth
        - cascade_delete
        - guarded_mutations
      type: object
    data_catalog_core_src_models_introspection_rs_TableCapabilities:
      properties:
        add_partition_fields:
          type: boolean
        alter_comment:
          type: boolean
        alter_location:
          type: boolean
        alter_properties:
          type: boolean
        alter_sort_order:
          type: boolean
        create:
          type: boolean
        drop_metadata:
          type: boolean
        drop_partition_fields:
          type: boolean
        list:
          type: boolean
        mutation_guards:
          $ref: >-
            #/components/schemas/data_catalog_core_src_models_introspection_rs_MutationGuardCapabilities
        purge_data:
          type: boolean
        read:
          type: boolean
        register_external:
          type: boolean
        rename:
          type: boolean
        rename_partition_fields:
          type: boolean
        schema_evolution:
          $ref: >-
            #/components/schemas/data_catalog_core_src_models_introspection_rs_SchemaEvolutionCapabilities
        snapshot_history:
          type: boolean
        supported_format_versions:
          items:
            minimum: 0
            type: integer
          type: array
        time_travel:
          type: boolean
      required:
        - list
        - read
        - create
        - register_external
        - rename
        - drop_metadata
        - purge_data
        - alter_properties
        - alter_comment
        - alter_location
        - add_partition_fields
        - drop_partition_fields
        - rename_partition_fields
        - alter_sort_order
        - supported_format_versions
        - snapshot_history
        - time_travel
        - schema_evolution
        - mutation_guards
      type: object
    data_catalog_core_src_models_introspection_rs_ViewCapabilities:
      properties:
        alter_comment:
          type: boolean
        alter_properties:
          type: boolean
        create:
          type: boolean
        drop_metadata:
          type: boolean
        guarded_mutations:
          type: boolean
        list:
          type: boolean
        read:
          type: boolean
        rename:
          type: boolean
        replace_definition:
          type: boolean
      required:
        - list
        - read
        - create
        - replace_definition
        - alter_properties
        - alter_comment
        - rename
        - drop_metadata
        - guarded_mutations
      type: object
    data_catalog_core_src_models_introspection_rs_MutationGuardCapabilities:
      properties:
        catalog_revision:
          type: boolean
        full_metadata_revision_compare_and_swap:
          description: >-
            A metadata-location preflight is not atomic full metadata revision
            CAS.
          type: boolean
        guarded_drop:
          type: boolean
        guarded_rename:
          type: boolean
        guarded_view_alter:
          type: boolean
        table_identity_schema_layout:
          description: Identity, schema and layout checks are native commit requirements.
          type: boolean
      required:
        - catalog_revision
        - table_identity_schema_layout
        - full_metadata_revision_compare_and_swap
        - guarded_rename
        - guarded_drop
        - guarded_view_alter
      type: object
    data_catalog_core_src_models_introspection_rs_SchemaEvolutionCapabilities:
      properties:
        add_nullable_columns:
          type: boolean
        add_required_columns:
          type: boolean
        column_comments:
          type: boolean
        column_defaults:
          type: boolean
        drop_columns:
          type: boolean
        generated_columns:
          type: boolean
        relax_nullability:
          type: boolean
        rename_columns:
          type: boolean
        reorder_columns:
          type: boolean
        supported_type_promotions:
          items:
            type: string
          type: array
        tighten_nullability:
          type: boolean
      required:
        - add_nullable_columns
        - add_required_columns
        - drop_columns
        - rename_columns
        - reorder_columns
        - column_comments
        - relax_nullability
        - tighten_nullability
        - column_defaults
        - generated_columns
        - supported_type_promotions
      type: object

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.