openapi: 3.2.0
info:
  description: 'Requirements:

    - Create your access token through the UI

    - Get your tenant name: if you access to Sifflet with `https://abcdef.siffletdata.com`, then your tenant would be `abcdef`'
  title: Sifflet Backend External Catalog API
  version: 1.0.0
servers:
- url: https://{tenant}.siffletdata.com/api
  description: Production tenant
  variables:
    tenant:
      description: if you access to Sifflet with `https://abcdef.siffletdata.com`, then your tenant would be `abcdef`
      default: publicdemo
- url: http://localhost:8090
  description: Dev server started in intellij
- url: http://localhost:8091
  description: Dev server started in docker compose
- url: http://localhost:8099
  description: Dev server started with api recorder
tags:
- name: External Catalog
paths:
  /v1/external-catalog/import:
    post:
      description: 'Enriches existing Sifflet assets with metadata imported from an external data catalog. Each asset is processed independently. The caller must have "Catalog Editor" or "Domain Editor" permission on each asset''s domain.


        The HTTP status reflects the aggregate outcome: 200 when every asset succeeds, 207 when some succeed and some fail, 400 when all assets fail.'
      operationId: publicImportExternalCatalog
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicExternalCatalogImportDto'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicExternalCatalogImportResponseDto'
          description: All assets imported successfully
        '207':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicExternalCatalogImportResponseDto'
          description: Partial success - some assets imported, some failed
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicExternalCatalogImportResponseDto'
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: 'Either the request failed validation or all assets failed to import '
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Forbidden
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Internal server error
      security:
      - JWT: []
      summary: Push external catalog metadata to Sifflet assets
      tags:
      - External Catalog
components:
  schemas:
    ApiProblemSchema:
      type: object
      properties:
        detail:
          type: string
        response:
          type: string
        status:
          type: integer
          format: int32
        title:
          type: string
        type:
          type: string
    PublicExternalCatalogImportDto:
      required:
      - assets
      - configuration
      type: object
      properties:
        assets:
          type: array
          description: Assets to enrich with external catalog metadata
          items:
            $ref: '#/components/schemas/PublicAssetImportDto'
        configuration:
          $ref: '#/components/schemas/PublicConfigurationImportDto'
    PublicAssetImportResultDto:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
          description: Failure message, present only when the asset failed to import
        status:
          type: string
          description: Import status of the asset
          enum:
          - SUCCESS
          - FAILED
        uri:
          type: string
          description: URI of the asset
          example: bigquery:project.dataset.table
      description: Per-asset import status
    PublicExternalCatalogImportResponseDto:
      type: object
      properties:
        detail:
          $ref: '#/components/schemas/PublicExternalCatalogImportResultDto'
        status:
          type: integer
          description: HTTP status code
          format: int32
        title:
          type: string
          description: HTTP status title
    PublicNamedElementExternalMetadataDto:
      required:
      - name
      type: object
      properties:
        name:
          type: string
          description: Name to display
      description: Tags to attach to the asset
    PublicStringExternalMetadataDto:
      required:
      - data
      - name
      type: object
      properties:
        data:
          type: string
          description: Value of the metadata
        name:
          type: string
          description: Name of the metadata
        showInFilter:
          type: boolean
          description: Whether the metadata should be shown as a filter in the catalog
          default: false
      description: String metadata to attach to the asset
    PublicExternalCatalogImportResultDto:
      type: object
      properties:
        importStatus:
          type: string
          description: Status of the import
          enum:
          - SUCCESS
          - PARTIAL_SUCCESS
          - FAILURE
        results:
          type: array
          description: Per-asset import status
          items:
            $ref: '#/components/schemas/PublicAssetImportResultDto'
      description: Detailed import result
    PublicLabelExternalMetadataDto:
      required:
      - data
      - name
      type: object
      properties:
        data:
          type: array
          description: Values of the label
          items:
            $ref: '#/components/schemas/PublicNamedElementExternalMetadataDto'
        name:
          type: string
          description: Name of the metadata
        showInFilter:
          type: boolean
          description: Whether the label should be shown as a filter in the catalog
          default: false
      description: Labels to attach to the asset
    PublicAssetImportDto:
      required:
      - uri
      type: object
      properties:
        catalogUrl:
          type:
          - string
          - 'null'
          description: URL of the asset in the external catalog. Null or empty removes the existing link.
          example: https://catalog.example.com/asset/123
        description:
          type:
          - string
          - 'null'
          description: Description of the asset in the external catalog. Null or empty removes the existing description.
        labels:
          type: array
          description: Labels to attach to the asset
          items:
            $ref: '#/components/schemas/PublicLabelExternalMetadataDto'
        strings:
          type: array
          description: String metadata to attach to the asset
          items:
            $ref: '#/components/schemas/PublicStringExternalMetadataDto'
        tags:
          type: array
          description: Tags to attach to the asset
          items:
            $ref: '#/components/schemas/PublicNamedElementExternalMetadataDto'
        uri:
          type: string
          description: URI of the asset to enrich. <a href="https://docs.siffletdata.com/docs/uri">[Read more about URIs]</a>
          example: bigquery:project.dataset.table
      description: Assets to enrich with external catalog metadata
    PublicConfigurationImportDto:
      required:
      - catalogProvider
      type: object
      properties:
        catalogProvider:
          type: string
          description: Type of external catalog. If not listed, use CATALOG_GENERIC
          example: APACHE_ATLAS
          enum:
          - ATLAN
          - ALATION
          - AMUNDSEN
          - APACHE_ATLAS
          - CASTOR_DOC
          - COLLIBRA
          - DATAGALAXY
          - INFORMATICA
          - SECODA
          - SELECT_STAR
          - CATALOG_GENERIC
      description: Configuration of the import
  securitySchemes:
    JWT:
      bearerFormat: Bearer [token]
      description: JWT authentication with bearer token. [Create your access token through the UI](https://docs.siffletdata.com/docs/generate-an-api-token#create-an-api-token).
      scheme: bearer
      type: http
x-provenance:
  method: searched
  source: https://docs.siffletdata.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.siffletdata.com/reference/decryptrulegroups.md
  - https://docs.siffletdata.com/reference/decryptrulerungroups.md
  - https://docs.siffletdata.com/reference/getallmonitorsascode.md
  - https://docs.siffletdata.com/reference/getallrule.md
  - https://docs.siffletdata.com/reference/getsiffletruledetails.md
  - https://docs.siffletdata.com/reference/getsiffletruleinfo.md
  - https://docs.siffletdata.com/reference/getsiffletruleoverview.md
  - https://docs.siffletdata.com/reference/getsiffletrulerun.md
  - https://docs.siffletdata.com/reference/getsiffletruleruns.md
  - https://docs.siffletdata.com/reference/publiccreatecalendar.md
  - https://docs.siffletdata.com/reference/publiccreatecredentials.md
  - https://docs.siffletdata.com/reference/publiccreatedomain.md
  - https://docs.siffletdata.com/reference/publiccreatenotificationrule.md
  - https://docs.siffletdata.com/reference/publiccreatesource.md
  - https://docs.siffletdata.com/reference/publiccreatesourcev2.md
  - https://docs.siffletdata.com/reference/publiccreateteam.md
  - https://docs.siffletdata.com/reference/publiccreateuser.md
  - https://docs.siffletdata.com/reference/publicdeletecalendar.md
  - https://docs.siffletdata.com/reference/publicdeletecredentials.md
  - https://docs.siffletdata.com/reference/publicdeletedomain.md
  - https://docs.siffletdata.com/reference/publicdeletenotificationrule.md
  - https://docs.siffletdata.com/reference/publicdeletesourcebyid.md
  - https://docs.siffletdata.com/reference/publicdeletesourcev2.md
  - https://docs.siffletdata.com/reference/publicdeleteteam.md
  - https://docs.siffletdata.com/reference/publicdeleteuser.md
  - https://docs.siffletdata.com/reference/publicdeleteworkspace.md
  - https://docs.siffletdata.com/reference/publiceditasset-1.md
  - https://docs.siffletdata.com/reference/publiceditsource.md
  - https://docs.siffletdata.com/reference/publiceditsourcev2.md
  - https://docs.siffletdata.com/reference/publicgetallcredentials.md
  - https://docs.siffletdata.com/reference/publicgetasset-1.md
  - https://docs.siffletdata.com/reference/publicgetassets-1.md
  - https://docs.siffletdata.com/reference/publicgetcalendar.md
  - https://docs.siffletdata.com/reference/publicgetcalendars.md
  - https://docs.siffletdata.com/reference/publicgetcredentials.md
  - https://docs.siffletdata.com/reference/publicgetdomain.md
  - https://docs.siffletdata.com/reference/publicgetdomains.md
  - https://docs.siffletdata.com/reference/publicgetnotificationrule.md
  - https://docs.siffletdata.com/reference/publicgetnotificationrules.md
  - https://docs.siffletdata.com/reference/publicgetsource.md
  - https://docs.siffletdata.com/reference/publicgetsources.md
  - https://docs.siffletdata.com/reference/publicgetsourceschemalist.md
  - https://docs.siffletdata.com/reference/publicgetsourcesv2.md
  - https://docs.siffletdata.com/reference/publicgetsourcev2.md
  - https://docs.siffletdata.com/reference/publicgetteam.md
  - https://docs.siffletdata.com/reference/publicgetteams.md
  - https://docs.siffletdata.com/reference/publicgetuser.md
  - https://docs.siffletdata.com/reference/publicgetusers.md
  - https://docs.siffletdata.com/reference/publicimportexternalcatalog.md
  - https://docs.siffletdata.com/reference/publicresetuserpassword.md
  - https://docs.siffletdata.com/reference/publicrunsourcev2.md
  - https://docs.siffletdata.com/reference/publicrunsubsourcev2.md
  - https://docs.siffletdata.com/reference/publicsourceingestionmanualrun.md
  - https://docs.siffletdata.com/reference/publicsyncassets.md
  - https://docs.siffletdata.com/reference/publictestexistingsourceconnectionv2.md
  - https://docs.siffletdata.com/reference/publictestsourceconnectionv2.md
  - https://docs.siffletdata.com/reference/publictestsubsourceconnectionbyuriv2.md
  - https://docs.siffletdata.com/reference/publictestsubsourceconnectionv2.md
  - https://docs.siffletdata.com/reference/publicupdatecalendar.md
  - https://docs.siffletdata.com/reference/publicupdatecredentials.md
  - https://docs.siffletdata.com/reference/publicupdatedomain.md
  - https://docs.siffletdata.com/reference/publicupdatenotificationrule.md
  - https://docs.siffletdata.com/reference/publicupdateteam.md
  - https://docs.siffletdata.com/reference/publicupdateuser.md
  - https://docs.siffletdata.com/reference/siffletrulemanualrun.md
  - https://docs.siffletdata.com/reference/testsourceconnection.md
  - https://docs.siffletdata.com/reference/uploaddbtmetadatafiles.md
  merge:
    pages: 67
    deduped: 626
    conflicts_kept_first: 0