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 Rule Run 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: Rule Run
paths:
  /v1/rules/runs/{runId}/decrypt:
    get:
      operationId: decryptRuleRunGroups
      parameters:
      - in: path
        name: runId
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupDecryptedValuesDto'
          description: Successfully fetch rule run groups decryption
        '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
        '409':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Conflict
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Internal server error
      security:
      - JWT: []
      summary: Decrypt rule run groups
      tags:
      - Rule Run
  /v1/rules/{id}/runs:
    get:
      operationId: getSiffletRuleRuns
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
          format: uuid
      - description: Filter by run status
        in: query
        name: status
        required: false
        schema:
          type: array
          items:
            type: string
            enum:
            - PENDING
            - RUNNING
            - SUCCESS
            - REQUIRES_YOUR_ATTENTION
            - TECHNICAL_ERROR
            - FAILED
      - description: The requested page number. Zero-based page index (0..N)
        in: query
        name: page
        required: false
        schema:
          type: integer
          format: int32
          default: 0
      - description: The number of elements to be returned inside the page. Pass a value of -1, to bypass pagination and fetch all items
        in: query
        name: itemsPerPage
        required: false
        schema:
          type: integer
          format: int32
          default: 25
      - description: 'The resource fields on which to apply the sort, format : property,ASC|DESC'
        in: query
        name: sort
        required: false
        schema:
          type: array
          items:
            type: string
            description: The resource field on which to apply the sort followed by the direction
            format: property,ASC|DESC
            example: name,ASC
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchCollectionRuleRunDto'
          description: Successfully fetch Sifflet rule Runs
        '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
        '409':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Conflict
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Internal server error
      security:
      - JWT: []
      summary: Get all Sifflet rule runs by rule id
      tags:
      - Rule Run
  /v1/rules/{id}/runs/{runId}:
    get:
      operationId: getSiffletRuleRun
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: runId
        required: true
        schema:
          type: string
          format: uuid
      - in: query
        name: expand
        required: false
        schema:
          uniqueItems: true
          type: array
          items:
            type: string
            enum:
            - VALUES
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuleRunDto'
          description: Successfully fetch Sifflet rule run
        '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
        '409':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Conflict
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ApiProblemSchema'
          description: Internal server error
      security:
      - JWT: []
      summary: Get a Sifflet rule run by rule id and run id
      tags:
      - Rule Run
components:
  schemas:
    GroupDecryptedValuesDto:
      type: object
      properties:
        decryptedValues:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
    ParameterizedQueryDto:
      required:
      - positionalParameters
      - query
      type: object
      properties:
        positionalParameters:
          type: array
          items:
            $ref: '#/components/schemas/PositionalParameterDto'
        query:
          type: string
    ApiProblemSchema:
      type: object
      properties:
        detail:
          type: string
        response:
          type: string
        status:
          type: integer
          format: int32
        title:
          type: string
        type:
          type: string
    SearchCollectionRuleRunDto:
      required:
      - data
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/RuleRunDto'
        totalElements:
          type: integer
          format: int64
    RuleRunExpectedValuesDto:
      type: object
      properties:
        max:
          type: number
          format: float
        min:
          type: number
          format: float
    PositionalParameterDto:
      type: object
      properties:
        value:
          type: object
    RuleRunValuesDto:
      type: object
      properties:
        actual:
          type: number
          format: float
        expected:
          $ref: '#/components/schemas/RuleRunExpectedValuesDto'
    RuleRunDto:
      required:
      - canShowFailingRows
      - debuggable
      - hasGraph
      - hasGroupBy
      - id
      type: object
      properties:
        canShowFailingRows:
          type: boolean
          deprecated: true
        createdBy:
          type: string
        createdDate:
          type: integer
          format: int64
        debugSql:
          $ref: '#/components/schemas/ParameterizedQueryDto'
        debuggable:
          type: boolean
        endDate:
          type: integer
          format: int64
        hasGraph:
          type: boolean
        hasGroupBy:
          type: boolean
        id:
          type: string
          format: uuid
        incidentIssue:
          type: integer
          format: int32
        incidentName:
          type: string
        incidentStatus:
          type: string
          enum:
          - OPEN
          - IN_PROGRESS
          - CLOSED
        result:
          type: string
        ruleId:
          type: string
          format: uuid
        startDate:
          type: integer
          format: int64
        status:
          type: string
          enum:
          - PENDING
          - RUNNING
          - SUCCESS
          - REQUIRES_YOUR_ATTENTION
          - TECHNICAL_ERROR
          - FAILED
        type:
          type: string
          enum:
          - MANUAL
          - SCHEDULED
          - DBT
        values:
          $ref: '#/components/schemas/RuleRunValuesDto'
  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