Sifflet Domains API

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 Domains 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: Domains
paths:
  /v1/domains:
    get:
      operationId: publicGetDomains
      parameters:
      - description: The page number to retrieve. Starts at 0.
        in: query
        name: page
        required: false
        schema:
          minimum: 0
          type: integer
          format: int32
      - description: The number of elements to be returned inside the page.
        in: query
        name: itemsPerPage
        required: false
        schema:
          maximum: 100
          minimum: 1
          type: integer
          format: int32
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicPageDtoPublicGetDomainDto'
          description: Domains retrieved
        '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: Get list of domains
      tags:
      - Domains
    post:
      operationId: publicCreateDomain
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicCreateDomainDto'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicGetDomainDto'
          description: Domain created
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Bad request
        '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: Create a domain
      tags:
      - Domains
  /v1/domains/{id}:
    delete:
      operationId: publicDeleteDomain
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Domain deleted
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Forbidden
        '404':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Resource not found
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Internal server error
      security:
      - JWT: []
      summary: Delete a domain
      tags:
      - Domains
    get:
      operationId: publicGetDomain
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicGetDomainDto'
          description: Domain retrieved
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Forbidden
        '404':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Resource not found
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Internal server error
      security:
      - JWT: []
      summary: Get a domain by id
      tags:
      - Domains
    patch:
      operationId: publicUpdateDomain
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicUpdateDomainDto'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicGetDomainDto'
          description: Domain updated
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Bad request
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Forbidden
        '404':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Resource not found
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Internal server error
      security:
      - JWT: []
      summary: Update a domain
      tags:
      - Domains
components:
  schemas:
    PublicDomainTeamPermissionDto:
      required:
      - domainRole
      - teamId
      type: object
      properties:
        domainRole:
          type: string
          description: Domain role assigned to the referenced team for accessing domain
          enum:
          - EDITOR
          - MONITOR_RESPONDER
          - CATALOG_EDITOR
          - VIEWER
        teamId:
          type: string
          description: Id of the team
          format: uuid
      description: Teams permissions granted in the domain
    ApiProblemSchema:
      type: object
      properties:
        detail:
          type: string
        response:
          type: string
        status:
          type: integer
          format: int32
        title:
          type: string
        type:
          type: string
    PublicGetDomainDto:
      required:
      - assetContentDefinition
      - assetCount
      - id
      - name
      type: object
      properties:
        assetContentDefinition:
          oneOf:
          - $ref: '#/components/schemas/PublicDynamicDomainContentDefinitionDto'
          - $ref: '#/components/schemas/PublicStaticDomainContentDefinitionDto'
        assetCount:
          type: integer
          description: Current count of assets contained in the domain
          format: int32
        description:
          type: string
          description: Description of the domain
        id:
          type: string
          format: uuid
        name:
          type: string
          description: Name of the domain
        parentDomainId:
          type: string
          description: Id of the parent domain, if the domain has a parent
          format: uuid
        teamPermissions:
          type: array
          description: Teams permissions granted in the domain
          items:
            $ref: '#/components/schemas/PublicDomainTeamPermissionDto'
    PublicSourceFilterDomainConditionDto:
      required:
      - operator
      - sources
      - type
      type: object
      allOf:
      - $ref: '#/components/schemas/PublicFilterDomainConditionDto'
      - type: object
        properties:
          operator:
            type: string
            description: Operator of the condition
            enum:
            - IS
            - IS_NOT
          sources:
            type: array
            description: List of the sources in the condition in URI format. <a href="https://docs.siffletdata.com/docs/uri">[Read more about URIs]</a>
            items:
              type: string
              description: List of the sources in the condition in URI format. <a href="https://docs.siffletdata.com/docs/uri">[Read more about URIs]</a>
    PublicFilterDomainConditionDto:
      required:
      - type
      type: object
      properties:
        type:
          type: string
          description: Type of the condition
          enum:
          - SOURCE
          - TAG
      description: List of the conditions defining content of the domain
      discriminator:
        mapping:
          SOURCE: '#/components/schemas/PublicSourceFilterDomainConditionDto'
          TAG: '#/components/schemas/PublicTagFilterDomainConditionDto'
        propertyName: type
    PublicStaticDomainContentDefinitionDto:
      required:
      - assets
      - type
      type: object
      allOf:
      - $ref: '#/components/schemas/PublicDomainContentDefinitionDto'
      - type: object
        properties:
          assets:
            type: array
            description: List of the assets of the domain
            items:
              type: string
              description: List of the assets of the domain
    PublicUpdateDomainDto:
      required:
      - assetContentDefinition
      - name
      type: object
      properties:
        assetContentDefinition:
          oneOf:
          - $ref: '#/components/schemas/PublicDynamicDomainContentDefinitionDto'
          - $ref: '#/components/schemas/PublicStaticDomainContentDefinitionDto'
        description:
          type: string
          description: Description of the domain
        name:
          type: string
          description: Name of the domain
    PublicPageDtoPublicGetDomainDto:
      required:
      - data
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PublicGetDomainDto'
        totalCount:
          type: integer
          format: int64
    PublicTagFilterDomainConditionDto:
      required:
      - operator
      - tags
      - type
      type: object
      allOf:
      - $ref: '#/components/schemas/PublicFilterDomainConditionDto'
      - type: object
        properties:
          operator:
            type: string
            description: Operator of the condition
            enum:
            - IS
            - IS_NOT
          tags:
            type: array
            description: List of the tags references in the condition
            items:
              $ref: '#/components/schemas/PublicExternalTagReferenceDto'
    PublicDynamicDomainContentDefinitionDto:
      required:
      - conditions
      - filterLogicalOperator
      - type
      type: object
      allOf:
      - $ref: '#/components/schemas/PublicDomainContentDefinitionDto'
      - type: object
        properties:
          conditions:
            type: array
            description: List of the conditions defining content of the domain
            items:
              oneOf:
              - $ref: '#/components/schemas/PublicSourceFilterDomainConditionDto'
              - $ref: '#/components/schemas/PublicTagFilterDomainConditionDto'
          filterLogicalOperator:
            type: string
            description: Logical operator to use between conditions
            enum:
            - AND
            - OR
    PublicCreateDomainDto:
      required:
      - assetContentDefinition
      - name
      type: object
      properties:
        assetContentDefinition:
          oneOf:
          - $ref: '#/components/schemas/PublicDynamicDomainContentDefinitionDto'
          - $ref: '#/components/schemas/PublicStaticDomainContentDefinitionDto'
        description:
          type: string
          description: Description of the domain
        name:
          type: string
          description: Name of the domain
        parentDomainId:
          type: string
          description: Id of the parent domain if the new domain is a subdomain. Do not specify this field if the new domain is not a subdomain.
          format: uuid
    PublicExternalTagReferenceDto:
      type: object
      properties:
        id:
          type: string
          description: Id of the referenced object
          format: uuid
        kind:
          type: string
          description: Type of the referenced tag
          enum:
          - BIGQUERY_EXTERNAL
          - SNOWFLAKE_EXTERNAL
          - DBT_EXTERNAL
          - DATABRICKS_EXTERNAL
          - ADF_EXTERNAL
          - ATLAN_EXTERNAL
          - ALATION_EXTERNAL
          - AMUNDSEN_EXTERNAL
          - APACHE_ATLAS_EXTERNAL
          - CASTOR_DOC_EXTERNAL
          - COLLIBRA_EXTERNAL
          - DATAGALAXY_EXTERNAL
          - INFORMATICA_EXTERNAL
          - SECODA_EXTERNAL
          - SELECT_STAR_EXTERNAL
          - GENERIC_CATALOG_EXTERNAL
        name:
          type: string
          description: Name of the referenced object
      description: Asset tag from external providers.
      example:
        id: 02a15477-1e58-490e-aa5c-1c7388fcb136
        name: env:prod
        kind: BIGQUERY_EXTERNAL
    PublicDomainContentDefinitionDto:
      required:
      - type
      type: object
      properties:
        type:
          type: string
          description: Type of the domain content definition
          enum:
          - STATIC
          - DYNAMIC
      description: Definition of the assets contained in the domain
      discriminator:
        mapping:
          DYNAMIC: '#/components/schemas/PublicDynamicDomainContentDefinitionDto'
          STATIC: '#/components/schemas/PublicStaticDomainContentDefinitionDto'
        propertyName: type
  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