components:
  schemas:
    AlertmanagertypesChannel:
      properties:
        createdAt:
          format: date-time
          type: string
        data:
          type: string
        id:
          type: string
        name:
          type: string
        orgId:
          type: string
        type:
          type: string
        updatedAt:
          format: date-time
          type: string
      required:
      - id
      - name
      - type
      - data
      - orgId
      type: object
    AlertmanagertypesDeprecatedGettableAlert:
      properties:
        annotations:
          $ref: '#/components/schemas/ModelLabelSet'
        endsAt:
          format: date-time
          type: string
        fingerprint:
          type: string
        generatorURL:
          type: string
        labels:
          $ref: '#/components/schemas/ModelLabelSet'
        receivers:
          items:
            type: string
          nullable: true
          type: array
        startsAt:
          format: date-time
          type: string
        status:
          $ref: '#/components/schemas/TypesAlertStatus'
      type: object
    AlertmanagertypesExpressionKind:
      enum:
      - rule
      - policy
      type: string
    AlertmanagertypesGettableRoutePolicy:
      properties:
        channels:
          items:
            type: string
          nullable: true
          type: array
        createdAt:
          format: date-time
          type: string
        createdBy:
          nullable: true
          type: string
        description:
          type: string
        expression:
          type: string
        id:
          type: string
        kind:
          $ref: '#/components/schemas/AlertmanagertypesExpressionKind'
        name:
          type: string
        tags:
          items:
            type: string
          nullable: true
          type: array
        updatedAt:
          format: date-time
          type: string
        updatedBy:
          nullable: true
          type: string
      required:
      - expression
      - channels
      - name
      - id
      - createdAt
      - updatedAt
      type: object
    AlertmanagertypesPostableRoutePolicy:
      properties:
        channels:
          items:
            type: string
          nullable: true
          type: array
        description:
          type: string
        expression:
          type: string
        kind:
          $ref: '#/components/schemas/AlertmanagertypesExpressionKind'
        name:
          type: string
        tags:
          items:
            type: string
          nullable: true
          type: array
      required:
      - expression
      - channels
      - name
      type: object
    AuthtypesAttributeMapping:
      properties:
        email:
          type: string
        groups:
          type: string
        name:
          type: string
        role:
          type: string
      type: object
    AuthtypesAuthDomainConfig:
      properties:
        googleAuthConfig:
          $ref: '#/components/schemas/AuthtypesGoogleConfig'
        oidcConfig:
          $ref: '#/components/schemas/AuthtypesOIDCConfig'
        roleMapping:
          $ref: '#/components/schemas/AuthtypesRoleMapping'
        samlConfig:
          $ref: '#/components/schemas/AuthtypesSamlConfig'
        ssoEnabled:
          type: boolean
        ssoType:
          type: string
      type: object
    AuthtypesAuthNProviderInfo:
      properties:
        relayStatePath:
          nullable: true
          type: string
      type: object
    AuthtypesAuthNSupport:
      properties:
        callback:
          items:
            $ref: '#/components/schemas/AuthtypesCallbackAuthNSupport'
          nullable: true
          type: array
        password:
          items:
            $ref: '#/components/schemas/AuthtypesPasswordAuthNSupport'
          nullable: true
          type: array
      type: object
    AuthtypesCallbackAuthNSupport:
      properties:
        provider:
          type: string
        url:
          type: string
      type: object
    AuthtypesGettableAuthDomain:
      properties:
        authNProviderInfo:
          $ref: '#/components/schemas/AuthtypesAuthNProviderInfo'
        createdAt:
          format: date-time
          type: string
        googleAuthConfig:
          $ref: '#/components/schemas/AuthtypesGoogleConfig'
        id:
          type: string
        name:
          type: string
        oidcConfig:
          $ref: '#/components/schemas/AuthtypesOIDCConfig'
        orgId:
          type: string
        roleMapping:
          $ref: '#/components/schemas/AuthtypesRoleMapping'
        samlConfig:
          $ref: '#/components/schemas/AuthtypesSamlConfig'
        ssoEnabled:
          type: boolean
        ssoType:
          type: string
        updatedAt:
          format: date-time
          type: string
      required:
      - id
      type: object
    AuthtypesGettableObjects:
      properties:
        resource:
          $ref: '#/components/schemas/AuthtypesResource'
        selectors:
          items:
            type: string
          type: array
      required:
      - resource
      - selectors
      type: object
    AuthtypesGettableResources:
      properties:
        relations:
          additionalProperties:
            items:
              type: string
            type: array
          nullable: true
          type: object
        resources:
          items:
            $ref: '#/components/schemas/AuthtypesResource'
          type: array
      required:
      - resources
      - relations
      type: object
    AuthtypesGettableToken:
      properties:
        accessToken:
          type: string
        expiresIn:
          type: integer
        refreshToken:
          type: string
        tokenType:
          type: string
      type: object
    AuthtypesGettableTransaction:
      properties:
        authorized:
          type: boolean
        object:
          $ref: '#/components/schemas/AuthtypesObject'
        relation:
          type: string
      required:
      - relation
      - object
      - authorized
      type: object
    AuthtypesGoogleConfig:
      properties:
        allowedGroups:
          items:
            type: string
          type: array
        clientId:
          type: string
        clientSecret:
          type: string
        domainToAdminEmail:
          additionalProperties:
            type: string
          type: object
        fetchGroups:
          type: boolean
        fetchTransitiveGroupMembership:
          type: boolean
        insecureSkipEmailVerified:
          type: boolean
        redirectURI:
          type: string
        serviceAccountJson:
          type: string
      type: object
    AuthtypesOIDCConfig:
      properties:
        claimMapping:
          $ref: '#/components/schemas/AuthtypesAttributeMapping'
        clientId:
          type: string
        clientSecret:
          type: string
        getUserInfo:
          type: boolean
        insecureSkipEmailVerified:
          type: boolean
        issuer:
          type: string
        issuerAlias:
          type: string
      type: object
    AuthtypesObject:
      properties:
        resource:
          $ref: '#/components/schemas/AuthtypesResource'
        selector:
          type: string
      required:
      - resource
      - selector
      type: object
    AuthtypesOrgSessionContext:
      properties:
        authNSupport:
          $ref: '#/components/schemas/AuthtypesAuthNSupport'
        id:
          type: string
        name:
          type: string
        warning:
          $ref: '#/components/schemas/ErrorsJSON'
      type: object
    AuthtypesPasswordAuthNSupport:
      properties:
        provider:
          type: string
      type: object
    AuthtypesPatchableObjects:
      properties:
        additions:
          items:
            $ref: '#/components/schemas/AuthtypesGettableObjects'
          nullable: true
          type: array
        deletions:
          items:
            $ref: '#/components/schemas/AuthtypesGettableObjects'
          nullable: true
          type: array
      required:
      - additions
      - deletions
      type: object
    AuthtypesPatchableRole:
      properties:
        description:
          type: string
      required:
      - description
      type: object
    AuthtypesPostableAuthDomain:
      properties:
        config:
          $ref: '#/components/schemas/AuthtypesAuthDomainConfig'
        name:
          type: string
      type: object
    AuthtypesPostableEmailPasswordSession:
      properties:
        email:
          type: string
        orgId:
          type: string
        password:
          type: string
      type: object
    AuthtypesPostableRole:
      properties:
        description:
          type: string
        name:
          type: string
      required:
      - name
      type: object
    AuthtypesPostableRotateToken:
      properties:
        refreshToken:
          type: string
      type: object
    AuthtypesResource:
      properties:
        name:
          type: string
        type:
          type: string
      required:
      - name
      - type
      type: object
    AuthtypesRole:
      properties:
        createdAt:
          format: date-time
          type: string
        description:
          type: string
        id:
          type: string
        name:
          type: string
        orgId:
          type: string
        type:
          type: string
        updatedAt:
          format: date-time
          type: string
      required:
      - id
      - name
      - description
      - type
      - orgId
      type: object
    AuthtypesRoleMapping:
      properties:
        defaultRole:
          type: string
        groupMappings:
          additionalProperties:
            type: string
          nullable: true
          type: object
        useRoleAttribute:
          type: boolean
      type: object
    AuthtypesSamlConfig:
      properties:
        attributeMapping:
          $ref: '#/components/schemas/AuthtypesAttributeMapping'
        insecureSkipAuthNRequestsSigned:
          type: boolean
        samlCert:
          type: string
        samlEntity:
          type: string
        samlIdp:
          type: string
      type: object
    AuthtypesSessionContext:
      properties:
        exists:
          type: boolean
        orgs:
          items:
            $ref: '#/components/schemas/AuthtypesOrgSessionContext'
          nullable: true
          type: array
      type: object
    AuthtypesTransaction:
      properties:
        object:
          $ref: '#/components/schemas/AuthtypesObject'
        relation:
          type: string
      required:
      - relation
      - object
      type: object
    AuthtypesUpdateableAuthDomain:
      properties:
        config:
          $ref: '#/components/schemas/AuthtypesAuthDomainConfig'
      type: object
    AuthtypesUserRole:
      properties:
        createdAt:
          format: date-time
          type: string
        id:
          type: string
        role:
          $ref: '#/components/schemas/AuthtypesRole'
        roleId:
          type: string
        updatedAt:
          format: date-time
          type: string
        userId:
          type: string
      required:
      - id
      - userId
      - roleId
      - createdAt
      - updatedAt
      - role
      type: object
    AuthtypesUserWithRoles:
      properties:
        createdAt:
          format: date-time
          type: string
        displayName:
          type: string
        email:
          type: string
        id:
          type: string
        isRoot:
          type: boolean
        orgId:
          type: string
        status:
          type: string
        updatedAt:
          format: date-time
          type: string
        userRoles:
          items:
            $ref: '#/components/schemas/AuthtypesUserRole'
          nullable: true
          type: array
      required:
      - id
      type: object
    CloudintegrationtypesAWSAccountConfig:
      properties:
        regions:
          items:
            type: string
          type: array
      required:
      - regions
      type: object
    CloudintegrationtypesAWSCloudWatchLogsSubscription:
      properties:
        filterPattern:
          type: string
        logGroupNamePrefix:
          type: string
      required:
      - logGroupNamePrefix
      - filterPattern
      type: object
    CloudintegrationtypesAWSCloudWatchMetricStreamFilter:
      properties:
        metricNames:
          items:
            type: string
          type: array
        namespace:
          type: string
      required:
      - namespace
      type: object
    CloudintegrationtypesAWSConnectionArtifact:
      properties:
        connectionUrl:
          type: string
      required:
      - connectionUrl
      type: object
    CloudintegrationtypesAWSIntegrationConfig:
      properties:
        enabledRegions:
          items:
            type: string
          type: array
        telemetryCollectionStrategy:
          $ref: '#/components/schemas/CloudintegrationtypesAWSTelemetryCollectionStrategy'
      required:
      - enabledRegions
      - telemetryCollectionStrategy
      type: object
    CloudintegrationtypesAWSLogsCollectionStrategy:
      properties:
        subscriptions:
          items:
            $ref: '#/components/schemas/CloudintegrationtypesAWSCloudWatchLogsSubscription'
          type: array
      required:
      - subscriptions
      type: object
    CloudintegrationtypesAWSMetricsCollectionStrategy:
      properties:
        streamFilters:
          items:
            $ref: '#/components/schemas/CloudintegrationtypesAWSCloudWatchMetricStreamFilter'
          type: array
      required:
      - streamFilters
      type: object
    CloudintegrationtypesAWSPostableAccountConfig:
      properties:
        deploymentRegion:
          type: string
        regions:
          items:
            type: string
          type: array
      required:
      - deploymentRegion
      - regions
      type: object
    CloudintegrationtypesAWSServiceConfig:
      properties:
        logs:
          $ref: '#/components/schemas/CloudintegrationtypesAWSServiceLogsConfig'
        metrics:
          $ref: '#/components/schemas/CloudintegrationtypesAWSServiceMetricsConfig'
      type: object
    CloudintegrationtypesAWSServiceLogsConfig:
      properties:
        enabled:
          type: boolean
        s3Buckets:
          additionalProperties:
            items:
              type: string
            type: array
          type: object
      type: object
    CloudintegrationtypesAWSServiceMetricsConfig:
      properties:
        enabled:
          type: boolean
      type: object
    CloudintegrationtypesAWSTelemetryCollectionStrategy:
      properties:
        logs:
          $ref: '#/components/schemas/CloudintegrationtypesAWSLogsCollectionStrategy'
        metrics:
          $ref: '#/components/schemas/CloudintegrationtypesAWSMetricsCollectionStrategy'
        s3Buckets:
          additionalProperties:
            items:
              type: string
            type: array
          type: object
      type: object
    CloudintegrationtypesAccount:
      properties:
        agentReport:
          $ref: '#/components/schemas/CloudintegrationtypesAgentReport'
        config:
          $ref: '#/components/schemas/CloudintegrationtypesAccountConfig'
        createdAt:
          format: date-time
          type: string
        id:
          type: string
        orgId:
          type: string
        provider:
          type: string
        providerAccountId:
          nullable: true
          type: string
        removedAt:
          format: date-time
          nullable: true
          type: string
        updatedAt:
          format: date-time
          type: string
      required:
      - id
      - providerAccountId
      - provider
      - removedAt
      - agentReport
      - orgId
      - config
      type: object
    CloudintegrationtypesAccountConfig:
      properties:
        aws:
          $ref: '#/components/schemas/CloudintegrationtypesAWSAccountConfig'
        azure:
          $ref: '#/components/schemas/CloudintegrationtypesAzureAccountConfig'
      type: object
    CloudintegrationtypesAgentReport:
      nullable: true
      properties:
        data:
          additionalProperties: {}
          nullable: true
          type: object
        timestampMillis:
          format: int64
          type: integer
      required:
      - timestampMillis
      - data
      type: object
    CloudintegrationtypesAssets:
      properties:
        dashboards:
          items:
            $ref: '#/components/schemas/CloudintegrationtypesDashboard'
          nullable: true
          type: array
      type: object
    CloudintegrationtypesAzureAccountConfig:
      properties:
        deploymentRegion:
          type: string
        resourceGroups:
          items:
            type: string
          type: array
      required:
      - deploymentRegion
      - resourceGroups
      type: object
    CloudintegrationtypesAzureConnectionArtifact:
      properties:
        cliCommand:
          type: string
        cloudPowerShellCommand:
          type: string
      required:
      - cliCommand
      - cloudPowerShellCommand
      type: object
    CloudintegrationtypesAzureIntegrationConfig:
      properties:
        deploymentRegion:
          type: string
        resourceGroups:
          items:
            type: string
          type: array
        telemetryCollectionStrategy:
          items:
            $ref: '#/components/schemas/CloudintegrationtypesAzureTelemetryCollectionStrategy'
          type: array
      required:
      - deploymentRegion
      - resourceGroups
      - telemetryCollectionStrategy
      type: object
    CloudintegrationtypesAzureLogsCollectionStrategy:
      properties:
        categoryGroups:
          items:
            type: string
          type: array
      required:
      - categoryGroups
      type: object
    CloudintegrationtypesAzureMetricsCollectionStrategy:
      type: object
    CloudintegrationtypesAzureServiceConfig:
      properties:
        logs:
          $ref: '#/components/schemas/CloudintegrationtypesAzureServiceLogsConfig'
        metrics:
          $ref: '#/components/schemas/CloudintegrationtypesAzureServiceMetricsConfig'
      required:
      - logs
      - metrics
      type: object
    CloudintegrationtypesAzureServiceLogsConfig:
      properties:
        enabled:
          type: boolean
      type: object
    CloudintegrationtypesAzureServiceMetricsConfig:
      properties:
        enabled:
          type: boolean
      type: object
    CloudintegrationtypesAzureTelemetryCollectionStrategy:
      properties:
        logs:
          $ref: '#/components/schemas/CloudintegrationtypesAzureLogsCollectionStrategy'
        metrics:
          $ref: '#/components/schemas/CloudintegrationtypesAzureMetricsCollectionStrategy'
        resourceProvider:
          type: string
        resourceType:
          type: string
      required:
      - resourceProvider
      - resourceType
      type: object
    CloudintegrationtypesCloudIntegrationService:
      nullable: true
      properties:
        cloudIntegrationId:
          type: string
        config:
          $ref: '#/components/schemas/CloudintegrationtypesServiceConfig'
        createdAt:
          format: date-time
          type: string
        id:
          type: string
        type:
          $ref: '#/components/schemas/CloudintegrationtypesServiceID'
        updatedAt:
          format: date-time
          type: string
      required:
      - id
      type: object
    CloudintegrationtypesCollectedLogAttribute:
      properties:
        name:
          type: string
        path:
          type: string
        type:
          type: string
      type: object
    CloudintegrationtypesCollectedMetric:
      properties:
        description:
          type: string
        name:
          type: string
        type:
          type: string
        unit:
          type: string
      type: object
    CloudintegrationtypesConnectionArtifact:
      properties:
        aws:
          $ref: '#/components/schemas/CloudintegrationtypesAWSConnectionArtifact'
        azure:
          $ref: '#/components/schemas/CloudintegrationtypesAzureConnectionArtifact'
      type: object
    CloudintegrationtypesCredentials:
      properties:
        ingestionKey:
          type: string
        ingestionUrl:
          type: string
        sigNozApiKey:
          type: string
        sigNozApiUrl:
          type: string
      required:
      - sigNozApiUrl
      - sigNozApiKey
      - ingestionUrl
      - ingestionKey
      type: object
    CloudintegrationtypesDashboard:
      properties:
        definition:
          $ref: '#/components/schemas/DashboardtypesStorableDashboardData'
        description:
          type: string
        id:
          type: string
        title:
          type: string
      type: object
    CloudintegrationtypesDataCollected:
      properties:
        logs:
          items:
            $ref: '#/components/schemas/CloudintegrationtypesCollectedLogAttribute'
          nullable: true
          type: array
        metrics:
          items:
            $ref: '#/components/schemas/CloudintegrationtypesCollectedMetric'
          nullable: true
          type: array
      type: object
    CloudintegrationtypesGettableAccountWithConnectionArtifact:
      properties:
        connectionArtifact:
          $ref: '#/components/schemas/CloudintegrationtypesConnectionArtifact'
        id:
          type: string
      required:
      - id
      - connectionArtifact
      type: object
    CloudintegrationtypesGettableAccounts:
      properties:
        accounts:
          items:
            $ref: '#/components/schemas/CloudintegrationtypesAccount'
          type: array
      required:
      - accounts
      type: object
    CloudintegrationtypesGettableAgentCheckIn:
      properties:
        account_id:
          type: string
        cloud_account_id:
          type: string
        cloudIntegrationId:
          type: string
        integration_config:
          $ref: '#/components/schemas/CloudintegrationtypesIntegrationConfig'
        integrationConfig:
          $ref: '#/components/schemas/CloudintegrationtypesProviderIntegrationConfig'
        providerAccountId:
          type: string
        removed_at:
          format: date-time
          nullable: true
          type: string
        removedAt:
          format: date-time
          nullable: true
          type: string
      required:
      - account_id
      - cloud_account_id
      - integration_config
      - removed_at
      - cloudIntegrationId
      - providerAccountId
      - integrationConfig
      - removedAt
      type: object
    CloudintegrationtypesGettableServicesMetadata:
      properties:
        services:
          items:
            $ref: '#/components/schemas/CloudintegrationtypesServiceMetadata'
          type: array
      required:
      - services
      type: object
    CloudintegrationtypesIntegrationConfig:
      nullable: true
      properties:
        enabled_regions:
          items:
            type: string
          type: array
        telemetry:
          $ref: '#/components/schemas/CloudintegrationtypesOldAWSCollectionStrategy'
      required:
      - enabled_regions
      - telemetry
      type: object
    CloudintegrationtypesOldAWSCollectionStrategy:
      properties:
        aws_logs:
          $ref: '#/components/schemas/CloudintegrationtypesOldAWSLogsStrategy'
        aws_metrics:
          $ref: '#/components/schemas/CloudintegrationtypesOldAWSMetricsStrategy'
        provider:
          type: string
        s3_buckets:
          additionalProperties:
            items:
              type: string
            type: array
          type: object
      type: object
    CloudintegrationtypesOldAWSLogsStrategy:
      properties:
        cloudwatch_logs_subscriptions:
          items:
            properties:
              filter_pattern:
                type: string
              log_group_name_prefix:
                type: string
            type: object
          nullable: true
          type: array
      type: object
    CloudintegrationtypesOldAWSMetricsStrategy:
      properties:
        cloudwatch_metric_stream_filters:
          items:
            properties:
              MetricNames:
                items:
                  type: string
                type: array
              Namespace:
                type: string
            type: object
          nullable: true
          type: array
      type: object
    CloudintegrationtypesPostableAccount:
      properties:
        config:
          $ref: '#/components/schemas/CloudintegrationtypesPostableAccountConfig'
        credentials:
          $ref: '#/components/schemas/CloudintegrationtypesCredentials'
      required:
      - config
      - credentials
      type: object
    CloudintegrationtypesPostableAccountConfig:
      properties:
        aws:
          $ref: '#/components/schemas/CloudintegrationtypesAWSPostableAccountConfig'
        azure:
          $ref: '#/components/schemas/CloudintegrationtypesAzureAccountConfig'
      type: object
    CloudintegrationtypesPostableAgentCheckIn:
      properties:
        account_id:
          type: string
        cloud_account_id:
          type: string
        cloudIntegrationId:
          type: string
        data:
          additionalProperties: {}
          nullable: true
          type: object
        providerAccountId:
          type: string
      required:
      - data
      type: object
    CloudintegrationtypesProviderIntegrationConfig:
      properties:
        aws:
          $ref: '#/components/schemas/CloudintegrationtypesAWSIntegrationConfig'
        azure:
          $ref: '#/components/schemas/CloudintegrationtypesAzureIntegrationConfig'
      type: object
    CloudintegrationtypesService:
      properties:
        assets:
          $ref: '#/components/schemas/CloudintegrationtypesAssets'
        cloudIntegrationService:
          $ref: '#/components/schemas/CloudintegrationtypesCloudIntegrationService'
        dataCollected:
          $ref: '#/components/schemas/CloudintegrationtypesDataCollected'
        icon:
          type: string
        id:
          type: string
        overview:
          type: string
        supportedSignals:
          $ref: '#/components/schemas/CloudintegrationtypesSupportedSignals'
        telemetryCollectionStrategy:
          $ref: '#/components/schemas/CloudintegrationtypesTelemetryCollectionStrategy'
        title:
          type: string
      required:
      - id
      - title
      - icon
      - overview
      - assets
      - supportedSignals
      - dataCollected
      - telemetryCollectionStrategy
      - cloudIntegrationService
      type: object
    CloudintegrationtypesServiceConfig:
      properties:
        aws:
          $ref: '#/components/schemas/CloudintegrationtypesAWSServiceConfig'
        azure:
          $ref: '#/components/schemas/CloudintegrationtypesAzureServiceConfig'
      type: object
    CloudintegrationtypesServiceID:
      enum:
      - alb
      - api-gateway
      - dynamodb
      - ec2
      - ecs
      - eks
      - elasticache
      - lambda
      - msk
      - rds
      - s3sync
      - sns
      - sqs
      - storageaccountsblob
      - cdnprofile
      type: string
    CloudintegrationtypesServiceMetadata:
      properties:
        enabled:
          type: boolean
        icon:
          type: string
        id:
          type: string
        title:
          type: string
      required:
      - id
      - title
      - icon
      - enabled
      type: object
    CloudintegrationtypesSupportedSignals:
      properties:
        logs:
          type: boolean
        metrics:
          type: boolean
      type: object
    CloudintegrationtypesTelemetryCollectionStrategy:
      properties:
        aws:
          $ref: '#/components/schemas/CloudintegrationtypesAWSTelemetryCollectionStrategy'
        azure:
          $ref: '#/components/schemas/CloudintegrationtypesAzureTelemetryCollectionStrategy'
      type: object
    CloudintegrationtypesUpdatableAccount:
      properties:
        config:
          $ref: '#/components/schemas/CloudintegrationtypesUpdatableAccountConfig'
      required:
      - config
      type: object
    CloudintegrationtypesUpdatableAccountConfig:
      properties:
        aws:
          $ref: '#/components/schemas/CloudintegrationtypesAWSAccountConfig'
        azure:
          $ref: '#/components/schemas/CloudintegrationtypesUpdatableAzureAccountConfig'
      type: object
    CloudintegrationtypesUpdatableAzureAccountConfig:
      properties:
        resourceGroups:
          items:
            type: string
          type: array
      required:
      - resourceGroups
      type: object
    CloudintegrationtypesUpdatableService:
      properties:
        config:
          $ref: '#/components/schemas/CloudintegrationtypesServiceConfig'
      required:
      - config
      type: object
    ConfigAuthorization:
      properties:
        credentials:
          type: string
        credentials_file:
          type: string
        credentials_ref:
          type: string
        type:
          type: string
      type: object
    ConfigBasicAuth:
      properties:
        password:
          type: string
        password_file:
          type: string
        password_ref:
          type: string
        username:
          type: string
        username_file:
          type: string
        username_ref:
          type: string
      type: object
    ConfigDiscordConfig:
      properties:
        avatar_url:
          type: string
        content:
          type: string
        http_config:
          $ref: '#/components/schemas/ConfigHTTPClientConfig'
        message:
          type: string
        send_resolved:
          type: boolean
        title:
          type: string
        username:
          type: string
        webhook_url:
          $ref: '#/components/schemas/ConfigSecretURL'
        webhook_url_file:
          type: string
      type: object
    ConfigDuration:
      format: int64
      type: string
    ConfigEmailConfig:
      properties:
        auth_identity:
          type: string
        auth_password:
          type: string
        auth_password_file:
          type: string
        auth_secret:
          type: string
        auth_secret_file:
          type: string
        auth_username:
          type: string
        force_implicit_tls:
          nullable: true
          type: boolean
        from:
          type: string
        headers:
          additionalProperties:
            type: string
          type: object
        hello:
          type: string
        html:
          type: string
        require_tls:
          nullable: true
          type: boolean
        send_resolved:
          type: boolean
        smarthost:
          $ref: '#/components/schemas/ConfigHostPort'
        text:
          type: string
        threading:
          $ref: '#/components/schemas/ConfigThreadingConfig'
        tls_config:
          $ref: '#/components/schemas/ConfigTLSConfig'
        to:
          type: string
      type: object
    ConfigHTTPClientConfig:
      properties:
        authorization:
          $ref: '#/components/schemas/ConfigAuthorization'
        basic_auth:
          $ref: '#/components/schemas/ConfigBasicAuth'
        bearer_token:
          type: string
        bearer_token_file:
          type: string
        enable_http2:
          type: boolean
        follow_redirects:
          type: boolean
        http_headers:
          $ref: '#/components/schemas/ConfigHeaders'
        no_proxy:
          type: string
        oauth2:
          $ref: '#/components/schemas/ConfigOAuth2'
        proxy_connect_header:
          $ref: '#/components/schemas/ConfigProxyHeader'
        proxy_from_environment:
          type: boolean
        proxy_url:
          $ref: '#/components/schemas/ConfigURL'
        tls_config:
          $ref: '#/components/schemas/ConfigTLSConfig'
      type: object
    ConfigHeaders:
      type: object
    ConfigHostPort:
      type: object
    ConfigIncidentioConfig:
      properties:
        alert_source_token:
          type: string
        alert_source_token_file:
          type: string
        http_config:
          $ref: '#/components/schemas/ConfigHTTPClientConfig'
        max_alerts:
          minimum: 0
          type: integer
        send_resolved:
          type: boolean
        timeout:
          $ref: '#/components/schemas/TimeDuration'
        url:
          $ref: '#/components/schemas/ConfigURLType2'
        url_file:
          type: string
      type: object
    ConfigJiraConfig:
      properties:
        api_type:
          type: string
        api_url:
          $ref: '#/components/schemas/ConfigURLType2'
        custom_fields:
          additionalProperties: {}
          type: object
        description:
          $ref: '#/components/schemas/ConfigJiraFieldConfig'
        http_config:
          $ref: '#/components/schemas/ConfigHTTPClientConfig'
        issue_type:
          type: string
        labels:
          items:
            type: string
          type: array
        priority:
          type: string
        project:
          type: string
        reopen_duration:
          $ref: '#/components/schemas/ModelDuration'
        reopen_transition:
          type: string
        resolve_transition:
          type: string
        send_resolved:
          type: boolean
        summary:
          $ref: '#/components/schemas/ConfigJiraFieldConfig'
        wont_fix_resolution:
          type: string
      type: object
    ConfigJiraFieldConfig:
      properties:
        enable_update:
          nullable: true
          type: boolean
        template:
          type: string
      type: object
    ConfigMSTeamsConfig:
      properties:
        http_config:
          $ref: '#/components/schemas/ConfigHTTPClientConfig'
        send_resolved:
          type: boolean
        summary:
          type: string
        text:
          type: string
        title:
          type: string
        webhook_url:
          $ref: '#/components/schemas/ConfigSecretURL'
        webhook_url_file:
          type: string
      type: object
    ConfigMSTeamsV2Config:
      properties:
        http_config:
          $ref: '#/components/schemas/ConfigHTTPClientConfig'
        send_resolved:
          type: boolean
        text:
          type: string
        title:
          type: string
        webhook_url:
          $ref: '#/components/schemas/ConfigSecretURL'
        webhook_url_file:
          type: string
      type: object
    ConfigMattermostAttachment:
      properties:
        author_icon:
          type: string
        author_link:
          type: string
        author_name:
          type: string
        color:
          type: string
        fallback:
          type: string
        fields:
          items:
            $ref: '#/components/schemas/ConfigMattermostField'
          type: array
        footer:
          type: string
        footer_icon:
          type: string
        image_url:
          type: string
        pretext:
          type: string
        text:
          type: string
        thumb_url:
          type: string
        title:
          type: string
        title_link:
          type: string
      type: object
    ConfigMattermostConfig:
      properties:
        attachments:
          items:
            $ref: '#/components/schemas/ConfigMattermostAttachment'
          type: array
        channel:
          type: string
        http_config:
          $ref: '#/components/schemas/ConfigHTTPClientConfig'
        icon_emoji:
          type: string
        icon_url:
          type: string
        priority:
          $ref: '#/components/schemas/ConfigMattermostPriority'
        props:
          $ref: '#/components/schemas/ConfigMattermostProps'
        send_resolved:
          type: boolean
        text:
          type: string
        type:
          type: string
        username:
          type: string
        webhook_url:
          $ref: '#/components/schemas/ConfigSecretURL'
        webhook_url_file:
          type: string
      type: object
    ConfigMattermostField:
      properties:
        short:
          nullable: true
          type: boolean
        title:
          type: string
        value:
          type: string
      type: object
    ConfigMattermostPriority:
      properties:
        persistent_notifications:
          type: boolean
        priority:
          type: string
        requested_ack:
          type: boolean
      type: object
    ConfigMattermostProps:
      properties:
        card:
          type: string
      type: object
    ConfigOAuth2:
      properties:
        audience:
          type: string
        claims:
          additionalProperties: {}
          type: object
        client_certificate_key:
          type: string
        client_certificate_key_file:
          type: string
        client_certificate_key_id:
          type: string
        client_certificate_key_ref:
          type: string
        client_id:
          type: string
        client_secret:
          type: string
        client_secret_file:
          type: string
        client_secret_ref:
          type: string
        endpoint_params:
          additionalProperties:
            type: string
          type: object
        grant_type:
          type: string
        iss:
          type: string
        no_proxy:
          type: string
        proxy_connect_header:
          $ref: '#/components/schemas/ConfigProxyHeader'
        proxy_from_environment:
          type: boolean
        proxy_url:
          $ref: '#/components/schemas/ConfigURL'
        scopes:
          items:
            type: string
          type: array
        signature_algorithm:
          type: string
        token_url:
          type: string
      type: object
    ConfigOpsGenieConfig:
      properties:
        actions:
          type: string
        api_key:
          type: string
        api_key_file:
          type: string
        api_url:
          $ref: '#/components/schemas/ConfigURLType2'
        description:
          type: string
        details:
          additionalProperties:
            type: string
          type: object
        entity:
          type: string
        http_config:
          $ref: '#/components/schemas/ConfigHTTPClientConfig'
        message:
          type: string
        note:
          type: string
        priority:
          type: string
        responders:
          items:
            $ref: '#/components/schemas/ConfigOpsGenieConfigResponder'
          type: array
        send_resolved:
          type: boolean
        source:
          type: string
        tags:
          type: string
        update_alerts:
          type: boolean
      type: object
    ConfigOpsGenieConfigResponder:
      properties:
        id:
          type: string
        name:
          type: string
        type:
          type: string
        username:
          type: string
      type: object
    ConfigPagerdutyConfig:
      properties:
        class:
          type: string
        client:
          type: string
        client_url:
          type: string
        component:
          type: string
        description:
          type: string
        details:
          additionalProperties: {}
          type: object
        group:
          type: string
        http_config:
          $ref: '#/components/schemas/ConfigHTTPClientConfig'
        images:
          items:
            $ref: '#/components/schemas/ConfigPagerdutyImage'
          type: array
        links:
          items:
            $ref: '#/components/schemas/ConfigPagerdutyLink'
          type: array
        routing_key:
          type: string
        routing_key_file:
          type: string
        send_resolved:
          type: boolean
        service_key:
          type: string
        service_key_file:
          type: string
        severity:
          type: string
        source:
          type: string
        timeout:
          $ref: '#/components/schemas/TimeDuration'
        url:
          $ref: '#/components/schemas/ConfigURLType2'
      type: object
    ConfigPagerdutyImage:
      properties:
        alt:
          type: string
        href:
          type: string
        src:
          type: string
      type: object
    ConfigPagerdutyLink:
      properties:
        href:
          type: string
        text:
          type: string
      type: object
    ConfigProxyHeader:
      additionalProperties:
        items:
          type: string
        type: array
      type: object
    ConfigPushoverConfig:
      properties:
        device:
          type: string
        expire:
          $ref: '#/components/schemas/ConfigDuration'
        html:
          type: boolean
        http_config:
          $ref: '#/components/schemas/ConfigHTTPClientConfig'
        message:
          type: string
        monospace:
          type: boolean
        priority:
          type: string
        retry:
          $ref: '#/components/schemas/ConfigDuration'
        send_resolved:
          type: boolean
        sound:
          type: string
        title:
          type: string
        token:
          type: string
        token_file:
          type: string
        ttl:
          $ref: '#/components/schemas/ConfigDuration'
        url:
          type: string
        url_title:
          type: string
        user_key:
          type: string
        user_key_file:
          type: string
      type: object
    ConfigReceiver:
      properties:
        discord_configs:
          items:
            $ref: '#/components/schemas/ConfigDiscordConfig'
          type: array
        email_configs:
          items:
            $ref: '#/components/schemas/ConfigEmailConfig'
          type: array
        incidentio_configs:
          items:
            $ref: '#/components/schemas/ConfigIncidentioConfig'
          type: array
        jira_configs:
          items:
            $ref: '#/components/schemas/ConfigJiraConfig'
          type: array
        mattermost_configs:
          items:
            $ref: '#/components/schemas/ConfigMattermostConfig'
          type: array
        msteams_configs:
          items:
            $ref: '#/components/schemas/ConfigMSTeamsConfig'
          type: array
        msteamsv2_configs:
          items:
            $ref: '#/components/schemas/ConfigMSTeamsV2Config'
          type: array
        name:
          type: string
        opsgenie_configs:
          items:
            $ref: '#/components/schemas/ConfigOpsGenieConfig'
          type: array
        pagerduty_configs:
          items:
            $ref: '#/components/schemas/ConfigPagerdutyConfig'
          type: array
        pushover_configs:
          items:
            $ref: '#/components/schemas/ConfigPushoverConfig'
          type: array
        rocketchat_configs:
          items:
            $ref: '#/components/schemas/ConfigRocketchatConfig'
          type: array
        slack_configs:
          items:
            $ref: '#/components/schemas/ConfigSlackConfig'
          type: array
        sns_configs:
          items:
            $ref: '#/components/schemas/ConfigSNSConfig'
          type: array
        telegram_configs:
          items:
            $ref: '#/components/schemas/ConfigTelegramConfig'
          type: array
        victorops_configs:
          items:
            $ref: '#/components/schemas/ConfigVictorOpsConfig'
          type: array
        webex_configs:
          items:
            $ref: '#/components/schemas/ConfigWebexConfig'
          type: array
        webhook_configs:
          items:
            $ref: '#/components/schemas/ConfigWebhookConfig'
          type: array
        wechat_configs:
          items:
            $ref: '#/components/schemas/ConfigWechatConfig'
          type: array
      type: object
    ConfigRocketchatAttachmentAction:
      properties:
        image_url:
          type: string
        is_webview:
          type: boolean
        msg:
          type: string
        msg_in_chat_window:
          type: boolean
        msg_processing_type:
          type: string
        text:
          type: string
        type:
          type: string
        url:
          type: string
        webview_height_ratio:
          type: string
      type: object
    ConfigRocketchatAttachmentField:
      properties:
        short:
          nullable: true
          type: boolean
        title:
          type: string
        value:
          type: string
      type: object
    ConfigRocketchatConfig:
      properties:
        actions:
          items:
            $ref: '#/components/schemas/ConfigRocketchatAttachmentAction'
          type: array
        api_url:
          $ref: '#/components/schemas/ConfigURLType2'
        channel:
          type: string
        color:
          type: string
        emoji:
          type: string
        fields:
          items:
            $ref: '#/components/schemas/ConfigRocketchatAttachmentField'
          type: array
        http_config:
          $ref: '#/components/schemas/ConfigHTTPClientConfig'
        icon_url:
          type: string
        image_url:
          type: string
        link_names:
          type: boolean
        send_resolved:
          type: boolean
        short_fields:
          type: boolean
        text:
          type: string
        thumb_url:
          type: string
        title:
          type: string
        title_link:
          type: string
        token:
          type: string
        token_file:
          type: string
        token_id:
          type: string
        token_id_file:
          type: string
      type: object
    ConfigSNSConfig:
      properties:
        api_url:
          type: string
        attributes:
          additionalProperties:
            type: string
          type: object
        http_config:
          $ref: '#/components/schemas/ConfigHTTPClientConfig'
        message:
          type: string
        phone_number:
          type: string
        send_resolved:
          type: boolean
        sigv4:
          $ref: '#/components/schemas/Sigv4SigV4Config'
        subject:
          type: string
        target_arn:
          type: string
        topic_arn:
          type: string
      type: object
    ConfigSecretURL:
      type: object
    ConfigSlackAction:
      properties:
        confirm:
          $ref: '#/components/schemas/ConfigSlackConfirmationField'
        name:
          type: string
        style:
          type: string
        text:
          type: string
        type:
          type: string
        url:
          type: string
        value:
          type: string
      type: object
    ConfigSlackConfig:
      properties:
        actions:
          items:
            $ref: '#/components/schemas/ConfigSlackAction'
          type: array
        api_url:
          $ref: '#/components/schemas/ConfigSecretURL'
        api_url_file:
          type: string
        app_token:
          type: string
        app_token_file:
          type: string
        app_url:
          $ref: '#/components/schemas/ConfigURLType2'
        callback_id:
          type: string
        channel:
          type: string
        color:
          type: string
        fallback:
          type: string
        fields:
          items:
            $ref: '#/components/schemas/ConfigSlackField'
          type: array
        footer:
          type: string
        http_config:
          $ref: '#/components/schemas/ConfigHTTPClientConfig'
        icon_emoji:
          type: string
        icon_url:
          type: string
        image_url:
          type: string
        link_names:
          type: boolean
        message_text:
          type: string
        mrkdwn_in:
          items:
            type: string
          type: array
        pretext:
          type: string
        send_resolved:
          type: boolean
        short_fields:
          type: boolean
        text:
          type: string
        thumb_url:
          type: string
        timeout:
          $ref: '#/components/schemas/TimeDuration'
        title:
          type: string
        title_link:
          type: string
        username:
          type: string
      type: object
    ConfigSlackConfirmationField:
      properties:
        dismiss_text:
          type: string
        ok_text:
          type: string
        text:
          type: string
        title:
          type: string
      type: object
    ConfigSlackField:
      properties:
        short:
          nullable: true
          type: boolean
        title:
          type: string
        value:
          type: string
      type: object
    ConfigTLSConfig:
      properties:
        ca:
          type: string
        ca_file:
          type: string
        ca_ref:
          type: string
        cert:
          type: string
        cert_file:
          type: string
        cert_ref:
          type: string
        insecure_skip_verify:
          type: boolean
        key:
          type: string
        key_file:
          type: string
        key_ref:
          type: string
        max_version:
          minimum: 0
          type: integer
        min_version:
          minimum: 0
          type: integer
        server_name:
          type: string
      type: object
    ConfigTelegramConfig:
      properties:
        api_url:
          $ref: '#/components/schemas/ConfigURLType2'
        chat:
          format: int64
          type: integer
        chat_file:
          type: string
        disable_notifications:
          type: boolean
        http_config:
          $ref: '#/components/schemas/ConfigHTTPClientConfig'
        message:
          type: string
        message_thread_id:
          type: integer
        parse_mode:
          type: string
        send_resolved:
          type: boolean
        token:
          type: string
        token_file:
          type: string
      type: object
    ConfigThreadingConfig:
      properties:
        enabled:
          type: boolean
        thread_by_date:
          type: string
      type: object
    ConfigURL:
      type: object
    ConfigURLType2:
      type: object
    ConfigVictorOpsConfig:
      properties:
        api_key:
          type: string
        api_key_file:
          type: string
        api_url:
          $ref: '#/components/schemas/ConfigURLType2'
        custom_fields:
          additionalProperties:
            type: string
          type: object
        entity_display_name:
          type: string
        http_config:
          $ref: '#/components/schemas/ConfigHTTPClientConfig'
        message_type:
          type: string
        monitoring_tool:
          type: string
        routing_key:
          type: string
        send_resolved:
          type: boolean
        state_message:
          type: string
      type: object
    ConfigWebexConfig:
      properties:
        api_url:
          $ref: '#/components/schemas/ConfigURLType2'
        http_config:
          $ref: '#/components/schemas/ConfigHTTPClientConfig'
        message:
          type: string
        room_id:
          type: string
        send_resolved:
          type: boolean
      type: object
    ConfigWebhookConfig:
      properties:
        http_config:
          $ref: '#/components/schemas/ConfigHTTPClientConfig'
        max_alerts:
          minimum: 0
          type: integer
        send_resolved:
          type: boolean
        timeout:
          $ref: '#/components/schemas/TimeDuration'
        url:
          type: string
        url_file:
          type: string
      type: object
    ConfigWechatConfig:
      properties:
        agent_id:
          type: string
        api_secret:
          type: string
        api_secret_file:
          type: string
        api_url:
          $ref: '#/components/schemas/ConfigURLType2'
        corp_id:
          type: string
        http_config:
          $ref: '#/components/schemas/ConfigHTTPClientConfig'
        message:
          type: string
        message_type:
          type: string
        send_resolved:
          type: boolean
        to_party:
          type: string
        to_tag:
          type: string
        to_user:
          type: string
      type: object
    DashboardtypesDashboard:
      properties:
        createdAt:
          format: date-time
          type: string
        createdBy:
          type: string
        data:
          $ref: '#/components/schemas/DashboardtypesStorableDashboardData'
        id:
          type: string
        locked:
          type: boolean
        org_id:
          type: string
        updatedAt:
          format: date-time
          type: string
        updatedBy:
          type: string
      type: object
    DashboardtypesGettablePublicDasbhboard:
      properties:
        defaultTimeRange:
          type: string
        publicPath:
          type: string
        timeRangeEnabled:
          type: boolean
      type: object
    DashboardtypesGettablePublicDashboardData:
      properties:
        dashboard:
          $ref: '#/components/schemas/DashboardtypesDashboard'
        publicDashboard:
          $ref: '#/components/schemas/DashboardtypesGettablePublicDasbhboard'
      type: object
    DashboardtypesPostablePublicDashboard:
      properties:
        defaultTimeRange:
          type: string
        timeRangeEnabled:
          type: boolean
      type: object
    DashboardtypesStorableDashboardData:
      additionalProperties: {}
      type: object
    DashboardtypesUpdatablePublicDashboard:
      properties:
        defaultTimeRange:
          type: string
        timeRangeEnabled:
          type: boolean
      type: object
    ErrorsJSON:
      properties:
        code:
          type: string
        errors:
          items:
            $ref: '#/components/schemas/ErrorsResponseerroradditional'
          type: array
        message:
          type: string
        url:
          type: string
      required:
      - code
      - message
      type: object
    ErrorsResponseerroradditional:
      properties:
        message:
          type: string
      type: object
    FactoryResponse:
      properties:
        healthy:
          type: boolean
        services:
          additionalProperties:
            items:
              type: string
            type: array
          nullable: true
          type: object
      type: object
    FeaturetypesGettableFeature:
      properties:
        defaultVariant:
          type: string
        description:
          type: string
        kind:
          type: string
        name:
          type: string
        resolvedValue: {}
        stage:
          type: string
        variants:
          additionalProperties: {}
          nullable: true
          type: object
      type: object
    GatewaytypesGettableCreatedIngestionKey:
      properties:
        id:
          type: string
        value:
          type: string
      required:
      - id
      - value
      type: object
    GatewaytypesGettableCreatedIngestionKeyLimit:
      properties:
        id:
          type: string
      required:
      - id
      type: object
    GatewaytypesGettableIngestionKeys:
      properties:
        _pagination:
          $ref: '#/components/schemas/GatewaytypesPagination'
        keys:
          items:
            $ref: '#/components/schemas/GatewaytypesIngestionKey'
          nullable: true
          type: array
      type: object
    GatewaytypesIngestionKey:
      properties:
        created_at:
          format: date-time
          type: string
        expires_at:
          format: date-time
          type: string
        id:
          type: string
        limits:
          items:
            $ref: '#/components/schemas/GatewaytypesLimit'
          nullable: true
          type: array
        name:
          type: string
        tags:
          items:
            type: string
          nullable: true
          type: array
        updated_at:
          format: date-time
          type: string
        value:
          type: string
        workspace_id:
          type: string
      type: object
    GatewaytypesLimit:
      properties:
        config:
          $ref: '#/components/schemas/GatewaytypesLimitConfig'
        created_at:
          format: date-time
          type: string
        id:
          type: string
        key_id:
          type: string
        metric:
          $ref: '#/components/schemas/GatewaytypesLimitMetric'
        signal:
          type: string
        tags:
          items:
            type: string
          nullable: true
          type: array
        updated_at:
          format: date-time
          type: string
      type: object
    GatewaytypesLimitConfig:
      properties:
        day:
          $ref: '#/components/schemas/GatewaytypesLimitValue'
        second:
          $ref: '#/components/schemas/GatewaytypesLimitValue'
      type: object
    GatewaytypesLimitMetric:
      properties:
        day:
          $ref: '#/components/schemas/GatewaytypesLimitMetricValue'
        second:
          $ref: '#/components/schemas/GatewaytypesLimitMetricValue'
      type: object
    GatewaytypesLimitMetricValue:
      properties:
        count:
          format: int64
          type: integer
        size:
          format: int64
          type: integer
      type: object
    GatewaytypesLimitValue:
      properties:
        count:
          nullable: true
          type: integer
        size:
          nullable: true
          type: integer
      type: object
    GatewaytypesPagination:
      properties:
        page:
          type: integer
        pages:
          type: integer
        per_page:
          type: integer
        total:
          type: integer
      type: object
    GatewaytypesPostableIngestionKey:
      properties:
        expires_at:
          format: date-time
          type: string
        name:
          type: string
        tags:
          items:
            type: string
          nullable: true
          type: array
      required:
      - name
      type: object
    GatewaytypesPostableIngestionKeyLimit:
      properties:
        config:
          $ref: '#/components/schemas/GatewaytypesLimitConfig'
        signal:
          type: string
        tags:
          items:
            type: string
          nullable: true
          type: array
      type: object
    GatewaytypesUpdatableIngestionKeyLimit:
      properties:
        config:
          $ref: '#/components/schemas/GatewaytypesLimitConfig'
        tags:
          items:
            type: string
          nullable: true
          type: array
      required:
      - config
      type: object
    GlobaltypesAPIKeyConfig:
      properties:
        enabled:
          type: boolean
      type: object
    GlobaltypesConfig:
      properties:
        external_url:
          type: string
        identN:
          $ref: '#/components/schemas/GlobaltypesIdentNConfig'
        ingestion_url:
          type: string
        mcp_url:
          nullable: true
          type: string
      required:
      - external_url
      - ingestion_url
      - mcp_url
      type: object
    GlobaltypesIdentNConfig:
      properties:
        apikey:
          $ref: '#/components/schemas/GlobaltypesAPIKeyConfig'
        impersonation:
          $ref: '#/components/schemas/GlobaltypesImpersonationConfig'
        tokenizer:
          $ref: '#/components/schemas/GlobaltypesTokenizerConfig'
      type: object
    GlobaltypesImpersonationConfig:
      properties:
        enabled:
          type: boolean
      type: object
    GlobaltypesTokenizerConfig:
      properties:
        enabled:
          type: boolean
      type: object
    InframonitoringtypesHostFilter:
      properties:
        expression:
          type: string
        filterByStatus:
          $ref: '#/components/schemas/InframonitoringtypesHostStatus'
      type: object
    InframonitoringtypesHostRecord:
      properties:
        activeHostCount:
          type: integer
        cpu:
          format: double
          type: number
        diskUsage:
          format: double
          type: number
        hostName:
          type: string
        inactiveHostCount:
          type: integer
        load15:
          format: double
          type: number
        memory:
          format: double
          type: number
        meta:
          additionalProperties: {}
          nullable: true
          type: object
        status:
          $ref: '#/components/schemas/InframonitoringtypesHostStatus'
        wait:
          format: double
          type: number
      required:
      - hostName
      - status
      - activeHostCount
      - inactiveHostCount
      - cpu
      - memory
      - wait
      - load15
      - diskUsage
      - meta
      type: object
    InframonitoringtypesHostStatus:
      enum:
      - active
      - inactive
      - ""
      type: string
    InframonitoringtypesHosts:
      properties:
        endTimeBeforeRetention:
          type: boolean
        records:
          items:
            $ref: '#/components/schemas/InframonitoringtypesHostRecord'
          nullable: true
          type: array
        requiredMetricsCheck:
          $ref: '#/components/schemas/InframonitoringtypesRequiredMetricsCheck'
        total:
          type: integer
        type:
          $ref: '#/components/schemas/InframonitoringtypesResponseType'
        warning:
          $ref: '#/components/schemas/Querybuildertypesv5QueryWarnData'
      required:
      - type
      - records
      - total
      - requiredMetricsCheck
      - endTimeBeforeRetention
      type: object
    InframonitoringtypesPostableHosts:
      properties:
        end:
          format: int64
          type: integer
        filter:
          $ref: '#/components/schemas/InframonitoringtypesHostFilter'
        groupBy:
          items:
            $ref: '#/components/schemas/Querybuildertypesv5GroupByKey'
          nullable: true
          type: array
        limit:
          type: integer
        offset:
          type: integer
        orderBy:
          $ref: '#/components/schemas/Querybuildertypesv5OrderBy'
        start:
          format: int64
          type: integer
      required:
      - start
      - end
      - limit
      type: object
    InframonitoringtypesRequiredMetricsCheck:
      properties:
        missingMetrics:
          items:
            type: string
          nullable: true
          type: array
      required:
      - missingMetrics
      type: object
    InframonitoringtypesResponseType:
      enum:
      - list
      - grouped_list
      type: string
    MetricsexplorertypesInspectMetricsRequest:
      properties:
        end:
          format: int64
          type: integer
        filter:
          $ref: '#/components/schemas/Querybuildertypesv5Filter'
        metricName:
          type: string
        start:
          format: int64
          type: integer
      required:
      - metricName
      - start
      - end
      type: object
    MetricsexplorertypesInspectMetricsResponse:
      properties:
        series:
          items:
            $ref: '#/components/schemas/Querybuildertypesv5TimeSeries'
          nullable: true
          type: array
      required:
      - series
      type: object
    MetricsexplorertypesListMetric:
      properties:
        description:
          type: string
        isMonotonic:
          type: boolean
        metricName:
          type: string
        temporality:
          $ref: '#/components/schemas/MetrictypesTemporality'
        type:
          $ref: '#/components/schemas/MetrictypesType'
        unit:
          type: string
      required:
      - metricName
      - description
      - type
      - unit
      - temporality
      - isMonotonic
      type: object
    MetricsexplorertypesListMetricsResponse:
      properties:
        metrics:
          items:
            $ref: '#/components/schemas/MetricsexplorertypesListMetric'
          nullable: true
          type: array
      required:
      - metrics
      type: object
    MetricsexplorertypesMetricAlert:
      properties:
        alertId:
          type: string
        alertName:
          type: string
      required:
      - alertName
      - alertId
      type: object
    MetricsexplorertypesMetricAlertsResponse:
      properties:
        alerts:
          items:
            $ref: '#/components/schemas/MetricsexplorertypesMetricAlert'
          nullable: true
          type: array
      required:
      - alerts
      type: object
    MetricsexplorertypesMetricAttribute:
      properties:
        key:
          type: string
        valueCount:
          minimum: 0
          type: integer
        values:
          items:
            type: string
          nullable: true
          type: array
      required:
      - key
      - values
      - valueCount
      type: object
    MetricsexplorertypesMetricAttributesResponse:
      properties:
        attributes:
          items:
            $ref: '#/components/schemas/MetricsexplorertypesMetricAttribute'
          nullable: true
          type: array
        totalKeys:
          format: int64
          type: integer
      required:
      - attributes
      - totalKeys
      type: object
    MetricsexplorertypesMetricDashboard:
      properties:
        dashboardId:
          type: string
        dashboardName:
          type: string
        widgetId:
          type: string
        widgetName:
          type: string
      required:
      - dashboardName
      - dashboardId
      - widgetId
      - widgetName
      type: object
    MetricsexplorertypesMetricDashboardsResponse:
      properties:
        dashboards:
          items:
            $ref: '#/components/schemas/MetricsexplorertypesMetricDashboard'
          nullable: true
          type: array
      required:
      - dashboards
      type: object
    MetricsexplorertypesMetricHighlightsResponse:
      properties:
        activeTimeSeries:
          minimum: 0
          type: integer
        dataPoints:
          minimum: 0
          type: integer
        lastReceived:
          minimum: 0
          type: integer
        totalTimeSeries:
          minimum: 0
          type: integer
      required:
      - dataPoints
      - lastReceived
      - totalTimeSeries
      - activeTimeSeries
      type: object
    MetricsexplorertypesMetricMetadata:
      properties:
        description:
          type: string
        isMonotonic:
          type: boolean
        temporality:
          $ref: '#/components/schemas/MetrictypesTemporality'
        type:
          $ref: '#/components/schemas/MetrictypesType'
        unit:
          type: string
      required:
      - description
      - type
      - unit
      - temporality
      - isMonotonic
      type: object
    MetricsexplorertypesMetricsOnboardingResponse:
      properties:
        hasMetrics:
          type: boolean
      required:
      - hasMetrics
      type: object
    MetricsexplorertypesStat:
      properties:
        description:
          type: string
        metricName:
          type: string
        samples:
          minimum: 0
          type: integer
        timeseries:
          minimum: 0
          type: integer
        type:
          $ref: '#/components/schemas/MetrictypesType'
        unit:
          type: string
      required:
      - metricName
      - description
      - type
      - unit
      - timeseries
      - samples
      type: object
    MetricsexplorertypesStatsRequest:
      properties:
        end:
          format: int64
          type: integer
        filter:
          $ref: '#/components/schemas/Querybuildertypesv5Filter'
        limit:
          type: integer
        offset:
          type: integer
        orderBy:
          $ref: '#/components/schemas/Querybuildertypesv5OrderBy'
        start:
          format: int64
          type: integer
      required:
      - start
      - end
      - limit
      type: object
    MetricsexplorertypesStatsResponse:
      properties:
        metrics:
          items:
            $ref: '#/components/schemas/MetricsexplorertypesStat'
          nullable: true
          type: array
        total:
          minimum: 0
          type: integer
      required:
      - metrics
      - total
      type: object
    MetricsexplorertypesTreemapEntry:
      properties:
        metricName:
          type: string
        percentage:
          format: double
          type: number
        totalValue:
          minimum: 0
          type: integer
      required:
      - metricName
      - percentage
      - totalValue
      type: object
    MetricsexplorertypesTreemapMode:
      enum:
      - timeseries
      - samples
      type: string
    MetricsexplorertypesTreemapRequest:
      properties:
        end:
          format: int64
          type: integer
        filter:
          $ref: '#/components/schemas/Querybuildertypesv5Filter'
        limit:
          type: integer
        mode:
          $ref: '#/components/schemas/MetricsexplorertypesTreemapMode'
        start:
          format: int64
          type: integer
      required:
      - start
      - end
      - limit
      - mode
      type: object
    MetricsexplorertypesTreemapResponse:
      properties:
        samples:
          items:
            $ref: '#/components/schemas/MetricsexplorertypesTreemapEntry'
          nullable: true
          type: array
        timeseries:
          items:
            $ref: '#/components/schemas/MetricsexplorertypesTreemapEntry'
          nullable: true
          type: array
      required:
      - timeseries
      - samples
      type: object
    MetricsexplorertypesUpdateMetricMetadataRequest:
      properties:
        description:
          type: string
        isMonotonic:
          type: boolean
        metricName:
          type: string
        temporality:
          $ref: '#/components/schemas/MetrictypesTemporality'
        type:
          $ref: '#/components/schemas/MetrictypesType'
        unit:
          type: string
      required:
      - metricName
      - type
      - description
      - unit
      - temporality
      - isMonotonic
      type: object
    MetrictypesComparisonSpaceAggregationParam:
      properties:
        operator:
          type: string
        threshold:
          format: double
          type: number
      required:
      - operator
      - threshold
      type: object
    MetrictypesSpaceAggregation:
      enum:
      - sum
      - avg
      - min
      - max
      - count
      - p50
      - p75
      - p90
      - p95
      - p99
      type: string
    MetrictypesTemporality:
      enum:
      - delta
      - cumulative
      - unspecified
      type: string
    MetrictypesTimeAggregation:
      enum:
      - latest
      - sum
      - avg
      - min
      - max
      - count
      - count_distinct
      - rate
      - increase
      type: string
    MetrictypesType:
      enum:
      - gauge
      - sum
      - histogram
      - summary
      - exponentialhistogram
      type: string
    ModelDuration:
      format: int64
      type: integer
    ModelLabelSet:
      additionalProperties:
        type: string
      type: object
    PreferencetypesPreference:
      properties:
        allowedScopes:
          items:
            type: string
          nullable: true
          type: array
        allowedValues:
          items:
            type: string
          nullable: true
          type: array
        defaultValue:
          $ref: '#/components/schemas/PreferencetypesValue'
        description:
          type: string
        name:
          type: string
        value:
          $ref: '#/components/schemas/PreferencetypesValue'
        valueType:
          type: string
      type: object
    PreferencetypesUpdatablePreference:
      properties:
        value: {}
      type: object
    PreferencetypesValue:
      type: object
    PromotetypesPromotePath:
      properties:
        indexes:
          items:
            $ref: '#/components/schemas/PromotetypesWrappedIndex'
          type: array
        path:
          type: string
        promote:
          type: boolean
      type: object
    PromotetypesWrappedIndex:
      properties:
        column_type:
          type: string
        granularity:
          type: integer
        type:
          type: string
      type: object
    Querybuildertypesv5AggregationBucket:
      properties:
        alias:
          type: string
        anomalyScores:
          items:
            $ref: '#/components/schemas/Querybuildertypesv5TimeSeries'
          type: array
        index:
          type: integer
        lowerBoundSeries:
          items:
            $ref: '#/components/schemas/Querybuildertypesv5TimeSeries'
          type: array
        meta:
          properties:
            unit:
              type: string
          type: object
        predictedSeries:
          items:
            $ref: '#/components/schemas/Querybuildertypesv5TimeSeries'
          type: array
        series:
          items:
            $ref: '#/components/schemas/Querybuildertypesv5TimeSeries'
          nullable: true
          type: array
        upperBoundSeries:
          items:
            $ref: '#/components/schemas/Querybuildertypesv5TimeSeries'
          type: array
      type: object
    Querybuildertypesv5Bucket:
      properties:
        step:
          format: double
          type: number
      type: object
    Querybuildertypesv5ClickHouseQuery:
      properties:
        disabled:
          type: boolean
        legend:
          type: string
        name:
          type: string
        query:
          type: string
      type: object
    Querybuildertypesv5ColumnDescriptor:
      properties:
        aggregationIndex:
          format: int64
          type: integer
        columnType:
          $ref: '#/components/schemas/Querybuildertypesv5ColumnType'
        description:
          type: string
        fieldContext:
          $ref: '#/components/schemas/TelemetrytypesFieldContext'
        fieldDataType:
          $ref: '#/components/schemas/TelemetrytypesFieldDataType'
        meta:
          properties:
            unit:
              type: string
          type: object
        name:
          type: string
        queryName:
          type: string
        signal:
          $ref: '#/components/schemas/TelemetrytypesSignal'
        unit:
          type: string
      required:
      - name
      type: object
    Querybuildertypesv5ColumnType:
      enum:
      - group
      - aggregation
      type: string
    Querybuildertypesv5CompositeQuery:
      description: Composite query containing one or more query envelopes. Each query
        envelope specifies its type and corresponding spec.
      properties:
        queries:
          items:
            $ref: '#/components/schemas/Querybuildertypesv5QueryEnvelope'
          nullable: true
          type: array
      type: object
    Querybuildertypesv5ExecStats:
      description: Execution statistics for the query, including rows scanned, bytes
        scanned, and duration.
      properties:
        bytesScanned:
          minimum: 0
          type: integer
        durationMs:
          minimum: 0
          type: integer
        rowsScanned:
          minimum: 0
          type: integer
        stepIntervals:
          additionalProperties:
            minimum: 0
            type: integer
          type: object
      type: object
    Querybuildertypesv5Filter:
      properties:
        expression:
          type: string
      type: object
    Querybuildertypesv5FormatOptions:
      properties:
        fillGaps:
          type: boolean
        formatTableResultForUI:
          type: boolean
      type: object
    Querybuildertypesv5Function:
      properties:
        args:
          items:
            $ref: '#/components/schemas/Querybuildertypesv5FunctionArg'
          type: array
        name:
          $ref: '#/components/schemas/Querybuildertypesv5FunctionName'
      type: object
    Querybuildertypesv5FunctionArg:
      properties:
        name:
          type: string
        value: {}
      type: object
    Querybuildertypesv5FunctionName:
      enum:
      - cutoffmin
      - cutoffmax
      - clampmin
      - clampmax
      - absolute
      - runningdiff
      - log2
      - log10
      - cumulativesum
      - ewma3
      - ewma5
      - ewma7
      - median3
      - median5
      - median7
      - timeshift
      - anomaly
      - fillzero
      type: string
    Querybuildertypesv5GroupByKey:
      properties:
        description:
          type: string
        fieldContext:
          $ref: '#/components/schemas/TelemetrytypesFieldContext'
        fieldDataType:
          $ref: '#/components/schemas/TelemetrytypesFieldDataType'
        name:
          type: string
        signal:
          $ref: '#/components/schemas/TelemetrytypesSignal'
        unit:
          type: string
      required:
      - name
      type: object
    Querybuildertypesv5Having:
      properties:
        expression:
          type: string
      type: object
    Querybuildertypesv5Label:
      properties:
        key:
          $ref: '#/components/schemas/TelemetrytypesTelemetryFieldKey'
        value: {}
      type: object
    Querybuildertypesv5LimitBy:
      properties:
        keys:
          items:
            type: string
          nullable: true
          type: array
        value:
          type: string
      type: object
    Querybuildertypesv5LogAggregation:
      properties:
        alias:
          type: string
        expression:
          type: string
      type: object
    Querybuildertypesv5MetricAggregation:
      properties:
        comparisonSpaceAggregationParam:
          $ref: '#/components/schemas/MetrictypesComparisonSpaceAggregationParam'
        metricName:
          type: string
        reduceTo:
          $ref: '#/components/schemas/Querybuildertypesv5ReduceTo'
        spaceAggregation:
          $ref: '#/components/schemas/MetrictypesSpaceAggregation'
        temporality:
          $ref: '#/components/schemas/MetrictypesTemporality'
        timeAggregation:
          $ref: '#/components/schemas/MetrictypesTimeAggregation'
      type: object
    Querybuildertypesv5OrderBy:
      properties:
        direction:
          $ref: '#/components/schemas/Querybuildertypesv5OrderDirection'
        key:
          $ref: '#/components/schemas/Querybuildertypesv5OrderByKey'
      type: object
    Querybuildertypesv5OrderByKey:
      properties:
        description:
          type: string
        fieldContext:
          $ref: '#/components/schemas/TelemetrytypesFieldContext'
        fieldDataType:
          $ref: '#/components/schemas/TelemetrytypesFieldDataType'
        name:
          type: string
        signal:
          $ref: '#/components/schemas/TelemetrytypesSignal'
        unit:
          type: string
      required:
      - name
      type: object
    Querybuildertypesv5OrderDirection:
      enum:
      - asc
      - desc
      type: string
    Querybuildertypesv5PromQuery:
      properties:
        disabled:
          type: boolean
        legend:
          type: string
        name:
          type: string
        query:
          type: string
        stats:
          type: boolean
        step:
          $ref: '#/components/schemas/Querybuildertypesv5Step'
      type: object
    Querybuildertypesv5QueryBuilderFormula:
      properties:
        disabled:
          type: boolean
        expression:
          type: string
        functions:
          items:
            $ref: '#/components/schemas/Querybuildertypesv5Function'
          type: array
        having:
          $ref: '#/components/schemas/Querybuildertypesv5Having'
        legend:
          type: string
        limit:
          type: integer
        name:
          type: string
        order:
          items:
            $ref: '#/components/schemas/Querybuildertypesv5OrderBy'
          type: array
      type: object
    Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5LogAggregation:
      properties:
        aggregations:
          items:
            $ref: '#/components/schemas/Querybuildertypesv5LogAggregation'
          type: array
        cursor:
          type: string
        disabled:
          type: boolean
        filter:
          $ref: '#/components/schemas/Querybuildertypesv5Filter'
        functions:
          items:
            $ref: '#/components/schemas/Querybuildertypesv5Function'
          type: array
        groupBy:
          items:
            $ref: '#/components/schemas/Querybuildertypesv5GroupByKey'
          type: array
        having:
          $ref: '#/components/schemas/Querybuildertypesv5Having'
        legend:
          type: string
        limit:
          type: integer
        limitBy:
          $ref: '#/components/schemas/Querybuildertypesv5LimitBy'
        name:
          type: string
        offset:
          type: integer
        order:
          items:
            $ref: '#/components/schemas/Querybuildertypesv5OrderBy'
          type: array
        secondaryAggregations:
          items:
            $ref: '#/components/schemas/Querybuildertypesv5SecondaryAggregation'
          type: array
        selectFields:
          items:
            $ref: '#/components/schemas/TelemetrytypesTelemetryFieldKey'
          type: array
        signal:
          $ref: '#/components/schemas/TelemetrytypesSignal'
        source:
          $ref: '#/components/schemas/TelemetrytypesSource'
        stepInterval:
          $ref: '#/components/schemas/Querybuildertypesv5Step'
      type: object
    Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5MetricAggregation:
      properties:
        aggregations:
          items:
            $ref: '#/components/schemas/Querybuildertypesv5MetricAggregation'
          type: array
        cursor:
          type: string
        disabled:
          type: boolean
        filter:
          $ref: '#/components/schemas/Querybuildertypesv5Filter'
        functions:
          items:
            $ref: '#/components/schemas/Querybuildertypesv5Function'
          type: array
        groupBy:
          items:
            $ref: '#/components/schemas/Querybuildertypesv5GroupByKey'
          type: array
        having:
          $ref: '#/components/schemas/Querybuildertypesv5Having'
        legend:
          type: string
        limit:
          type: integer
        limitBy:
          $ref: '#/components/schemas/Querybuildertypesv5LimitBy'
        name:
          type: string
        offset:
          type: integer
        order:
          items:
            $ref: '#/components/schemas/Querybuildertypesv5OrderBy'
          type: array
        secondaryAggregations:
          items:
            $ref: '#/components/schemas/Querybuildertypesv5SecondaryAggregation'
          type: array
        selectFields:
          items:
            $ref: '#/components/schemas/TelemetrytypesTelemetryFieldKey'
          type: array
        signal:
          $ref: '#/components/schemas/TelemetrytypesSignal'
        source:
          $ref: '#/components/schemas/TelemetrytypesSource'
        stepInterval:
          $ref: '#/components/schemas/Querybuildertypesv5Step'
      type: object
    Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5TraceAggregation:
      properties:
        aggregations:
          items:
            $ref: '#/components/schemas/Querybuildertypesv5TraceAggregation'
          type: array
        cursor:
          type: string
        disabled:
          type: boolean
        filter:
          $ref: '#/components/schemas/Querybuildertypesv5Filter'
        functions:
          items:
            $ref: '#/components/schemas/Querybuildertypesv5Function'
          type: array
        groupBy:
          items:
            $ref: '#/components/schemas/Querybuildertypesv5GroupByKey'
          type: array
        having:
          $ref: '#/components/schemas/Querybuildertypesv5Having'
        legend:
          type: string
        limit:
          type: integer
        limitBy:
          $ref: '#/components/schemas/Querybuildertypesv5LimitBy'
        name:
          type: string
        offset:
          type: integer
        order:
          items:
            $ref: '#/components/schemas/Querybuildertypesv5OrderBy'
          type: array
        secondaryAggregations:
          items:
            $ref: '#/components/schemas/Querybuildertypesv5SecondaryAggregation'
          type: array
        selectFields:
          items:
            $ref: '#/components/schemas/TelemetrytypesTelemetryFieldKey'
          type: array
        signal:
          $ref: '#/components/schemas/TelemetrytypesSignal'
        source:
          $ref: '#/components/schemas/TelemetrytypesSource'
        stepInterval:
          $ref: '#/components/schemas/Querybuildertypesv5Step'
      type: object
    Querybuildertypesv5QueryBuilderTraceOperator:
      properties:
        aggregations:
          items:
            $ref: '#/components/schemas/Querybuildertypesv5TraceAggregation'
          type: array
        cursor:
          type: string
        disabled:
          type: boolean
        expression:
          type: string
        filter:
          $ref: '#/components/schemas/Querybuildertypesv5Filter'
        functions:
          items:
            $ref: '#/components/schemas/Querybuildertypesv5Function'
          type: array
        groupBy:
          items:
            $ref: '#/components/schemas/Querybuildertypesv5GroupByKey'
          type: array
        having:
          $ref: '#/components/schemas/Querybuildertypesv5Having'
        legend:
          type: string
        limit:
          type: integer
        name:
          type: string
        offset:
          type: integer
        order:
          items:
            $ref: '#/components/schemas/Querybuildertypesv5OrderBy'
          type: array
        returnSpansFrom:
          type: string
        selectFields:
          items:
            $ref: '#/components/schemas/TelemetrytypesTelemetryFieldKey'
          type: array
        stepInterval:
          $ref: '#/components/schemas/Querybuildertypesv5Step'
      type: object
    Querybuildertypesv5QueryData:
      oneOf:
      - $ref: '#/components/schemas/Querybuildertypesv5TimeSeriesData'
      - $ref: '#/components/schemas/Querybuildertypesv5ScalarData'
      - $ref: '#/components/schemas/Querybuildertypesv5RawData'
      properties:
        results:
          items: {}
          nullable: true
          type: array
      type: object
    Querybuildertypesv5QueryEnvelope:
      oneOf:
      - $ref: '#/components/schemas/Querybuildertypesv5QueryEnvelopeBuilderTrace'
      - $ref: '#/components/schemas/Querybuildertypesv5QueryEnvelopeBuilderLog'
      - $ref: '#/components/schemas/Querybuildertypesv5QueryEnvelopeBuilderMetric'
      - $ref: '#/components/schemas/Querybuildertypesv5QueryEnvelopeFormula'
      - $ref: '#/components/schemas/Querybuildertypesv5QueryEnvelopeTraceOperator'
      - $ref: '#/components/schemas/Querybuildertypesv5QueryEnvelopePromQL'
      - $ref: '#/components/schemas/Querybuildertypesv5QueryEnvelopeClickHouseSQL'
      properties:
        spec: {}
        type:
          $ref: '#/components/schemas/Querybuildertypesv5QueryType'
      type: object
    Querybuildertypesv5QueryEnvelopeBuilderLog:
      properties:
        spec:
          $ref: '#/components/schemas/Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5LogAggregation'
        type:
          $ref: '#/components/schemas/Querybuildertypesv5QueryType'
      type: object
    Querybuildertypesv5QueryEnvelopeBuilderMetric:
      properties:
        spec:
          $ref: '#/components/schemas/Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5MetricAggregation'
        type:
          $ref: '#/components/schemas/Querybuildertypesv5QueryType'
      type: object
    Querybuildertypesv5QueryEnvelopeBuilderTrace:
      properties:
        spec:
          $ref: '#/components/schemas/Querybuildertypesv5QueryBuilderQueryGithubComSigNozSignozPkgTypesQuerybuildertypesQuerybuildertypesv5TraceAggregation'
        type:
          $ref: '#/components/schemas/Querybuildertypesv5QueryType'
      type: object
    Querybuildertypesv5QueryEnvelopeClickHouseSQL:
      properties:
        spec:
          $ref: '#/components/schemas/Querybuildertypesv5ClickHouseQuery'
        type:
          $ref: '#/components/schemas/Querybuildertypesv5QueryType'
      type: object
    Querybuildertypesv5QueryEnvelopeFormula:
      properties:
        spec:
          $ref: '#/components/schemas/Querybuildertypesv5QueryBuilderFormula'
        type:
          $ref: '#/components/schemas/Querybuildertypesv5QueryType'
      type: object
    Querybuildertypesv5QueryEnvelopePromQL:
      properties:
        spec:
          $ref: '#/components/schemas/Querybuildertypesv5PromQuery'
        type:
          $ref: '#/components/schemas/Querybuildertypesv5QueryType'
      type: object
    Querybuildertypesv5QueryEnvelopeTraceOperator:
      properties:
        spec:
          $ref: '#/components/schemas/Querybuildertypesv5QueryBuilderTraceOperator'
        type:
          $ref: '#/components/schemas/Querybuildertypesv5QueryType'
      type: object
    Querybuildertypesv5QueryRangeRequest:
      description: Request body for the v5 query range endpoint. Supports builder
        queries (traces, logs, metrics), formulas, joins, trace operators, PromQL,
        and ClickHouse SQL queries.
      properties:
        compositeQuery:
          $ref: '#/components/schemas/Querybuildertypesv5CompositeQuery'
        end:
          minimum: 0
          type: integer
        formatOptions:
          $ref: '#/components/schemas/Querybuildertypesv5FormatOptions'
        noCache:
          type: boolean
        requestType:
          $ref: '#/components/schemas/Querybuildertypesv5RequestType'
        schemaVersion:
          type: string
        start:
          minimum: 0
          type: integer
        variables:
          additionalProperties:
            $ref: '#/components/schemas/Querybuildertypesv5VariableItem'
          type: object
      type: object
    Querybuildertypesv5QueryRangeResponse:
      description: 'Response from the v5 query range endpoint. The data.results array
        contains typed results depending on the requestType: TimeSeriesData for time_series,
        ScalarData for scalar, or RawData for raw requests.'
      properties:
        data:
          $ref: '#/components/schemas/Querybuildertypesv5QueryData'
        meta:
          $ref: '#/components/schemas/Querybuildertypesv5ExecStats'
        type:
          $ref: '#/components/schemas/Querybuildertypesv5RequestType'
        warning:
          $ref: '#/components/schemas/Querybuildertypesv5QueryWarnData'
      type: object
    Querybuildertypesv5QueryType:
      enum:
      - builder_query
      - builder_formula
      - builder_trace_operator
      - clickhouse_sql
      - promql
      type: string
    Querybuildertypesv5QueryWarnData:
      properties:
        message:
          type: string
        url:
          type: string
        warnings:
          items:
            $ref: '#/components/schemas/Querybuildertypesv5QueryWarnDataAdditional'
          type: array
      type: object
    Querybuildertypesv5QueryWarnDataAdditional:
      properties:
        message:
          type: string
      type: object
    Querybuildertypesv5RawData:
      properties:
        nextCursor:
          type: string
        queryName:
          type: string
        rows:
          items:
            $ref: '#/components/schemas/Querybuildertypesv5RawRow'
          nullable: true
          type: array
      type: object
    Querybuildertypesv5RawRow:
      properties:
        data:
          additionalProperties: {}
          nullable: true
          type: object
        timestamp:
          format: date-time
          type: string
      type: object
    Querybuildertypesv5ReduceTo:
      enum:
      - sum
      - count
      - avg
      - min
      - max
      - last
      - median
      type: string
    Querybuildertypesv5RequestType:
      enum:
      - scalar
      - time_series
      - raw
      - raw_stream
      - trace
      type: string
    Querybuildertypesv5ScalarData:
      properties:
        columns:
          items:
            $ref: '#/components/schemas/Querybuildertypesv5ColumnDescriptor'
          nullable: true
          type: array
        data:
          items:
            items: {}
            type: array
          nullable: true
          type: array
        queryName:
          type: string
      type: object
    Querybuildertypesv5SecondaryAggregation:
      properties:
        alias:
          type: string
        expression:
          type: string
        groupBy:
          items:
            $ref: '#/components/schemas/Querybuildertypesv5GroupByKey'
          type: array
        limit:
          type: integer
        limitBy:
          $ref: '#/components/schemas/Querybuildertypesv5LimitBy'
        order:
          items:
            $ref: '#/components/schemas/Querybuildertypesv5OrderBy'
          type: array
        stepInterval:
          $ref: '#/components/schemas/Querybuildertypesv5Step'
      type: object
    Querybuildertypesv5Step:
      description: Step interval. Accepts a Go duration string (e.g., "60s", "1m",
        "1h") or a number representing seconds (e.g., 60).
      oneOf:
      - description: Duration string (e.g., "60s", "5m", "1h").
        example: 60s
        type: string
      - description: Duration in seconds.
        example: 60
        type: number
    Querybuildertypesv5TimeSeries:
      properties:
        labels:
          items:
            $ref: '#/components/schemas/Querybuildertypesv5Label'
          type: array
        values:
          items:
            $ref: '#/components/schemas/Querybuildertypesv5TimeSeriesValue'
          nullable: true
          type: array
      type: object
    Querybuildertypesv5TimeSeriesData:
      properties:
        aggregations:
          items:
            $ref: '#/components/schemas/Querybuildertypesv5AggregationBucket'
          nullable: true
          type: array
        queryName:
          type: string
      type: object
    Querybuildertypesv5TimeSeriesValue:
      properties:
        bucket:
          $ref: '#/components/schemas/Querybuildertypesv5Bucket'
        partial:
          type: boolean
        timestamp:
          format: int64
          type: integer
        value:
          format: double
          type: number
        values:
          items:
            format: double
            type: number
          type: array
      type: object
    Querybuildertypesv5TraceAggregation:
      properties:
        alias:
          type: string
        expression:
          type: string
      type: object
    Querybuildertypesv5VariableItem:
      properties:
        type:
          $ref: '#/components/schemas/Querybuildertypesv5VariableType'
        value: {}
      type: object
    Querybuildertypesv5VariableType:
      enum:
      - query
      - dynamic
      - custom
      - text
      type: string
    RenderErrorResponse:
      properties:
        error:
          $ref: '#/components/schemas/ErrorsJSON'
        status:
          type: string
      required:
      - status
      - error
      type: object
    RulestatehistorytypesGettableRuleStateHistory:
      properties:
        fingerprint:
          minimum: 0
          type: integer
        labels:
          items:
            $ref: '#/components/schemas/Querybuildertypesv5Label'
          nullable: true
          type: array
        overallState:
          $ref: '#/components/schemas/RuletypesAlertState'
        overallStateChanged:
          type: boolean
        ruleId:
          type: string
        ruleName:
          type: string
        state:
          $ref: '#/components/schemas/RuletypesAlertState'
        stateChanged:
          type: boolean
        unixMilli:
          format: int64
          type: integer
        value:
          format: double
          type: number
      required:
      - ruleId
      - ruleName
      - overallState
      - overallStateChanged
      - state
      - stateChanged
      - unixMilli
      - labels
      - fingerprint
      - value
      type: object
    RulestatehistorytypesGettableRuleStateHistoryContributor:
      properties:
        count:
          minimum: 0
          type: integer
        fingerprint:
          minimum: 0
          type: integer
        labels:
          items:
            $ref: '#/components/schemas/Querybuildertypesv5Label'
          nullable: true
          type: array
        relatedLogsLink:
          type: string
        relatedTracesLink:
          type: string
      required:
      - fingerprint
      - labels
      - count
      type: object
    RulestatehistorytypesGettableRuleStateHistoryStats:
      properties:
        currentAvgResolutionTime:
          format: double
          type: number
        currentAvgResolutionTimeSeries:
          $ref: '#/components/schemas/Querybuildertypesv5TimeSeries'
        currentTriggersSeries:
          $ref: '#/components/schemas/Querybuildertypesv5TimeSeries'
        pastAvgResolutionTime:
          format: double
          type: number
        pastAvgResolutionTimeSeries:
          $ref: '#/components/schemas/Querybuildertypesv5TimeSeries'
        pastTriggersSeries:
          $ref: '#/components/schemas/Querybuildertypesv5TimeSeries'
        totalCurrentTriggers:
          minimum: 0
          type: integer
        totalPastTriggers:
          minimum: 0
          type: integer
      required:
      - totalCurrentTriggers
      - totalPastTriggers
      - currentTriggersSeries
      - pastTriggersSeries
      - currentAvgResolutionTime
      - pastAvgResolutionTime
      - currentAvgResolutionTimeSeries
      - pastAvgResolutionTimeSeries
      type: object
    RulestatehistorytypesGettableRuleStateTimeline:
      properties:
        items:
          items:
            $ref: '#/components/schemas/RulestatehistorytypesGettableRuleStateHistory'
          nullable: true
          type: array
        nextCursor:
          type: string
        total:
          minimum: 0
          type: integer
      required:
      - items
      - total
      type: object
    RulestatehistorytypesGettableRuleStateWindow:
      properties:
        end:
          format: int64
          type: integer
        start:
          format: int64
          type: integer
        state:
          $ref: '#/components/schemas/RuletypesAlertState'
      required:
      - state
      - start
      - end
      type: object
    RuletypesAlertCompositeQuery:
      properties:
        panelType:
          $ref: '#/components/schemas/RuletypesPanelType'
        queries:
          items:
            $ref: '#/components/schemas/Querybuildertypesv5QueryEnvelope'
          nullable: true
          type: array
        queryType:
          $ref: '#/components/schemas/RuletypesQueryType'
        unit:
          type: string
      required:
      - queries
      - panelType
      - queryType
      type: object
    RuletypesAlertState:
      enum:
      - inactive
      - pending
      - recovering
      - firing
      - nodata
      - disabled
      type: string
    RuletypesAlertType:
      enum:
      - METRIC_BASED_ALERT
      - TRACES_BASED_ALERT
      - LOGS_BASED_ALERT
      - EXCEPTIONS_BASED_ALERT
      type: string
    RuletypesBasicRuleThreshold:
      properties:
        channels:
          items:
            type: string
          nullable: true
          type: array
        matchType:
          $ref: '#/components/schemas/RuletypesMatchType'
        name:
          type: string
        op:
          $ref: '#/components/schemas/RuletypesCompareOperator'
        recoveryTarget:
          nullable: true
          type: number
        target:
          nullable: true
          type: number
        targetUnit:
          type: string
      required:
      - name
      - target
      - matchType
      - op
      type: object
    RuletypesBasicRuleThresholds:
      items:
        $ref: '#/components/schemas/RuletypesBasicRuleThreshold'
      nullable: true
      type: array
    RuletypesCompareOperator:
      enum:
      - above
      - below
      - equal
      - not_equal
      - outside_bounds
      type: string
    RuletypesCumulativeSchedule:
      properties:
        day:
          nullable: true
          type: integer
        hour:
          nullable: true
          type: integer
        minute:
          nullable: true
          type: integer
        type:
          $ref: '#/components/schemas/RuletypesScheduleType'
        weekday:
          nullable: true
          type: integer
      required:
      - type
      type: object
    RuletypesCumulativeWindow:
      properties:
        frequency:
          type: string
        schedule:
          $ref: '#/components/schemas/RuletypesCumulativeSchedule'
        timezone:
          type: string
      required:
      - schedule
      - frequency
      - timezone
      type: object
    RuletypesEvaluationCumulative:
      properties:
        kind:
          $ref: '#/components/schemas/RuletypesEvaluationKind'
        spec:
          $ref: '#/components/schemas/RuletypesCumulativeWindow'
      type: object
    RuletypesEvaluationEnvelope:
      oneOf:
      - $ref: '#/components/schemas/RuletypesEvaluationRolling'
      - $ref: '#/components/schemas/RuletypesEvaluationCumulative'
      properties:
        kind:
          $ref: '#/components/schemas/RuletypesEvaluationKind'
        spec: {}
      required:
      - kind
      - spec
      type: object
    RuletypesEvaluationKind:
      enum:
      - rolling
      - cumulative
      type: string
    RuletypesEvaluationRolling:
      properties:
        kind:
          $ref: '#/components/schemas/RuletypesEvaluationKind'
        spec:
          $ref: '#/components/schemas/RuletypesRollingWindow'
      type: object
    RuletypesGettableTestRule:
      properties:
        alertCount:
          type: integer
        message:
          type: string
      type: object
    RuletypesMaintenanceKind:
      enum:
      - fixed
      - recurring
      type: string
    RuletypesMaintenanceStatus:
      enum:
      - active
      - upcoming
      - expired
      type: string
    RuletypesMatchType:
      enum:
      - at_least_once
      - all_the_times
      - on_average
      - in_total
      - last
      type: string
    RuletypesNotificationSettings:
      properties:
        groupBy:
          items:
            type: string
          type: array
        newGroupEvalDelay:
          type: string
        renotify:
          $ref: '#/components/schemas/RuletypesRenotify'
        usePolicy:
          type: boolean
      type: object
    RuletypesPanelType:
      enum:
      - value
      - table
      - graph
      type: string
    RuletypesPlannedMaintenance:
      properties:
        alertIds:
          items:
            type: string
          nullable: true
          type: array
        createdAt:
          format: date-time
          type: string
        createdBy:
          type: string
        description:
          type: string
        id:
          type: string
        kind:
          $ref: '#/components/schemas/RuletypesMaintenanceKind'
        name:
          type: string
        schedule:
          $ref: '#/components/schemas/RuletypesSchedule'
        status:
          $ref: '#/components/schemas/RuletypesMaintenanceStatus'
        updatedAt:
          format: date-time
          type: string
        updatedBy:
          type: string
      required:
      - id
      - name
      - schedule
      - status
      - kind
      type: object
    RuletypesPostablePlannedMaintenance:
      properties:
        alertIds:
          items:
            type: string
          nullable: true
          type: array
        description:
          type: string
        name:
          type: string
        schedule:
          $ref: '#/components/schemas/RuletypesSchedule'
      required:
      - name
      - schedule
      type: object
    RuletypesPostableRule:
      properties:
        alert:
          type: string
        alertType:
          $ref: '#/components/schemas/RuletypesAlertType'
        annotations:
          additionalProperties:
            type: string
          type: object
        condition:
          $ref: '#/components/schemas/RuletypesRuleCondition'
        description:
          type: string
        disabled:
          type: boolean
        evalWindow:
          type: string
        evaluation:
          $ref: '#/components/schemas/RuletypesEvaluationEnvelope'
        frequency:
          type: string
        labels:
          additionalProperties:
            type: string
          type: object
        notificationSettings:
          $ref: '#/components/schemas/RuletypesNotificationSettings'
        preferredChannels:
          items:
            type: string
          type: array
        ruleType:
          $ref: '#/components/schemas/RuletypesRuleType'
        schemaVersion:
          type: string
        source:
          type: string
        version:
          type: string
      required:
      - alert
      - alertType
      - ruleType
      - condition
      type: object
    RuletypesQueryType:
      enum:
      - builder
      - clickhouse_sql
      - promql
      type: string
    RuletypesRecurrence:
      properties:
        duration:
          type: string
        endTime:
          format: date-time
          nullable: true
          type: string
        repeatOn:
          items:
            $ref: '#/components/schemas/RuletypesRepeatOn'
          nullable: true
          type: array
        repeatType:
          $ref: '#/components/schemas/RuletypesRepeatType'
        startTime:
          format: date-time
          type: string
      required:
      - startTime
      - duration
      - repeatType
      type: object
    RuletypesRenotify:
      properties:
        alertStates:
          items:
            $ref: '#/components/schemas/RuletypesAlertState'
          type: array
        enabled:
          type: boolean
        interval:
          type: string
      type: object
    RuletypesRepeatOn:
      enum:
      - sunday
      - monday
      - tuesday
      - wednesday
      - thursday
      - friday
      - saturday
      type: string
    RuletypesRepeatType:
      enum:
      - daily
      - weekly
      - monthly
      type: string
    RuletypesRollingWindow:
      properties:
        evalWindow:
          type: string
        frequency:
          type: string
      required:
      - evalWindow
      - frequency
      type: object
    RuletypesRule:
      properties:
        alert:
          type: string
        alertType:
          $ref: '#/components/schemas/RuletypesAlertType'
        annotations:
          additionalProperties:
            type: string
          type: object
        condition:
          $ref: '#/components/schemas/RuletypesRuleCondition'
        createdAt:
          format: date-time
          type: string
        createdBy:
          type: string
        description:
          type: string
        disabled:
          type: boolean
        evalWindow:
          type: string
        evaluation:
          $ref: '#/components/schemas/RuletypesEvaluationEnvelope'
        frequency:
          type: string
        id:
          type: string
        labels:
          additionalProperties:
            type: string
          type: object
        notificationSettings:
          $ref: '#/components/schemas/RuletypesNotificationSettings'
        preferredChannels:
          items:
            type: string
          type: array
        ruleType:
          $ref: '#/components/schemas/RuletypesRuleType'
        schemaVersion:
          type: string
        source:
          type: string
        state:
          $ref: '#/components/schemas/RuletypesAlertState'
        updatedAt:
          format: date-time
          type: string
        updatedBy:
          type: string
        version:
          type: string
      required:
      - id
      - state
      - alert
      - alertType
      - ruleType
      - condition
      type: object
    RuletypesRuleCondition:
      properties:
        absentFor:
          minimum: 0
          type: integer
        alertOnAbsent:
          type: boolean
        algorithm:
          type: string
        compositeQuery:
          $ref: '#/components/schemas/RuletypesAlertCompositeQuery'
        matchType:
          $ref: '#/components/schemas/RuletypesMatchType'
        op:
          $ref: '#/components/schemas/RuletypesCompareOperator'
        requireMinPoints:
          type: boolean
        requiredNumPoints:
          type: integer
        seasonality:
          $ref: '#/components/schemas/RuletypesSeasonality'
        selectedQueryName:
          type: string
        target:
          nullable: true
          type: number
        targetUnit:
          type: string
        thresholds:
          $ref: '#/components/schemas/RuletypesRuleThresholdData'
      required:
      - compositeQuery
      type: object
    RuletypesRuleThresholdData:
      oneOf:
      - $ref: '#/components/schemas/RuletypesThresholdBasic'
      properties:
        kind:
          $ref: '#/components/schemas/RuletypesThresholdKind'
        spec: {}
      required:
      - kind
      - spec
      type: object
    RuletypesRuleType:
      enum:
      - threshold_rule
      - promql_rule
      - anomaly_rule
      type: string
    RuletypesSchedule:
      properties:
        endTime:
          format: date-time
          type: string
        recurrence:
          $ref: '#/components/schemas/RuletypesRecurrence'
        startTime:
          format: date-time
          type: string
        timezone:
          type: string
      required:
      - timezone
      type: object
    RuletypesScheduleType:
      enum:
      - hourly
      - daily
      - weekly
      - monthly
      type: string
    RuletypesSeasonality:
      enum:
      - hourly
      - daily
      - weekly
      type: string
    RuletypesThresholdBasic:
      properties:
        kind:
          $ref: '#/components/schemas/RuletypesThresholdKind'
        spec:
          $ref: '#/components/schemas/RuletypesBasicRuleThresholds'
      type: object
    RuletypesThresholdKind:
      enum:
      - basic
      type: string
    ServiceaccounttypesGettableFactorAPIKey:
      properties:
        createdAt:
          format: date-time
          type: string
        expiresAt:
          minimum: 0
          type: integer
        id:
          type: string
        lastObservedAt:
          format: date-time
          type: string
        name:
          type: string
        serviceAccountId:
          type: string
        updatedAt:
          format: date-time
          type: string
      required:
      - id
      - expiresAt
      - lastObservedAt
      - serviceAccountId
      type: object
    ServiceaccounttypesGettableFactorAPIKeyWithKey:
      properties:
        id:
          type: string
        key:
          type: string
      required:
      - id
      - key
      type: object
    ServiceaccounttypesPostableFactorAPIKey:
      properties:
        expiresAt:
          minimum: 0
          type: integer
        name:
          type: string
      required:
      - name
      - expiresAt
      type: object
    ServiceaccounttypesPostableServiceAccount:
      properties:
        name:
          type: string
      required:
      - name
      type: object
    ServiceaccounttypesPostableServiceAccountRole:
      properties:
        id:
          type: string
      required:
      - id
      type: object
    ServiceaccounttypesServiceAccount:
      properties:
        createdAt:
          format: date-time
          type: string
        email:
          type: string
        id:
          type: string
        name:
          type: string
        orgId:
          type: string
        status:
          type: string
        updatedAt:
          format: date-time
          type: string
      required:
      - id
      - name
      - email
      - status
      - orgId
      type: object
    ServiceaccounttypesServiceAccountRole:
      properties:
        createdAt:
          format: date-time
          type: string
        id:
          type: string
        role:
          $ref: '#/components/schemas/AuthtypesRole'
        roleId:
          type: string
        serviceAccountId:
          type: string
        updatedAt:
          format: date-time
          type: string
      required:
      - id
      - serviceAccountId
      - roleId
      - role
      type: object
    ServiceaccounttypesServiceAccountWithRoles:
      properties:
        createdAt:
          format: date-time
          type: string
        email:
          type: string
        id:
          type: string
        name:
          type: string
        orgId:
          type: string
        serviceAccountRoles:
          items:
            $ref: '#/components/schemas/ServiceaccounttypesServiceAccountRole'
          nullable: true
          type: array
        status:
          type: string
        updatedAt:
          format: date-time
          type: string
      required:
      - id
      - name
      - email
      - status
      - orgId
      - serviceAccountRoles
      type: object
    ServiceaccounttypesUpdatableFactorAPIKey:
      properties:
        expiresAt:
          minimum: 0
          type: integer
        name:
          type: string
      required:
      - name
      - expiresAt
      type: object
    Sigv4SigV4Config:
      type: object
    TelemetrytypesFieldContext:
      enum:
      - metric
      - log
      - span
      - resource
      - attribute
      - body
      type: string
    TelemetrytypesFieldDataType:
      enum:
      - string
      - bool
      - float64
      - int64
      - number
      type: string
    TelemetrytypesGettableFieldKeys:
      properties:
        complete:
          type: boolean
        keys:
          additionalProperties:
            items:
              $ref: '#/components/schemas/TelemetrytypesTelemetryFieldKey'
            type: array
          nullable: true
          type: object
      required:
      - keys
      - complete
      type: object
    TelemetrytypesGettableFieldValues:
      properties:
        complete:
          type: boolean
        values:
          $ref: '#/components/schemas/TelemetrytypesTelemetryFieldValues'
      required:
      - values
      - complete
      type: object
    TelemetrytypesSignal:
      enum:
      - traces
      - logs
      - metrics
      type: string
    TelemetrytypesSource:
      enum:
      - meter
      type: string
    TelemetrytypesTelemetryFieldKey:
      properties:
        description:
          type: string
        fieldContext:
          $ref: '#/components/schemas/TelemetrytypesFieldContext'
        fieldDataType:
          $ref: '#/components/schemas/TelemetrytypesFieldDataType'
        name:
          type: string
        signal:
          $ref: '#/components/schemas/TelemetrytypesSignal'
        unit:
          type: string
      required:
      - name
      type: object
    TelemetrytypesTelemetryFieldValues:
      properties:
        boolValues:
          items:
            type: boolean
          type: array
        numberValues:
          items:
            format: double
            type: number
          type: array
        relatedValues:
          items:
            type: string
          type: array
        stringValues:
          items:
            type: string
          type: array
      type: object
    TimeDuration:
      format: int64
      type: integer
    TracedetailtypesEvent:
      properties:
        attributeMap:
          additionalProperties: {}
          type: object
        isError:
          type: boolean
        name:
          type: string
        timeUnixNano:
          minimum: 0
          type: integer
      type: object
    TracedetailtypesGettableWaterfallTrace:
      properties:
        endTimestampMillis:
          minimum: 0
          type: integer
        hasMissingSpans:
          type: boolean
        hasMore:
          type: boolean
        rootServiceEntryPoint:
          type: string
        rootServiceName:
          type: string
        serviceNameToTotalDurationMap:
          additionalProperties:
            minimum: 0
            type: integer
          nullable: true
          type: object
        spans:
          items:
            $ref: '#/components/schemas/TracedetailtypesWaterfallSpan'
          nullable: true
          type: array
        startTimestampMillis:
          minimum: 0
          type: integer
        totalErrorSpansCount:
          minimum: 0
          type: integer
        totalSpansCount:
          minimum: 0
          type: integer
        uncollapsedSpans:
          items:
            type: string
          nullable: true
          type: array
      type: object
    TracedetailtypesPostableWaterfall:
      properties:
        limit:
          minimum: 0
          type: integer
        selectedSpanId:
          type: string
        uncollapsedSpans:
          items:
            type: string
          nullable: true
          type: array
      type: object
    TracedetailtypesWaterfallSpan:
      properties:
        attributes:
          additionalProperties: {}
          nullable: true
          type: object
        db_name:
          type: string
        db_operation:
          type: string
        duration_nano:
          minimum: 0
          type: integer
        events:
          items:
            $ref: '#/components/schemas/TracedetailtypesEvent'
          nullable: true
          type: array
        external_http_method:
          type: string
        external_http_url:
          type: string
        flags:
          minimum: 0
          type: integer
        has_children:
          type: boolean
        has_error:
          type: boolean
        http_host:
          type: string
        http_method:
          type: string
        http_url:
          type: string
        is_remote:
          type: string
        kind_string:
          type: string
        level:
          minimum: 0
          type: integer
        name:
          type: string
        parent_span_id:
          type: string
        resource:
          additionalProperties:
            type: string
          nullable: true
          type: object
        response_status_code:
          type: string
        span_id:
          type: string
        status_code:
          type: integer
        status_code_string:
          type: string
        status_message:
          type: string
        sub_tree_node_count:
          minimum: 0
          type: integer
        trace_id:
          type: string
        trace_state:
          type: string
      type: object
    TypesAlertStatus:
      properties:
        inhibitedBy:
          items:
            type: string
          nullable: true
          type: array
        silencedBy:
          items:
            type: string
          nullable: true
          type: array
        state:
          type: string
      type: object
    TypesChangePasswordRequest:
      properties:
        newPassword:
          type: string
        oldPassword:
          type: string
      type: object
    TypesDeprecatedUser:
      properties:
        createdAt:
          format: date-time
          type: string
        displayName:
          type: string
        email:
          type: string
        id:
          type: string
        isRoot:
          type: boolean
        orgId:
          type: string
        role:
          type: string
        status:
          type: string
        updatedAt:
          format: date-time
          type: string
      required:
      - id
      type: object
    TypesIdentifiable:
      properties:
        id:
          type: string
      required:
      - id
      type: object
    TypesInvite:
      properties:
        createdAt:
          format: date-time
          type: string
        email:
          type: string
        id:
          type: string
        inviteLink:
          type: string
        name:
          type: string
        orgId:
          type: string
        role:
          type: string
        token:
          type: string
        updatedAt:
          format: date-time
          type: string
      required:
      - id
      type: object
    TypesOrganization:
      properties:
        alias:
          type: string
        createdAt:
          format: date-time
          type: string
        displayName:
          type: string
        id:
          type: string
        key:
          minimum: 0
          type: integer
        name:
          type: string
        updatedAt:
          format: date-time
          type: string
      required:
      - id
      type: object
    TypesPostableBulkInviteRequest:
      properties:
        invites:
          items:
            $ref: '#/components/schemas/TypesPostableInvite'
          type: array
      required:
      - invites
      type: object
    TypesPostableForgotPassword:
      properties:
        email:
          type: string
        frontendBaseURL:
          type: string
        orgId:
          type: string
      required:
      - orgId
      - email
      type: object
    TypesPostableInvite:
      properties:
        email:
          type: string
        frontendBaseUrl:
          type: string
        name:
          type: string
        role:
          type: string
      type: object
    TypesPostableResetPassword:
      properties:
        password:
          type: string
        token:
          type: string
      type: object
    TypesPostableRole:
      properties:
        name:
          type: string
      required:
      - name
      type: object
    TypesResetPasswordToken:
      properties:
        expiresAt:
          format: date-time
          type: string
        id:
          type: string
        passwordId:
          type: string
        token:
          type: string
      required:
      - id
      type: object
    TypesUpdatableUser:
      properties:
        displayName:
          type: string
      required:
      - displayName
      type: object
    TypesUser:
      properties:
        createdAt:
          format: date-time
          type: string
        displayName:
          type: string
        email:
          type: string
        id:
          type: string
        isRoot:
          type: boolean
        orgId:
          type: string
        status:
          type: string
        updatedAt:
          format: date-time
          type: string
      required:
      - id
      type: object
    ZeustypesGettableHost:
      properties:
        hosts:
          items:
            $ref: '#/components/schemas/ZeustypesHost'
          nullable: true
          type: array
        name:
          type: string
        state:
          type: string
        tier:
          type: string
      required:
      - name
      - state
      - tier
      - hosts
      type: object
    ZeustypesHost:
      properties:
        is_default:
          type: boolean
        name:
          type: string
        url:
          type: string
      required:
      - name
      - is_default
      - url
      type: object
    ZeustypesPostableHost:
      properties:
        name:
          type: string
      required:
      - name
      type: object
    ZeustypesPostableProfile:
      properties:
        existing_observability_tool:
          type: string
        has_existing_observability_tool:
          type: boolean
        logs_scale_per_day_in_gb:
          format: int64
          type: integer
        number_of_hosts:
          format: int64
          type: integer
        number_of_services:
          format: int64
          type: integer
        reasons_for_interest_in_signoz:
          items:
            type: string
          nullable: true
          type: array
        timeline_for_migrating_to_signoz:
          type: string
        uses_otel:
          type: boolean
        where_did_you_discover_signoz:
          type: string
      required:
      - uses_otel
      - has_existing_observability_tool
      - existing_observability_tool
      - reasons_for_interest_in_signoz
      - logs_scale_per_day_in_gb
      - number_of_services
      - number_of_hosts
      - where_did_you_discover_signoz
      - timeline_for_migrating_to_signoz
      type: object
  securitySchemes:
    api_key:
      description: API Keys
      in: header
      name: SigNoz-Api-Key
      type: apiKey
    tokenizer:
      bearerFormat: Tokenizer
      description: Tokens generated by the tokenizer
      scheme: bearer
      type: http
info:
  description: OpenTelemetry-Native Logs, Metrics and Traces in a single pane
  title: SigNoz
  version: ""
openapi: 3.0.3
paths:
  /api/v1/alerts:
    get:
      deprecated: false
      description: This endpoint returns alerts for the organization
      operationId: GetAlerts
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/AlertmanagertypesDeprecatedGettableAlert'
                    type: array
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - VIEWER
      - tokenizer:
        - VIEWER
      summary: Get alerts
      tags:
      - alerts
  /api/v1/authz/check:
    post:
      deprecated: false
      description: Checks if the authenticated user has permissions for given transactions
      operationId: AuthzCheck
      requestBody:
        content:
          application/json:
            schema:
              items:
                $ref: '#/components/schemas/AuthtypesTransaction'
              type: array
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/AuthtypesGettableTransaction'
                    type: array
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      summary: Check permissions
      tags:
      - authz
  /api/v1/authz/resources:
    get:
      deprecated: false
      description: Gets all the available resources
      operationId: AuthzResources
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/AuthtypesGettableResources'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      summary: Get resources
      tags:
      - authz
  /api/v1/channels:
    get:
      deprecated: false
      description: This endpoint lists all notification channels for the organization
      operationId: ListChannels
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/AlertmanagertypesChannel'
                    type: array
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - VIEWER
      - tokenizer:
        - VIEWER
      summary: List notification channels
      tags:
      - channels
    post:
      deprecated: false
      description: This endpoint creates a notification channel
      operationId: CreateChannel
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigReceiver'
      responses:
        "201":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/AlertmanagertypesChannel'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: Created
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Create notification channel
      tags:
      - channels
  /api/v1/channels/{id}:
    delete:
      deprecated: false
      description: This endpoint deletes a notification channel by ID
      operationId: DeleteChannelByID
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        "204":
          description: No Content
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Delete notification channel
      tags:
      - channels
    get:
      deprecated: false
      description: This endpoint returns a notification channel by ID
      operationId: GetChannelByID
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/AlertmanagertypesChannel'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - VIEWER
      - tokenizer:
        - VIEWER
      summary: Get notification channel by ID
      tags:
      - channels
    put:
      deprecated: false
      description: This endpoint updates a notification channel by ID
      operationId: UpdateChannelByID
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigReceiver'
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Update notification channel
      tags:
      - channels
  /api/v1/channels/test:
    post:
      deprecated: false
      description: This endpoint tests a notification channel by sending a test notification
      operationId: TestChannel
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigReceiver'
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - EDITOR
      - tokenizer:
        - EDITOR
      summary: Test notification channel
      tags:
      - channels
  /api/v1/cloud-integrations/{cloud_provider}/agent-check-in:
    post:
      deprecated: true
      description: '[Deprecated] This endpoint is called by the deployed agent to
        check in'
      operationId: AgentCheckInDeprecated
      parameters:
      - in: path
        name: cloud_provider
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CloudintegrationtypesPostableAgentCheckIn'
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/CloudintegrationtypesGettableAgentCheckIn'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - VIEWER
      - tokenizer:
        - VIEWER
      summary: Agent check-in
      tags:
      - cloudintegration
  /api/v1/cloud_integrations/{cloud_provider}/accounts:
    get:
      deprecated: false
      description: This endpoint lists the accounts for the specified cloud provider
      operationId: ListAccounts
      parameters:
      - in: path
        name: cloud_provider
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/CloudintegrationtypesGettableAccounts'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: List accounts
      tags:
      - cloudintegration
    post:
      deprecated: false
      description: This endpoint creates a new cloud integration account for the specified
        cloud provider
      operationId: CreateAccount
      parameters:
      - in: path
        name: cloud_provider
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CloudintegrationtypesPostableAccount'
      responses:
        "201":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/CloudintegrationtypesGettableAccountWithConnectionArtifact'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: Created
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Create account
      tags:
      - cloudintegration
  /api/v1/cloud_integrations/{cloud_provider}/accounts/{id}:
    delete:
      deprecated: false
      description: This endpoint disconnects an account for the specified cloud provider
      operationId: DisconnectAccount
      parameters:
      - in: path
        name: cloud_provider
        required: true
        schema:
          type: string
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        "204":
          description: No Content
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Disconnect account
      tags:
      - cloudintegration
    get:
      deprecated: false
      description: This endpoint gets an account for the specified cloud provider
      operationId: GetAccount
      parameters:
      - in: path
        name: cloud_provider
        required: true
        schema:
          type: string
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/CloudintegrationtypesAccount'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Get account
      tags:
      - cloudintegration
    put:
      deprecated: false
      description: This endpoint updates an account for the specified cloud provider
      operationId: UpdateAccount
      parameters:
      - in: path
        name: cloud_provider
        required: true
        schema:
          type: string
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CloudintegrationtypesUpdatableAccount'
      responses:
        "204":
          description: No Content
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Update account
      tags:
      - cloudintegration
  /api/v1/cloud_integrations/{cloud_provider}/accounts/{id}/services/{service_id}:
    put:
      deprecated: false
      description: This endpoint updates a service for the specified cloud provider
      operationId: UpdateService
      parameters:
      - in: path
        name: cloud_provider
        required: true
        schema:
          type: string
      - in: path
        name: id
        required: true
        schema:
          type: string
      - in: path
        name: service_id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CloudintegrationtypesUpdatableService'
      responses:
        "204":
          description: No Content
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Update service
      tags:
      - cloudintegration
  /api/v1/cloud_integrations/{cloud_provider}/accounts/check_in:
    post:
      deprecated: false
      description: This endpoint is called by the deployed agent to check in
      operationId: AgentCheckIn
      parameters:
      - in: path
        name: cloud_provider
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CloudintegrationtypesPostableAgentCheckIn'
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/CloudintegrationtypesGettableAgentCheckIn'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - VIEWER
      - tokenizer:
        - VIEWER
      summary: Agent check-in
      tags:
      - cloudintegration
  /api/v1/cloud_integrations/{cloud_provider}/credentials:
    get:
      deprecated: false
      description: This endpoint retrieves the connection credentials required for
        integration
      operationId: GetConnectionCredentials
      parameters:
      - in: path
        name: cloud_provider
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/CloudintegrationtypesCredentials'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Get connection credentials
      tags:
      - cloudintegration
  /api/v1/cloud_integrations/{cloud_provider}/services:
    get:
      deprecated: false
      description: This endpoint lists the services metadata for the specified cloud
        provider
      operationId: ListServicesMetadata
      parameters:
      - in: query
        name: cloud_integration_id
        required: false
        schema:
          type: string
      - in: path
        name: cloud_provider
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/CloudintegrationtypesGettableServicesMetadata'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: List services metadata
      tags:
      - cloudintegration
  /api/v1/cloud_integrations/{cloud_provider}/services/{service_id}:
    get:
      deprecated: false
      description: This endpoint gets a service for the specified cloud provider
      operationId: GetService
      parameters:
      - in: query
        name: cloud_integration_id
        required: false
        schema:
          type: string
      - in: path
        name: cloud_provider
        required: true
        schema:
          type: string
      - in: path
        name: service_id
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/CloudintegrationtypesService'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Get service
      tags:
      - cloudintegration
  /api/v1/complete/google:
    get:
      deprecated: false
      description: This endpoint creates a session for a user using google callback
      operationId: CreateSessionByGoogleCallback
      responses:
        "303":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/AuthtypesGettableToken'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: See Other
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      summary: Create session by google callback
      tags:
      - sessions
  /api/v1/complete/oidc:
    get:
      deprecated: false
      description: This endpoint creates a session for a user using oidc callback
      operationId: CreateSessionByOIDCCallback
      responses:
        "303":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/AuthtypesGettableToken'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: See Other
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "451":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unavailable For Legal Reasons
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      summary: Create session by oidc callback
      tags:
      - sessions
  /api/v1/complete/saml:
    post:
      deprecated: false
      description: This endpoint creates a session for a user using saml callback
      operationId: CreateSessionBySAMLCallback
      parameters:
      - in: query
        name: RelayState
        schema:
          type: string
      - in: query
        name: SAMLResponse
        schema:
          type: string
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              properties:
                RelayState:
                  type: string
                SAMLResponse:
                  type: string
              type: object
      responses:
        "303":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/AuthtypesGettableToken'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: See Other
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "451":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unavailable For Legal Reasons
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      summary: Create session by saml callback
      tags:
      - sessions
  /api/v1/dashboards/{id}/public:
    delete:
      deprecated: false
      description: This endpoint deletes the public sharing config and disables the
        public sharing of a dashboard
      operationId: DeletePublicDashboard
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        "204":
          content:
            application/json:
              schema:
                type: string
          description: No Content
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Delete public dashboard
      tags:
      - dashboard
    get:
      deprecated: false
      description: This endpoint returns public sharing config for a dashboard
      operationId: GetPublicDashboard
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/DashboardtypesGettablePublicDasbhboard'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Get public dashboard
      tags:
      - dashboard
    post:
      deprecated: false
      description: This endpoint creates public sharing config and enables public
        sharing of the dashboard
      operationId: CreatePublicDashboard
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DashboardtypesPostablePublicDashboard'
      responses:
        "201":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/TypesIdentifiable'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: Created
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Create public dashboard
      tags:
      - dashboard
    put:
      deprecated: false
      description: This endpoint updates the public sharing config for a dashboard
      operationId: UpdatePublicDashboard
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DashboardtypesUpdatablePublicDashboard'
      responses:
        "204":
          content:
            application/json:
              schema:
                type: string
          description: No Content
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Update public dashboard
      tags:
      - dashboard
  /api/v1/domains:
    get:
      deprecated: false
      description: This endpoint lists all auth domains
      operationId: ListAuthDomains
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/AuthtypesGettableAuthDomain'
                    type: array
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: List all auth domains
      tags:
      - authdomains
    post:
      deprecated: false
      description: This endpoint creates an auth domain
      operationId: CreateAuthDomain
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthtypesPostableAuthDomain'
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/AuthtypesGettableAuthDomain'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Conflict
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Create auth domain
      tags:
      - authdomains
  /api/v1/domains/{id}:
    delete:
      deprecated: false
      description: This endpoint deletes an auth domain
      operationId: DeleteAuthDomain
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Delete auth domain
      tags:
      - authdomains
    put:
      deprecated: false
      description: This endpoint updates an auth domain
      operationId: UpdateAuthDomain
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthtypesUpdateableAuthDomain'
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Conflict
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Update auth domain
      tags:
      - authdomains
  /api/v1/downtime_schedules:
    get:
      deprecated: false
      description: This endpoint lists all planned maintenance / downtime schedules
      operationId: ListDowntimeSchedules
      parameters:
      - in: query
        name: active
        schema:
          nullable: true
          type: boolean
      - in: query
        name: recurring
        schema:
          nullable: true
          type: boolean
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/RuletypesPlannedMaintenance'
                    type: array
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - VIEWER
      - tokenizer:
        - VIEWER
      summary: List downtime schedules
      tags:
      - downtimeschedules
    post:
      deprecated: false
      description: This endpoint creates a new planned maintenance / downtime schedule
      operationId: CreateDowntimeSchedule
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RuletypesPostablePlannedMaintenance'
      responses:
        "201":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/RuletypesPlannedMaintenance'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: Created
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - EDITOR
      - tokenizer:
        - EDITOR
      summary: Create downtime schedule
      tags:
      - downtimeschedules
  /api/v1/downtime_schedules/{id}:
    delete:
      deprecated: false
      description: This endpoint deletes a downtime schedule by ID
      operationId: DeleteDowntimeScheduleByID
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        "204":
          description: No Content
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - EDITOR
      - tokenizer:
        - EDITOR
      summary: Delete downtime schedule
      tags:
      - downtimeschedules
    get:
      deprecated: false
      description: This endpoint returns a downtime schedule by ID
      operationId: GetDowntimeScheduleByID
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/RuletypesPlannedMaintenance'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - VIEWER
      - tokenizer:
        - VIEWER
      summary: Get downtime schedule by ID
      tags:
      - downtimeschedules
    put:
      deprecated: false
      description: This endpoint updates a downtime schedule by ID
      operationId: UpdateDowntimeScheduleByID
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RuletypesPostablePlannedMaintenance'
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - EDITOR
      - tokenizer:
        - EDITOR
      summary: Update downtime schedule
      tags:
      - downtimeschedules
  /api/v1/export_raw_data:
    post:
      deprecated: false
      description: This endpoints allows complex query exporting raw data for traces
        and logs
      operationId: HandleExportRawDataPOST
      parameters:
      - description: The output format for the export.
        in: query
        name: format
        schema:
          default: csv
          description: The output format for the export.
          enum:
          - csv
          - jsonl
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Querybuildertypesv5QueryRangeRequest'
      responses:
        "200":
          content:
            application/json:
              schema:
                type: string
          description: OK
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - VIEWER
      - tokenizer:
        - VIEWER
      summary: Export raw data
      tags:
      - logs
      - traces
  /api/v1/fields/keys:
    get:
      deprecated: false
      description: This endpoint returns field keys
      operationId: GetFieldsKeys
      parameters:
      - in: query
        name: signal
        schema:
          $ref: '#/components/schemas/TelemetrytypesSignal'
      - in: query
        name: source
        schema:
          $ref: '#/components/schemas/TelemetrytypesSource'
      - in: query
        name: limit
        schema:
          type: integer
      - in: query
        name: startUnixMilli
        schema:
          format: int64
          type: integer
      - in: query
        name: endUnixMilli
        schema:
          format: int64
          type: integer
      - in: query
        name: fieldContext
        schema:
          $ref: '#/components/schemas/TelemetrytypesFieldContext'
      - in: query
        name: fieldDataType
        schema:
          $ref: '#/components/schemas/TelemetrytypesFieldDataType'
      - in: query
        name: metricName
        schema:
          type: string
      - in: query
        name: metricNamespace
        schema:
          type: string
      - in: query
        name: searchText
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/TelemetrytypesGettableFieldKeys'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - VIEWER
      - tokenizer:
        - VIEWER
      summary: Get field keys
      tags:
      - fields
  /api/v1/fields/values:
    get:
      deprecated: false
      description: This endpoint returns field values
      operationId: GetFieldsValues
      parameters:
      - in: query
        name: signal
        schema:
          $ref: '#/components/schemas/TelemetrytypesSignal'
      - in: query
        name: source
        schema:
          $ref: '#/components/schemas/TelemetrytypesSource'
      - in: query
        name: limit
        schema:
          type: integer
      - in: query
        name: startUnixMilli
        schema:
          format: int64
          type: integer
      - in: query
        name: endUnixMilli
        schema:
          format: int64
          type: integer
      - in: query
        name: fieldContext
        schema:
          $ref: '#/components/schemas/TelemetrytypesFieldContext'
      - in: query
        name: fieldDataType
        schema:
          $ref: '#/components/schemas/TelemetrytypesFieldDataType'
      - in: query
        name: metricName
        schema:
          type: string
      - in: query
        name: metricNamespace
        schema:
          type: string
      - in: query
        name: searchText
        schema:
          type: string
      - in: query
        name: name
        schema:
          type: string
      - in: query
        name: existingQuery
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/TelemetrytypesGettableFieldValues'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - VIEWER
      - tokenizer:
        - VIEWER
      summary: Get field values
      tags:
      - fields
  /api/v1/getResetPasswordToken/{id}:
    get:
      deprecated: true
      description: This endpoint returns the reset password token by id
      operationId: GetResetPasswordTokenDeprecated
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/TypesResetPasswordToken'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Get reset password token
      tags:
      - users
  /api/v1/global/config:
    get:
      deprecated: false
      description: This endpoint returns global config
      operationId: GetGlobalConfig
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/GlobaltypesConfig'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      summary: Get global config
      tags:
      - global
  /api/v1/invite:
    post:
      deprecated: false
      description: This endpoint creates an invite for a user
      operationId: CreateInvite
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TypesPostableInvite'
      responses:
        "201":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/TypesInvite'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: Created
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Conflict
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Create invite
      tags:
      - users
  /api/v1/invite/bulk:
    post:
      deprecated: false
      description: This endpoint creates a bulk invite for a user
      operationId: CreateBulkInvite
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TypesPostableBulkInviteRequest'
      responses:
        "201":
          description: Created
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Conflict
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Create bulk invite
      tags:
      - users
  /api/v1/logs/promote_paths:
    get:
      deprecated: false
      description: This endpoints promotes and indexes paths
      operationId: ListPromotedAndIndexedPaths
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/PromotetypesPromotePath'
                    nullable: true
                    type: array
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - VIEWER
      - tokenizer:
        - VIEWER
      summary: Promote and index paths
      tags:
      - logs
    post:
      deprecated: false
      description: This endpoints promotes and indexes paths
      operationId: HandlePromoteAndIndexPaths
      requestBody:
        content:
          application/json:
            schema:
              items:
                $ref: '#/components/schemas/PromotetypesPromotePath'
              nullable: true
              type: array
      responses:
        "201":
          description: Created
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - EDITOR
      - tokenizer:
        - EDITOR
      summary: Promote and index paths
      tags:
      - logs
  /api/v1/org/preferences:
    get:
      deprecated: false
      description: This endpoint lists all org preferences
      operationId: ListOrgPreferences
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/PreferencetypesPreference'
                    type: array
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: List org preferences
      tags:
      - preferences
  /api/v1/org/preferences/{name}:
    get:
      deprecated: false
      description: This endpoint returns the org preference by name
      operationId: GetOrgPreference
      parameters:
      - in: path
        name: name
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/PreferencetypesPreference'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Get org preference
      tags:
      - preferences
    put:
      deprecated: false
      description: This endpoint updates the org preference by name
      operationId: UpdateOrgPreference
      parameters:
      - in: path
        name: name
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PreferencetypesUpdatablePreference'
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Update org preference
      tags:
      - preferences
  /api/v1/public/dashboards/{id}:
    get:
      deprecated: false
      description: This endpoint returns the sanitized dashboard data for public access
      operationId: GetPublicDashboardData
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/DashboardtypesGettablePublicDashboardData'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - anonymous:
        - public-dashboard:read
      summary: Get public dashboard data
      tags:
      - dashboard
  /api/v1/public/dashboards/{id}/widgets/{idx}/query_range:
    get:
      deprecated: false
      description: This endpoint return query range results for a widget of public
        dashboard
      operationId: GetPublicDashboardWidgetQueryRange
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      - in: path
        name: idx
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/Querybuildertypesv5QueryRangeResponse'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - anonymous:
        - public-dashboard:read
      summary: Get query range result
      tags:
      - dashboard
  /api/v1/resetPassword:
    post:
      deprecated: false
      description: This endpoint resets the password by token
      operationId: ResetPassword
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TypesPostableResetPassword'
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Conflict
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      summary: Reset password
      tags:
      - users
  /api/v1/roles:
    get:
      deprecated: false
      description: This endpoint lists all roles
      operationId: ListRoles
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/AuthtypesRole'
                    type: array
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: List roles
      tags:
      - role
    post:
      deprecated: false
      description: This endpoint creates a role
      operationId: CreateRole
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthtypesPostableRole'
      responses:
        "201":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/TypesIdentifiable'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: Created
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Conflict
        "451":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unavailable For Legal Reasons
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
        "501":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Implemented
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Create role
      tags:
      - role
  /api/v1/roles/{id}:
    delete:
      deprecated: false
      description: This endpoint deletes a role
      operationId: DeleteRole
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        "204":
          content:
            application/json:
              schema:
                type: string
          description: No Content
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "451":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unavailable For Legal Reasons
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
        "501":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Implemented
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Delete role
      tags:
      - role
    get:
      deprecated: false
      description: This endpoint gets a role
      operationId: GetRole
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/AuthtypesRole'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Get role
      tags:
      - role
    patch:
      deprecated: false
      description: This endpoint patches a role
      operationId: PatchRole
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthtypesPatchableRole'
      responses:
        "204":
          content:
            application/json:
              schema:
                type: string
          description: No Content
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "451":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unavailable For Legal Reasons
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
        "501":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Implemented
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Patch role
      tags:
      - role
  /api/v1/roles/{id}/relations/{relation}/objects:
    get:
      deprecated: false
      description: Gets all objects connected to the specified role via a given relation
        type
      operationId: GetObjects
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      - in: path
        name: relation
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/AuthtypesGettableObjects'
                    type: array
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "451":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unavailable For Legal Reasons
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
        "501":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Implemented
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Get objects for a role by relation
      tags:
      - role
    patch:
      deprecated: false
      description: Patches the objects connected to the specified role via a given
        relation type
      operationId: PatchObjects
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      - in: path
        name: relation
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthtypesPatchableObjects'
      responses:
        "204":
          content:
            application/json:
              schema:
                type: string
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "451":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unavailable For Legal Reasons
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
        "501":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Implemented
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Patch objects for a role by relation
      tags:
      - role
  /api/v1/route_policies:
    get:
      deprecated: false
      description: This endpoint lists all route policies for the organization
      operationId: GetAllRoutePolicies
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/AlertmanagertypesGettableRoutePolicy'
                    type: array
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - VIEWER
      - tokenizer:
        - VIEWER
      summary: List route policies
      tags:
      - routepolicies
    post:
      deprecated: false
      description: This endpoint creates a route policy
      operationId: CreateRoutePolicy
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertmanagertypesPostableRoutePolicy'
      responses:
        "201":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/AlertmanagertypesGettableRoutePolicy'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: Created
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Create route policy
      tags:
      - routepolicies
  /api/v1/route_policies/{id}:
    delete:
      deprecated: false
      description: This endpoint deletes a route policy by ID
      operationId: DeleteRoutePolicyByID
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        "204":
          description: No Content
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Delete route policy
      tags:
      - routepolicies
    get:
      deprecated: false
      description: This endpoint returns a route policy by ID
      operationId: GetRoutePolicyByID
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/AlertmanagertypesGettableRoutePolicy'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - VIEWER
      - tokenizer:
        - VIEWER
      summary: Get route policy by ID
      tags:
      - routepolicies
    put:
      deprecated: false
      description: This endpoint updates a route policy by ID
      operationId: UpdateRoutePolicy
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertmanagertypesPostableRoutePolicy'
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/AlertmanagertypesGettableRoutePolicy'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Update route policy
      tags:
      - routepolicies
  /api/v1/service_accounts:
    get:
      deprecated: false
      description: This endpoint lists the service accounts for an organisation
      operationId: ListServiceAccounts
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/ServiceaccounttypesServiceAccount'
                    type: array
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: List service accounts
      tags:
      - serviceaccount
    post:
      deprecated: false
      description: This endpoint creates a service account
      operationId: CreateServiceAccount
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceaccounttypesPostableServiceAccount'
      responses:
        "201":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/TypesIdentifiable'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: Created
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Conflict
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Create service account
      tags:
      - serviceaccount
  /api/v1/service_accounts/{id}:
    delete:
      deprecated: false
      description: This endpoint deletes an existing service account
      operationId: DeleteServiceAccount
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        "204":
          content:
            application/json:
              schema:
                type: string
          description: No Content
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Deletes a service account
      tags:
      - serviceaccount
    get:
      deprecated: false
      description: This endpoint gets an existing service account
      operationId: GetServiceAccount
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/ServiceaccounttypesServiceAccountWithRoles'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Gets a service account
      tags:
      - serviceaccount
    put:
      deprecated: false
      description: This endpoint updates an existing service account
      operationId: UpdateServiceAccount
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceaccounttypesPostableServiceAccount'
      responses:
        "204":
          content:
            application/json:
              schema:
                type: string
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Updates a service account
      tags:
      - serviceaccount
  /api/v1/service_accounts/{id}/keys:
    get:
      deprecated: false
      description: This endpoint lists the service account keys
      operationId: ListServiceAccountKeys
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/ServiceaccounttypesGettableFactorAPIKey'
                    type: array
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: List service account keys
      tags:
      - serviceaccount
    post:
      deprecated: false
      description: This endpoint creates a service account key
      operationId: CreateServiceAccountKey
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceaccounttypesPostableFactorAPIKey'
      responses:
        "201":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/ServiceaccounttypesGettableFactorAPIKeyWithKey'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: Created
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Conflict
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Create a service account key
      tags:
      - serviceaccount
  /api/v1/service_accounts/{id}/keys/{fid}:
    delete:
      deprecated: false
      description: This endpoint revokes an existing service account key
      operationId: RevokeServiceAccountKey
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      - in: path
        name: fid
        required: true
        schema:
          type: string
      responses:
        "204":
          content:
            application/json:
              schema:
                type: string
          description: No Content
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Revoke a service account key
      tags:
      - serviceaccount
    put:
      deprecated: false
      description: This endpoint updates an existing service account key
      operationId: UpdateServiceAccountKey
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      - in: path
        name: fid
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceaccounttypesUpdatableFactorAPIKey'
      responses:
        "204":
          content:
            application/json:
              schema:
                type: string
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Updates a service account key
      tags:
      - serviceaccount
  /api/v1/service_accounts/{id}/roles:
    get:
      deprecated: false
      description: This endpoint gets all the roles for the existing service account
      operationId: GetServiceAccountRoles
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/AuthtypesRole'
                    nullable: true
                    type: array
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Gets service account roles
      tags:
      - serviceaccount
    post:
      deprecated: false
      description: This endpoint assigns a role to a service account
      operationId: CreateServiceAccountRole
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceaccounttypesPostableServiceAccountRole'
      responses:
        "201":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/TypesIdentifiable'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: Created
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Create service account role
      tags:
      - serviceaccount
  /api/v1/service_accounts/{id}/roles/{rid}:
    delete:
      deprecated: false
      description: This endpoint revokes a role from service account
      operationId: DeleteServiceAccountRole
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      - in: path
        name: rid
        required: true
        schema:
          type: string
      responses:
        "204":
          content:
            application/json:
              schema:
                type: string
          description: No Content
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Delete service account role
      tags:
      - serviceaccount
  /api/v1/service_accounts/me:
    get:
      deprecated: false
      description: This endpoint gets my service account
      operationId: GetMyServiceAccount
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/ServiceaccounttypesServiceAccountWithRoles'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      summary: Gets my service account
      tags:
      - serviceaccount
    put:
      deprecated: false
      description: This endpoint gets my service account
      operationId: UpdateMyServiceAccount
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServiceaccounttypesPostableServiceAccount'
      responses:
        "204":
          content:
            application/json:
              schema:
                type: string
          description: No Content
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      summary: Updates my service account
      tags:
      - serviceaccount
  /api/v1/testChannel:
    post:
      deprecated: true
      description: 'Deprecated: use /api/v1/channels/test instead'
      operationId: TestChannelDeprecated
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigReceiver'
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - EDITOR
      - tokenizer:
        - EDITOR
      summary: Test notification channel (deprecated)
      tags:
      - channels
  /api/v1/user:
    get:
      deprecated: false
      description: This endpoint lists all users
      operationId: ListUsersDeprecated
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/TypesDeprecatedUser'
                    type: array
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: List users
      tags:
      - users
  /api/v1/user/{id}:
    delete:
      deprecated: false
      description: This endpoint deletes the user by id
      operationId: DeleteUser
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        "204":
          description: No Content
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Delete user
      tags:
      - users
    get:
      deprecated: false
      description: This endpoint returns the user by id
      operationId: GetUserDeprecated
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/TypesDeprecatedUser'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Get user
      tags:
      - users
    put:
      deprecated: false
      description: This endpoint updates the user by id
      operationId: UpdateUserDeprecated
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TypesDeprecatedUser'
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/TypesDeprecatedUser'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Update user
      tags:
      - users
  /api/v1/user/me:
    get:
      deprecated: false
      description: This endpoint returns the user I belong to
      operationId: GetMyUserDeprecated
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/TypesDeprecatedUser'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - tokenizer: []
      summary: Get my user
      tags:
      - users
  /api/v1/user/preferences:
    get:
      deprecated: false
      description: This endpoint lists all user preferences
      operationId: ListUserPreferences
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/PreferencetypesPreference'
                    type: array
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - VIEWER
      - tokenizer:
        - VIEWER
      summary: List user preferences
      tags:
      - preferences
  /api/v1/user/preferences/{name}:
    get:
      deprecated: false
      description: This endpoint returns the user preference by name
      operationId: GetUserPreference
      parameters:
      - in: path
        name: name
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/PreferencetypesPreference'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - VIEWER
      - tokenizer:
        - VIEWER
      summary: Get user preference
      tags:
      - preferences
    put:
      deprecated: false
      description: This endpoint updates the user preference by name
      operationId: UpdateUserPreference
      parameters:
      - in: path
        name: name
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PreferencetypesUpdatablePreference'
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - VIEWER
      - tokenizer:
        - VIEWER
      summary: Update user preference
      tags:
      - preferences
  /api/v2/factor_password/forgot:
    post:
      deprecated: false
      description: This endpoint initiates the forgot password flow by sending a reset
        password email
      operationId: ForgotPassword
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TypesPostableForgotPassword'
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "422":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unprocessable Entity
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      summary: Forgot password
      tags:
      - users
  /api/v2/features:
    get:
      deprecated: false
      description: This endpoint returns the supported features and their details
      operationId: GetFeatures
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/FeaturetypesGettableFeature'
                    type: array
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - VIEWER
      - tokenizer:
        - VIEWER
      summary: Get features
      tags:
      - features
  /api/v2/gateway/ingestion_keys:
    get:
      deprecated: false
      description: This endpoint returns the ingestion keys for a workspace
      operationId: GetIngestionKeys
      parameters:
      - in: query
        name: page
        schema:
          type: integer
      - in: query
        name: per_page
        schema:
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/GatewaytypesGettableIngestionKeys'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - EDITOR
      - tokenizer:
        - EDITOR
      summary: Get ingestion keys for workspace
      tags:
      - gateway
    post:
      deprecated: false
      description: This endpoint creates an ingestion key for the workspace
      operationId: CreateIngestionKey
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GatewaytypesPostableIngestionKey'
      responses:
        "201":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/GatewaytypesGettableCreatedIngestionKey'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: Created
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - EDITOR
      - tokenizer:
        - EDITOR
      summary: Create ingestion key for workspace
      tags:
      - gateway
  /api/v2/gateway/ingestion_keys/{keyId}:
    delete:
      deprecated: false
      description: This endpoint deletes an ingestion key for the workspace
      operationId: DeleteIngestionKey
      parameters:
      - in: path
        name: keyId
        required: true
        schema:
          type: string
      responses:
        "204":
          description: No Content
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - EDITOR
      - tokenizer:
        - EDITOR
      summary: Delete ingestion key for workspace
      tags:
      - gateway
    patch:
      deprecated: false
      description: This endpoint updates an ingestion key for the workspace
      operationId: UpdateIngestionKey
      parameters:
      - in: path
        name: keyId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GatewaytypesPostableIngestionKey'
      responses:
        "204":
          description: No Content
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - EDITOR
      - tokenizer:
        - EDITOR
      summary: Update ingestion key for workspace
      tags:
      - gateway
  /api/v2/gateway/ingestion_keys/{keyId}/limits:
    post:
      deprecated: false
      description: This endpoint creates an ingestion key limit
      operationId: CreateIngestionKeyLimit
      parameters:
      - in: path
        name: keyId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GatewaytypesPostableIngestionKeyLimit'
      responses:
        "201":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/GatewaytypesGettableCreatedIngestionKeyLimit'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: Created
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - EDITOR
      - tokenizer:
        - EDITOR
      summary: Create limit for the ingestion key
      tags:
      - gateway
  /api/v2/gateway/ingestion_keys/limits/{limitId}:
    delete:
      deprecated: false
      description: This endpoint deletes an ingestion key limit
      operationId: DeleteIngestionKeyLimit
      parameters:
      - in: path
        name: limitId
        required: true
        schema:
          type: string
      responses:
        "204":
          description: No Content
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - EDITOR
      - tokenizer:
        - EDITOR
      summary: Delete limit for the ingestion key
      tags:
      - gateway
    patch:
      deprecated: false
      description: This endpoint updates an ingestion key limit
      operationId: UpdateIngestionKeyLimit
      parameters:
      - in: path
        name: limitId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GatewaytypesUpdatableIngestionKeyLimit'
      responses:
        "204":
          description: No Content
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - EDITOR
      - tokenizer:
        - EDITOR
      summary: Update limit for the ingestion key
      tags:
      - gateway
  /api/v2/gateway/ingestion_keys/search:
    get:
      deprecated: false
      description: This endpoint returns the ingestion keys for a workspace
      operationId: SearchIngestionKeys
      parameters:
      - in: query
        name: name
        required: true
        schema:
          type: string
      - in: query
        name: page
        schema:
          type: integer
      - in: query
        name: per_page
        schema:
          type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/GatewaytypesGettableIngestionKeys'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - EDITOR
      - tokenizer:
        - EDITOR
      summary: Search ingestion keys for workspace
      tags:
      - gateway
  /api/v2/healthz:
    get:
      operationId: Healthz
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/FactoryResponse'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "503":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/FactoryResponse'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: Service Unavailable
      summary: Health check
      tags:
      - health
  /api/v2/infra_monitoring/hosts:
    post:
      deprecated: false
      description: 'Returns a paginated list of hosts with key infrastructure metrics:
        CPU usage (%), memory usage (%), I/O wait (%), disk usage (%), and 15-minute
        load average. Each host includes its current status (active/inactive based
        on metrics reported in the last 10 minutes) and metadata attributes (e.g.,
        os.type). Supports filtering via a filter expression, filtering by host status,
        custom groupBy to aggregate hosts by any attribute, ordering by any of the
        five metrics, and pagination via offset/limit. The response type is ''list''
        for the default host.name grouping or ''grouped_list'' for custom groupBy
        keys. Also reports missing required metrics and whether the requested time
        range falls before the data retention boundary.'
      operationId: ListHosts
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InframonitoringtypesPostableHosts'
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/InframonitoringtypesHosts'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - VIEWER
      - tokenizer:
        - VIEWER
      summary: List Hosts for Infra Monitoring
      tags:
      - inframonitoring
  /api/v2/livez:
    get:
      deprecated: false
      description: ""
      operationId: Livez
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/FactoryResponse'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      summary: Liveness check
      tags:
      - health
  /api/v2/metrics:
    get:
      deprecated: false
      description: This endpoint returns a list of distinct metric names within the
        specified time range
      operationId: ListMetrics
      parameters:
      - in: query
        name: start
        schema:
          nullable: true
          type: integer
      - in: query
        name: end
        schema:
          nullable: true
          type: integer
      - in: query
        name: limit
        schema:
          type: integer
      - in: query
        name: searchText
        schema:
          type: string
      - in: query
        name: source
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/MetricsexplorertypesListMetricsResponse'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - VIEWER
      - tokenizer:
        - VIEWER
      summary: List metric names
      tags:
      - metrics
  /api/v2/metrics/{metric_name}/alerts:
    get:
      deprecated: false
      description: This endpoint returns associated alerts for a specified metric
      operationId: GetMetricAlerts
      parameters:
      - in: path
        name: metric_name
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/MetricsexplorertypesMetricAlertsResponse'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - VIEWER
      - tokenizer:
        - VIEWER
      summary: Get metric alerts
      tags:
      - metrics
  /api/v2/metrics/{metric_name}/attributes:
    get:
      deprecated: false
      description: This endpoint returns attribute keys and their unique values for
        a specified metric
      operationId: GetMetricAttributes
      parameters:
      - in: query
        name: start
        schema:
          nullable: true
          type: integer
      - in: query
        name: end
        schema:
          nullable: true
          type: integer
      - in: path
        name: metric_name
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/MetricsexplorertypesMetricAttributesResponse'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - VIEWER
      - tokenizer:
        - VIEWER
      summary: Get metric attributes
      tags:
      - metrics
  /api/v2/metrics/{metric_name}/dashboards:
    get:
      deprecated: false
      description: This endpoint returns associated dashboards for a specified metric
      operationId: GetMetricDashboards
      parameters:
      - in: path
        name: metric_name
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/MetricsexplorertypesMetricDashboardsResponse'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - VIEWER
      - tokenizer:
        - VIEWER
      summary: Get metric dashboards
      tags:
      - metrics
  /api/v2/metrics/{metric_name}/highlights:
    get:
      deprecated: false
      description: This endpoint returns highlights like number of datapoints, totaltimeseries,
        active time series, last received time for a specified metric
      operationId: GetMetricHighlights
      parameters:
      - in: path
        name: metric_name
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/MetricsexplorertypesMetricHighlightsResponse'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - VIEWER
      - tokenizer:
        - VIEWER
      summary: Get metric highlights
      tags:
      - metrics
  /api/v2/metrics/{metric_name}/metadata:
    get:
      deprecated: false
      description: This endpoint returns metadata information like metric description,
        unit, type, temporality, monotonicity for a specified metric
      operationId: GetMetricMetadata
      parameters:
      - in: path
        name: metric_name
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/MetricsexplorertypesMetricMetadata'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - VIEWER
      - tokenizer:
        - VIEWER
      summary: Get metric metadata
      tags:
      - metrics
    post:
      deprecated: false
      description: This endpoint helps to update metadata information like metric
        description, unit, type, temporality, monotonicity for a specified metric
      operationId: UpdateMetricMetadata
      parameters:
      - in: path
        name: metric_name
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MetricsexplorertypesUpdateMetricMetadataRequest'
      responses:
        "200":
          content:
            application/json:
              schema:
                type: string
          description: OK
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - EDITOR
      - tokenizer:
        - EDITOR
      summary: Update metric metadata
      tags:
      - metrics
  /api/v2/metrics/inspect:
    post:
      deprecated: false
      description: Returns raw time series data points for a metric within a time
        range (max 30 minutes). Each series includes labels and timestamp/value pairs.
      operationId: InspectMetrics
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MetricsexplorertypesInspectMetricsRequest'
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/MetricsexplorertypesInspectMetricsResponse'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - VIEWER
      - tokenizer:
        - VIEWER
      summary: Inspect raw metric data points
      tags:
      - metrics
  /api/v2/metrics/onboarding:
    get:
      deprecated: false
      description: Lightweight endpoint that checks if any non-SigNoz metrics have
        been ingested, used for onboarding status detection
      operationId: GetMetricsOnboardingStatus
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/MetricsexplorertypesMetricsOnboardingResponse'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - VIEWER
      - tokenizer:
        - VIEWER
      summary: Check if non-SigNoz metrics have been received
      tags:
      - metrics
  /api/v2/metrics/stats:
    post:
      deprecated: false
      description: This endpoint provides list of metrics with their number of samples
        and timeseries for the given time range
      operationId: GetMetricsStats
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MetricsexplorertypesStatsRequest'
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/MetricsexplorertypesStatsResponse'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - VIEWER
      - tokenizer:
        - VIEWER
      summary: Get metrics statistics
      tags:
      - metrics
  /api/v2/metrics/treemap:
    post:
      deprecated: false
      description: This endpoint returns a treemap visualization showing the proportional
        distribution of metrics by sample count or time series count
      operationId: GetMetricsTreemap
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MetricsexplorertypesTreemapRequest'
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/MetricsexplorertypesTreemapResponse'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - VIEWER
      - tokenizer:
        - VIEWER
      summary: Get metrics treemap
      tags:
      - metrics
  /api/v2/orgs/me:
    get:
      deprecated: false
      description: This endpoint returns the organization I belong to
      operationId: GetMyOrganization
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/TypesOrganization'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Get my organization
      tags:
      - orgs
    put:
      deprecated: false
      description: This endpoint updates the organization I belong to
      operationId: UpdateMyOrganization
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TypesOrganization'
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Conflict
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Update my organization
      tags:
      - orgs
  /api/v2/readyz:
    get:
      operationId: Readyz
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/FactoryResponse'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "503":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/FactoryResponse'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: Service Unavailable
      summary: Readiness check
      tags:
      - health
  /api/v2/roles/{id}/users:
    get:
      deprecated: false
      description: This endpoint returns the users having the role by role id
      operationId: GetUsersByRoleID
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/TypesUser'
                    type: array
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Get users by role id
      tags:
      - users
  /api/v2/rules:
    get:
      deprecated: false
      description: This endpoint lists all alert rules with their current evaluation
        state
      operationId: ListRules
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/RuletypesRule'
                    type: array
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - VIEWER
      - tokenizer:
        - VIEWER
      summary: List alert rules
      tags:
      - rules
    post:
      deprecated: false
      description: This endpoint creates a new alert rule
      operationId: CreateRule
      requestBody:
        content:
          application/json:
            examples:
              logs_error_rate_formula:
                description: Two disabled log count queries (A = errors, B = total)
                  combined via a builder_formula into a percentage. Classic service-level
                  error-rate alert pattern for log-based signals.
                summary: Logs error rate error count / total count × 100
                value:
                  alert: Payments-api error log rate above 1%
                  alertType: LOGS_BASED_ALERT
                  annotations:
                    description: Error log rate in {{$deployment.environment}} is
                      {{$value}}%
                    summary: Payments-api error rate above {{$threshold}}%
                  condition:
                    compositeQuery:
                      panelType: graph
                      queries:
                      - spec:
                          aggregations:
                          - expression: count()
                          disabled: true
                          filter:
                            expression: service.name = 'payments-api' AND severity_text
                              IN ['ERROR', 'FATAL']
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: deployment.environment
                          name: A
                          signal: logs
                          stepInterval: 60
                        type: builder_query
                      - spec:
                          aggregations:
                          - expression: count()
                          disabled: true
                          filter:
                            expression: service.name = 'payments-api'
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: deployment.environment
                          name: B
                          signal: logs
                          stepInterval: 60
                        type: builder_query
                      - spec:
                          expression: (A / B) * 100
                          legend: '{{deployment.environment}}'
                          name: F1
                        type: builder_formula
                      queryType: builder
                      unit: percent
                    selectedQueryName: F1
                    thresholds:
                      kind: basic
                      spec:
                      - channels:
                        - slack-payments
                        matchType: at_least_once
                        name: critical
                        op: above
                        target: 1
                  description: Error log ratio as a percentage of total logs for payments-api
                  evaluation:
                    kind: rolling
                    spec:
                      evalWindow: 5m
                      frequency: 1m
                  labels:
                    severity: critical
                    team: payments
                  notificationSettings:
                    groupBy:
                    - deployment.environment
                    renotify:
                      alertStates:
                      - firing
                      enabled: true
                      interval: 30m
                  ruleType: threshold_rule
                  schemaVersion: v2alpha1
                  version: v5
              logs_threshold:
                description: Counts matching log records (ERROR severity + body contains)
                  over a rolling window. Fires at least once per evaluation when the
                  count exceeds zero.
                summary: Logs threshold count() over filter
                value:
                  alert: Payments service panic logs
                  alertType: LOGS_BASED_ALERT
                  annotations:
                    description: '{{$k8s.pod.name}} emitted {{$value}} panic log(s)
                      in {{$deployment.environment}}.'
                    summary: Payments service panic
                  condition:
                    compositeQuery:
                      panelType: graph
                      queries:
                      - spec:
                          aggregations:
                          - expression: count()
                          filter:
                            expression: service.name = 'payments-api' AND severity_text
                              = 'ERROR' AND body CONTAINS 'panic'
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: k8s.pod.name
                          - fieldContext: resource
                            fieldDataType: string
                            name: deployment.environment
                          legend: '{{k8s.pod.name}} ({{deployment.environment}})'
                          name: A
                          signal: logs
                          stepInterval: 60
                        type: builder_query
                      queryType: builder
                    selectedQueryName: A
                    thresholds:
                      kind: basic
                      spec:
                      - channels:
                        - slack-payments
                        - pagerduty-payments
                        matchType: at_least_once
                        name: critical
                        op: above
                        target: 0
                  description: Any panic log line emitted by the payments service
                  evaluation:
                    kind: rolling
                    spec:
                      evalWindow: 5m
                      frequency: 1m
                  labels:
                    severity: critical
                    team: payments
                  notificationSettings:
                    groupBy:
                    - k8s.pod.name
                    - deployment.environment
                    renotify:
                      alertStates:
                      - firing
                      enabled: true
                      interval: 15m
                  ruleType: threshold_rule
                  schemaVersion: v2alpha1
                  version: v5
              metric_anomaly:
                description: Anomaly rules are not yet supported under schemaVersion
                  v2alpha1, so this example uses the v1 shape. Wraps a builder query
                  in the `anomaly` function with daily seasonality SigNoz compares
                  each point against the forecast for that time of day. Fires when
                  the anomaly score stays below the threshold for the entire window;
                  `requireMinPoints` guards against noisy intervals.
                summary: Metric anomaly rule (v1 only)
                value:
                  alert: Anomalous drop in ingested spans
                  alertType: METRIC_BASED_ALERT
                  annotations:
                    description: Ingestion rate for tenant {{$tenant_id}} is anomalously
                      low (z-score {{$value}}).
                    summary: Span ingestion anomaly
                  condition:
                    algorithm: standard
                    compositeQuery:
                      panelType: graph
                      queries:
                      - spec:
                          aggregations:
                          - metricName: otelcol_receiver_accepted_spans
                            spaceAggregation: sum
                            timeAggregation: rate
                          filter:
                            expression: tenant_tier = 'premium'
                          functions:
                          - args:
                            - name: z_score_threshold
                              value: 2
                            name: anomaly
                          groupBy:
                          - fieldContext: attribute
                            fieldDataType: string
                            name: tenant_id
                          legend: '{{tenant_id}}'
                          name: A
                          signal: metrics
                          stepInterval: 21600
                        type: builder_query
                      queryType: builder
                    matchType: all_the_times
                    op: below
                    requireMinPoints: true
                    requiredNumPoints: 3
                    seasonality: daily
                    selectedQueryName: A
                    target: 2
                  description: Detect an abrupt drop in span ingestion using a z-score
                    anomaly function
                  evalWindow: 24h
                  frequency: 3h
                  labels:
                    severity: warning
                  preferredChannels:
                  - slack-ingestion
                  ruleType: anomaly_rule
                  version: v5
              metric_promql:
                description: PromQL expression instead of the builder. Dotted OTEL
                  resource attributes are quoted ("deployment.environment"). Useful
                  for queries that combine series with group_right or other Prom operators.
                summary: Metric threshold PromQL rule
                value:
                  alert: Kafka consumer group lag above 1000
                  alertType: METRIC_BASED_ALERT
                  annotations:
                    description: Consumer group {{$group}} is {{$value}} messages
                      behind on {{$topic}}/{{$partition}}.
                    summary: Kafka consumer lag high
                  condition:
                    compositeQuery:
                      panelType: graph
                      queries:
                      - spec:
                          legend: '{{topic}}/{{partition}} ({{group}})'
                          name: A
                          query: (max by(topic, partition, "deployment.environment")(kafka_log_end_offset)
                            - on(topic, partition, "deployment.environment") group_right
                            max by(group, topic, partition, "deployment.environment")(kafka_consumer_committed_offset))
                            > 0
                        type: promql
                      queryType: promql
                    selectedQueryName: A
                    thresholds:
                      kind: basic
                      spec:
                      - channels:
                        - slack-data-platform
                        - pagerduty-data
                        matchType: all_the_times
                        name: critical
                        op: above
                        target: 1000
                  description: Consumer group lag computed via PromQL
                  evaluation:
                    kind: rolling
                    spec:
                      evalWindow: 10m
                      frequency: 1m
                  labels:
                    severity: critical
                  notificationSettings:
                    groupBy:
                    - group
                    - topic
                    renotify:
                      alertStates:
                      - firing
                      enabled: true
                      interval: 1h
                  ruleType: promql_rule
                  schemaVersion: v2alpha1
                  version: v5
              metric_threshold_formula:
                description: Computes disk utilization as (1 - available/capacity)
                  * 100 by combining two disabled base queries with a builder_formula.
                  The formula emits 0–100, so compositeQuery.unit is set to "percent"
                  and the target is a bare number.
                summary: Metric threshold multi-query formula
                value:
                  alert: PersistentVolume above 80% utilization
                  alertType: METRIC_BASED_ALERT
                  annotations:
                    description: Volume {{$k8s.persistentvolumeclaim.name}} in {{$k8s.namespace.name}}
                      is {{$value}}% full.
                    summary: Disk utilization above {{$threshold}}%
                  condition:
                    compositeQuery:
                      panelType: graph
                      queries:
                      - spec:
                          aggregations:
                          - metricName: k8s.volume.available
                            spaceAggregation: max
                            timeAggregation: max
                          disabled: true
                          filter:
                            expression: k8s.volume.type = 'persistentVolumeClaim'
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: k8s.persistentvolumeclaim.name
                          - fieldContext: resource
                            fieldDataType: string
                            name: k8s.namespace.name
                          name: A
                          signal: metrics
                          stepInterval: 60
                        type: builder_query
                      - spec:
                          aggregations:
                          - metricName: k8s.volume.capacity
                            spaceAggregation: max
                            timeAggregation: max
                          disabled: true
                          filter:
                            expression: k8s.volume.type = 'persistentVolumeClaim'
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: k8s.persistentvolumeclaim.name
                          - fieldContext: resource
                            fieldDataType: string
                            name: k8s.namespace.name
                          name: B
                          signal: metrics
                          stepInterval: 60
                        type: builder_query
                      - spec:
                          expression: (1 - A/B) * 100
                          legend: '{{k8s.persistentvolumeclaim.name}} ({{k8s.namespace.name}})'
                          name: F1
                        type: builder_formula
                      queryType: builder
                      unit: percent
                    selectedQueryName: F1
                    thresholds:
                      kind: basic
                      spec:
                      - channels:
                        - slack-storage
                        matchType: at_least_once
                        name: critical
                        op: above
                        target: 80
                  description: Disk utilization for a persistent volume is above 80%
                  evaluation:
                    kind: rolling
                    spec:
                      evalWindow: 30m
                      frequency: 5m
                  labels:
                    severity: critical
                  notificationSettings:
                    groupBy:
                    - k8s.namespace.name
                    - k8s.persistentvolumeclaim.name
                    renotify:
                      alertStates:
                      - firing
                      enabled: true
                      interval: 2h
                  ruleType: threshold_rule
                  schemaVersion: v2alpha1
                  version: v5
              metric_threshold_single:
                description: Fires when a pod consumes more than 80% of its requested
                  CPU for the whole evaluation window. Uses `k8s.pod.cpu_request_utilization`.
                summary: Metric threshold single builder query
                value:
                  alert: Pod CPU above 80% of request
                  alertType: METRIC_BASED_ALERT
                  annotations:
                    description: Pod {{$k8s.pod.name}} CPU is at {{$value}} of request
                      in {{$deployment.environment}}.
                    summary: Pod CPU above {{$threshold}} of request
                  condition:
                    compositeQuery:
                      panelType: graph
                      queries:
                      - spec:
                          aggregations:
                          - metricName: k8s.pod.cpu_request_utilization
                            spaceAggregation: max
                            timeAggregation: avg
                          filter:
                            expression: k8s.deployment.name = 'api-service'
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: k8s.pod.name
                          - fieldContext: resource
                            fieldDataType: string
                            name: deployment.environment
                          legend: '{{k8s.pod.name}} ({{deployment.environment}})'
                          name: A
                          signal: metrics
                          stepInterval: 60
                        type: builder_query
                      queryType: builder
                      unit: percentunit
                    selectedQueryName: A
                    thresholds:
                      kind: basic
                      spec:
                      - channels:
                        - slack-platform
                        - pagerduty-oncall
                        matchType: all_the_times
                        name: critical
                        op: above
                        target: 0.8
                  description: CPU usage for api-service pods exceeds 80% of the requested
                    CPU
                  evaluation:
                    kind: rolling
                    spec:
                      evalWindow: 15m
                      frequency: 1m
                  labels:
                    severity: critical
                    team: platform
                  notificationSettings:
                    groupBy:
                    - k8s.pod.name
                    - deployment.environment
                    renotify:
                      alertStates:
                      - firing
                      enabled: true
                      interval: 4h
                  ruleType: threshold_rule
                  schemaVersion: v2alpha1
                  version: v5
              notification_settings:
                description: 'Demonstrates the full notificationSettings surface:
                  `groupBy` merges alerts across labels to cut noise, `newGroupEvalDelay`
                  gives newly-appearing series a grace period before firing, `renotify`
                  re-alerts every 30m while firing OR while the alert is in nodata
                  (missing data is treated as actionable), and `usePolicy: false`
                  means channels come from the threshold entries rather than global
                  routing policies. Set `usePolicy: true` to skip per-threshold channels
                  and route via the org-level notification policy instead.'
                summary: Full notification settings (grouping, nodata renotify, grace
                  period)
                value:
                  alert: API 5xx error rate above 1%
                  alertType: TRACES_BASED_ALERT
                  annotations:
                    description: '{{$service.name}} 5xx rate in {{$deployment.environment}}
                      is {{$value}}%.'
                    summary: API service error rate elevated
                  condition:
                    compositeQuery:
                      panelType: graph
                      queries:
                      - spec:
                          aggregations:
                          - expression: count()
                          disabled: true
                          filter:
                            expression: service.name CONTAINS 'api' AND http.status_code
                              >= 500
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: service.name
                          - fieldContext: resource
                            fieldDataType: string
                            name: deployment.environment
                          name: A
                          signal: traces
                          stepInterval: 60
                        type: builder_query
                      - spec:
                          aggregations:
                          - expression: count()
                          disabled: true
                          filter:
                            expression: service.name CONTAINS 'api'
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: service.name
                          - fieldContext: resource
                            fieldDataType: string
                            name: deployment.environment
                          name: B
                          signal: traces
                          stepInterval: 60
                        type: builder_query
                      - spec:
                          expression: (A / B) * 100
                          legend: '{{service.name}} ({{deployment.environment}})'
                          name: F1
                        type: builder_formula
                      queryType: builder
                      unit: percent
                    selectedQueryName: F1
                    thresholds:
                      kind: basic
                      spec:
                      - channels:
                        - slack-api-alerts
                        - pagerduty-oncall
                        matchType: at_least_once
                        name: critical
                        op: above
                        target: 1
                  description: Noise-controlled 5xx error rate alert with renotify
                    on gaps
                  evaluation:
                    kind: rolling
                    spec:
                      evalWindow: 5m
                      frequency: 1m
                  labels:
                    team: platform
                  notificationSettings:
                    groupBy:
                    - service.name
                    - deployment.environment
                    newGroupEvalDelay: 2m
                    renotify:
                      alertStates:
                      - firing
                      - nodata
                      enabled: true
                      interval: 30m
                    usePolicy: false
                  ruleType: threshold_rule
                  schemaVersion: v2alpha1
                  version: v5
              tiered_thresholds:
                description: Two tiers (warning and critical) in a single rule, each
                  with its own target, op, matchType, and channels so warnings and
                  pages route to different receivers. `alertOnAbsent` + `absentFor`
                  fires a no-data alert when the query returns no series for 15 consecutive
                  evaluations.
                summary: Tiered thresholds with per-tier channels
                value:
                  alert: Kafka consumer lag warn / critical
                  alertType: METRIC_BASED_ALERT
                  annotations:
                    description: Consumer lag for {{$topic}} partition {{$partition}}
                      is {{$value}}.
                    summary: Kafka consumer lag
                  condition:
                    absentFor: 15
                    alertOnAbsent: true
                    compositeQuery:
                      panelType: graph
                      queries:
                      - spec:
                          aggregations:
                          - metricName: kafka_log_end_offset
                            spaceAggregation: max
                            timeAggregation: max
                          disabled: true
                          filter:
                            expression: topic != '__consumer_offsets'
                          groupBy:
                          - fieldContext: attribute
                            fieldDataType: string
                            name: topic
                          - fieldContext: attribute
                            fieldDataType: string
                            name: partition
                          name: A
                          signal: metrics
                          stepInterval: 60
                        type: builder_query
                      - spec:
                          aggregations:
                          - metricName: kafka_consumer_committed_offset
                            spaceAggregation: max
                            timeAggregation: max
                          disabled: true
                          filter:
                            expression: topic != '__consumer_offsets'
                          groupBy:
                          - fieldContext: attribute
                            fieldDataType: string
                            name: topic
                          - fieldContext: attribute
                            fieldDataType: string
                            name: partition
                          name: B
                          signal: metrics
                          stepInterval: 60
                        type: builder_query
                      - spec:
                          expression: A - B
                          legend: '{{topic}}/{{partition}}'
                          name: F1
                        type: builder_formula
                      queryType: builder
                    selectedQueryName: F1
                    thresholds:
                      kind: basic
                      spec:
                      - channels:
                        - slack-kafka-info
                        matchType: all_the_times
                        name: warning
                        op: above
                        target: 50
                      - channels:
                        - slack-kafka-alerts
                        - pagerduty-kafka
                        matchType: all_the_times
                        name: critical
                        op: above
                        target: 200
                  description: Warn at lag ≥ 50 and page at ≥ 200, tiered via thresholds.spec.
                  evaluation:
                    kind: rolling
                    spec:
                      evalWindow: 5m
                      frequency: 1m
                  labels:
                    team: data-platform
                  notificationSettings:
                    groupBy:
                    - topic
                    renotify:
                      alertStates:
                      - firing
                      enabled: true
                      interval: 15m
                  ruleType: threshold_rule
                  schemaVersion: v2alpha1
                  version: v5
              traces_error_rate_formula:
                description: Two disabled trace count queries (A = error spans where
                  hasError=true, B = total spans) combined via a builder_formula into
                  a percentage. Mirrors the common request-error-rate dashboard shape.
                summary: Traces error rate error spans / total spans × 100
                value:
                  alert: Search-api error rate above 5%
                  alertType: TRACES_BASED_ALERT
                  annotations:
                    description: Error rate on {{$service.name}} {{$http.route}} is
                      {{$value}}%
                    summary: Search-api error rate above {{$threshold}}%
                  condition:
                    compositeQuery:
                      panelType: graph
                      queries:
                      - spec:
                          aggregations:
                          - expression: count()
                          disabled: true
                          filter:
                            expression: service.name = 'search-api' AND hasError =
                              true
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: service.name
                          - fieldContext: attribute
                            fieldDataType: string
                            name: http.route
                          name: A
                          signal: traces
                          stepInterval: 60
                        type: builder_query
                      - spec:
                          aggregations:
                          - expression: count()
                          disabled: true
                          filter:
                            expression: service.name = 'search-api'
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: service.name
                          - fieldContext: attribute
                            fieldDataType: string
                            name: http.route
                          name: B
                          signal: traces
                          stepInterval: 60
                        type: builder_query
                      - spec:
                          expression: (A / B) * 100
                          legend: '{{service.name}} {{http.route}}'
                          name: F1
                        type: builder_formula
                      queryType: builder
                      unit: percent
                    selectedQueryName: F1
                    thresholds:
                      kind: basic
                      spec:
                      - channels:
                        - slack-search
                        - pagerduty-search
                        matchType: at_least_once
                        name: critical
                        op: above
                        target: 5
                  description: Request error rate for search-api, grouped by route
                  evaluation:
                    kind: rolling
                    spec:
                      evalWindow: 5m
                      frequency: 1m
                  labels:
                    severity: critical
                    team: search
                  notificationSettings:
                    groupBy:
                    - service.name
                    - http.route
                    renotify:
                      alertStates:
                      - firing
                      enabled: true
                      interval: 15m
                  ruleType: threshold_rule
                  schemaVersion: v2alpha1
                  version: v5
              traces_threshold_latency:
                description: Builder query against the traces signal with p99(duration_nano).
                  The series unit is ns (compositeQuery.unit), the target is in seconds
                  (threshold.targetUnit) SigNoz converts before comparing. Canonical
                  shape when series and target live in different units.
                summary: Traces threshold p99 latency (ns → s conversion)
                value:
                  alert: Search API p99 latency above 5s
                  alertType: TRACES_BASED_ALERT
                  annotations:
                    description: p99 latency for {{$service.name}} on {{$http.route}}
                      crossed {{$threshold}}s.
                    summary: Search-api latency degraded
                  condition:
                    compositeQuery:
                      panelType: graph
                      queries:
                      - spec:
                          aggregations:
                          - expression: p99(duration_nano)
                          filter:
                            expression: service.name = 'search-api' AND name = 'GET
                              /api/v1/search'
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: service.name
                          - fieldContext: attribute
                            fieldDataType: string
                            name: http.route
                          legend: '{{service.name}} {{http.route}}'
                          name: A
                          signal: traces
                          stepInterval: 60
                        type: builder_query
                      queryType: builder
                      unit: ns
                    selectedQueryName: A
                    thresholds:
                      kind: basic
                      spec:
                      - channels:
                        - slack-search
                        matchType: at_least_once
                        name: warning
                        op: above
                        target: 5
                        targetUnit: s
                  description: p99 duration of the search endpoint exceeds 5s
                  evaluation:
                    kind: rolling
                    spec:
                      evalWindow: 5m
                      frequency: 1m
                  labels:
                    severity: warning
                    team: search
                  notificationSettings:
                    groupBy:
                    - service.name
                    - http.route
                    renotify:
                      alertStates:
                      - firing
                      enabled: true
                      interval: 30m
                  ruleType: threshold_rule
                  schemaVersion: v2alpha1
                  version: v5
            schema:
              $ref: '#/components/schemas/RuletypesPostableRule'
      responses:
        "201":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/RuletypesRule'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: Created
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - EDITOR
      - tokenizer:
        - EDITOR
      summary: Create alert rule
      tags:
      - rules
  /api/v2/rules/{id}:
    delete:
      deprecated: false
      description: This endpoint deletes an alert rule by ID
      operationId: DeleteRuleByID
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        "204":
          description: No Content
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - EDITOR
      - tokenizer:
        - EDITOR
      summary: Delete alert rule
      tags:
      - rules
    get:
      deprecated: false
      description: This endpoint returns an alert rule by ID
      operationId: GetRuleByID
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/RuletypesRule'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - VIEWER
      - tokenizer:
        - VIEWER
      summary: Get alert rule by ID
      tags:
      - rules
    patch:
      deprecated: false
      description: This endpoint applies a partial update to an alert rule by ID
      operationId: PatchRuleByID
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            examples:
              logs_error_rate_formula:
                description: Two disabled log count queries (A = errors, B = total)
                  combined via a builder_formula into a percentage. Classic service-level
                  error-rate alert pattern for log-based signals.
                summary: Logs error rate error count / total count × 100
                value:
                  alert: Payments-api error log rate above 1%
                  alertType: LOGS_BASED_ALERT
                  annotations:
                    description: Error log rate in {{$deployment.environment}} is
                      {{$value}}%
                    summary: Payments-api error rate above {{$threshold}}%
                  condition:
                    compositeQuery:
                      panelType: graph
                      queries:
                      - spec:
                          aggregations:
                          - expression: count()
                          disabled: true
                          filter:
                            expression: service.name = 'payments-api' AND severity_text
                              IN ['ERROR', 'FATAL']
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: deployment.environment
                          name: A
                          signal: logs
                          stepInterval: 60
                        type: builder_query
                      - spec:
                          aggregations:
                          - expression: count()
                          disabled: true
                          filter:
                            expression: service.name = 'payments-api'
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: deployment.environment
                          name: B
                          signal: logs
                          stepInterval: 60
                        type: builder_query
                      - spec:
                          expression: (A / B) * 100
                          legend: '{{deployment.environment}}'
                          name: F1
                        type: builder_formula
                      queryType: builder
                      unit: percent
                    selectedQueryName: F1
                    thresholds:
                      kind: basic
                      spec:
                      - channels:
                        - slack-payments
                        matchType: at_least_once
                        name: critical
                        op: above
                        target: 1
                  description: Error log ratio as a percentage of total logs for payments-api
                  evaluation:
                    kind: rolling
                    spec:
                      evalWindow: 5m
                      frequency: 1m
                  labels:
                    severity: critical
                    team: payments
                  notificationSettings:
                    groupBy:
                    - deployment.environment
                    renotify:
                      alertStates:
                      - firing
                      enabled: true
                      interval: 30m
                  ruleType: threshold_rule
                  schemaVersion: v2alpha1
                  version: v5
              logs_threshold:
                description: Counts matching log records (ERROR severity + body contains)
                  over a rolling window. Fires at least once per evaluation when the
                  count exceeds zero.
                summary: Logs threshold count() over filter
                value:
                  alert: Payments service panic logs
                  alertType: LOGS_BASED_ALERT
                  annotations:
                    description: '{{$k8s.pod.name}} emitted {{$value}} panic log(s)
                      in {{$deployment.environment}}.'
                    summary: Payments service panic
                  condition:
                    compositeQuery:
                      panelType: graph
                      queries:
                      - spec:
                          aggregations:
                          - expression: count()
                          filter:
                            expression: service.name = 'payments-api' AND severity_text
                              = 'ERROR' AND body CONTAINS 'panic'
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: k8s.pod.name
                          - fieldContext: resource
                            fieldDataType: string
                            name: deployment.environment
                          legend: '{{k8s.pod.name}} ({{deployment.environment}})'
                          name: A
                          signal: logs
                          stepInterval: 60
                        type: builder_query
                      queryType: builder
                    selectedQueryName: A
                    thresholds:
                      kind: basic
                      spec:
                      - channels:
                        - slack-payments
                        - pagerduty-payments
                        matchType: at_least_once
                        name: critical
                        op: above
                        target: 0
                  description: Any panic log line emitted by the payments service
                  evaluation:
                    kind: rolling
                    spec:
                      evalWindow: 5m
                      frequency: 1m
                  labels:
                    severity: critical
                    team: payments
                  notificationSettings:
                    groupBy:
                    - k8s.pod.name
                    - deployment.environment
                    renotify:
                      alertStates:
                      - firing
                      enabled: true
                      interval: 15m
                  ruleType: threshold_rule
                  schemaVersion: v2alpha1
                  version: v5
              metric_anomaly:
                description: Anomaly rules are not yet supported under schemaVersion
                  v2alpha1, so this example uses the v1 shape. Wraps a builder query
                  in the `anomaly` function with daily seasonality SigNoz compares
                  each point against the forecast for that time of day. Fires when
                  the anomaly score stays below the threshold for the entire window;
                  `requireMinPoints` guards against noisy intervals.
                summary: Metric anomaly rule (v1 only)
                value:
                  alert: Anomalous drop in ingested spans
                  alertType: METRIC_BASED_ALERT
                  annotations:
                    description: Ingestion rate for tenant {{$tenant_id}} is anomalously
                      low (z-score {{$value}}).
                    summary: Span ingestion anomaly
                  condition:
                    algorithm: standard
                    compositeQuery:
                      panelType: graph
                      queries:
                      - spec:
                          aggregations:
                          - metricName: otelcol_receiver_accepted_spans
                            spaceAggregation: sum
                            timeAggregation: rate
                          filter:
                            expression: tenant_tier = 'premium'
                          functions:
                          - args:
                            - name: z_score_threshold
                              value: 2
                            name: anomaly
                          groupBy:
                          - fieldContext: attribute
                            fieldDataType: string
                            name: tenant_id
                          legend: '{{tenant_id}}'
                          name: A
                          signal: metrics
                          stepInterval: 21600
                        type: builder_query
                      queryType: builder
                    matchType: all_the_times
                    op: below
                    requireMinPoints: true
                    requiredNumPoints: 3
                    seasonality: daily
                    selectedQueryName: A
                    target: 2
                  description: Detect an abrupt drop in span ingestion using a z-score
                    anomaly function
                  evalWindow: 24h
                  frequency: 3h
                  labels:
                    severity: warning
                  preferredChannels:
                  - slack-ingestion
                  ruleType: anomaly_rule
                  version: v5
              metric_promql:
                description: PromQL expression instead of the builder. Dotted OTEL
                  resource attributes are quoted ("deployment.environment"). Useful
                  for queries that combine series with group_right or other Prom operators.
                summary: Metric threshold PromQL rule
                value:
                  alert: Kafka consumer group lag above 1000
                  alertType: METRIC_BASED_ALERT
                  annotations:
                    description: Consumer group {{$group}} is {{$value}} messages
                      behind on {{$topic}}/{{$partition}}.
                    summary: Kafka consumer lag high
                  condition:
                    compositeQuery:
                      panelType: graph
                      queries:
                      - spec:
                          legend: '{{topic}}/{{partition}} ({{group}})'
                          name: A
                          query: (max by(topic, partition, "deployment.environment")(kafka_log_end_offset)
                            - on(topic, partition, "deployment.environment") group_right
                            max by(group, topic, partition, "deployment.environment")(kafka_consumer_committed_offset))
                            > 0
                        type: promql
                      queryType: promql
                    selectedQueryName: A
                    thresholds:
                      kind: basic
                      spec:
                      - channels:
                        - slack-data-platform
                        - pagerduty-data
                        matchType: all_the_times
                        name: critical
                        op: above
                        target: 1000
                  description: Consumer group lag computed via PromQL
                  evaluation:
                    kind: rolling
                    spec:
                      evalWindow: 10m
                      frequency: 1m
                  labels:
                    severity: critical
                  notificationSettings:
                    groupBy:
                    - group
                    - topic
                    renotify:
                      alertStates:
                      - firing
                      enabled: true
                      interval: 1h
                  ruleType: promql_rule
                  schemaVersion: v2alpha1
                  version: v5
              metric_threshold_formula:
                description: Computes disk utilization as (1 - available/capacity)
                  * 100 by combining two disabled base queries with a builder_formula.
                  The formula emits 0–100, so compositeQuery.unit is set to "percent"
                  and the target is a bare number.
                summary: Metric threshold multi-query formula
                value:
                  alert: PersistentVolume above 80% utilization
                  alertType: METRIC_BASED_ALERT
                  annotations:
                    description: Volume {{$k8s.persistentvolumeclaim.name}} in {{$k8s.namespace.name}}
                      is {{$value}}% full.
                    summary: Disk utilization above {{$threshold}}%
                  condition:
                    compositeQuery:
                      panelType: graph
                      queries:
                      - spec:
                          aggregations:
                          - metricName: k8s.volume.available
                            spaceAggregation: max
                            timeAggregation: max
                          disabled: true
                          filter:
                            expression: k8s.volume.type = 'persistentVolumeClaim'
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: k8s.persistentvolumeclaim.name
                          - fieldContext: resource
                            fieldDataType: string
                            name: k8s.namespace.name
                          name: A
                          signal: metrics
                          stepInterval: 60
                        type: builder_query
                      - spec:
                          aggregations:
                          - metricName: k8s.volume.capacity
                            spaceAggregation: max
                            timeAggregation: max
                          disabled: true
                          filter:
                            expression: k8s.volume.type = 'persistentVolumeClaim'
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: k8s.persistentvolumeclaim.name
                          - fieldContext: resource
                            fieldDataType: string
                            name: k8s.namespace.name
                          name: B
                          signal: metrics
                          stepInterval: 60
                        type: builder_query
                      - spec:
                          expression: (1 - A/B) * 100
                          legend: '{{k8s.persistentvolumeclaim.name}} ({{k8s.namespace.name}})'
                          name: F1
                        type: builder_formula
                      queryType: builder
                      unit: percent
                    selectedQueryName: F1
                    thresholds:
                      kind: basic
                      spec:
                      - channels:
                        - slack-storage
                        matchType: at_least_once
                        name: critical
                        op: above
                        target: 80
                  description: Disk utilization for a persistent volume is above 80%
                  evaluation:
                    kind: rolling
                    spec:
                      evalWindow: 30m
                      frequency: 5m
                  labels:
                    severity: critical
                  notificationSettings:
                    groupBy:
                    - k8s.namespace.name
                    - k8s.persistentvolumeclaim.name
                    renotify:
                      alertStates:
                      - firing
                      enabled: true
                      interval: 2h
                  ruleType: threshold_rule
                  schemaVersion: v2alpha1
                  version: v5
              metric_threshold_single:
                description: Fires when a pod consumes more than 80% of its requested
                  CPU for the whole evaluation window. Uses `k8s.pod.cpu_request_utilization`.
                summary: Metric threshold single builder query
                value:
                  alert: Pod CPU above 80% of request
                  alertType: METRIC_BASED_ALERT
                  annotations:
                    description: Pod {{$k8s.pod.name}} CPU is at {{$value}} of request
                      in {{$deployment.environment}}.
                    summary: Pod CPU above {{$threshold}} of request
                  condition:
                    compositeQuery:
                      panelType: graph
                      queries:
                      - spec:
                          aggregations:
                          - metricName: k8s.pod.cpu_request_utilization
                            spaceAggregation: max
                            timeAggregation: avg
                          filter:
                            expression: k8s.deployment.name = 'api-service'
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: k8s.pod.name
                          - fieldContext: resource
                            fieldDataType: string
                            name: deployment.environment
                          legend: '{{k8s.pod.name}} ({{deployment.environment}})'
                          name: A
                          signal: metrics
                          stepInterval: 60
                        type: builder_query
                      queryType: builder
                      unit: percentunit
                    selectedQueryName: A
                    thresholds:
                      kind: basic
                      spec:
                      - channels:
                        - slack-platform
                        - pagerduty-oncall
                        matchType: all_the_times
                        name: critical
                        op: above
                        target: 0.8
                  description: CPU usage for api-service pods exceeds 80% of the requested
                    CPU
                  evaluation:
                    kind: rolling
                    spec:
                      evalWindow: 15m
                      frequency: 1m
                  labels:
                    severity: critical
                    team: platform
                  notificationSettings:
                    groupBy:
                    - k8s.pod.name
                    - deployment.environment
                    renotify:
                      alertStates:
                      - firing
                      enabled: true
                      interval: 4h
                  ruleType: threshold_rule
                  schemaVersion: v2alpha1
                  version: v5
              notification_settings:
                description: 'Demonstrates the full notificationSettings surface:
                  `groupBy` merges alerts across labels to cut noise, `newGroupEvalDelay`
                  gives newly-appearing series a grace period before firing, `renotify`
                  re-alerts every 30m while firing OR while the alert is in nodata
                  (missing data is treated as actionable), and `usePolicy: false`
                  means channels come from the threshold entries rather than global
                  routing policies. Set `usePolicy: true` to skip per-threshold channels
                  and route via the org-level notification policy instead.'
                summary: Full notification settings (grouping, nodata renotify, grace
                  period)
                value:
                  alert: API 5xx error rate above 1%
                  alertType: TRACES_BASED_ALERT
                  annotations:
                    description: '{{$service.name}} 5xx rate in {{$deployment.environment}}
                      is {{$value}}%.'
                    summary: API service error rate elevated
                  condition:
                    compositeQuery:
                      panelType: graph
                      queries:
                      - spec:
                          aggregations:
                          - expression: count()
                          disabled: true
                          filter:
                            expression: service.name CONTAINS 'api' AND http.status_code
                              >= 500
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: service.name
                          - fieldContext: resource
                            fieldDataType: string
                            name: deployment.environment
                          name: A
                          signal: traces
                          stepInterval: 60
                        type: builder_query
                      - spec:
                          aggregations:
                          - expression: count()
                          disabled: true
                          filter:
                            expression: service.name CONTAINS 'api'
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: service.name
                          - fieldContext: resource
                            fieldDataType: string
                            name: deployment.environment
                          name: B
                          signal: traces
                          stepInterval: 60
                        type: builder_query
                      - spec:
                          expression: (A / B) * 100
                          legend: '{{service.name}} ({{deployment.environment}})'
                          name: F1
                        type: builder_formula
                      queryType: builder
                      unit: percent
                    selectedQueryName: F1
                    thresholds:
                      kind: basic
                      spec:
                      - channels:
                        - slack-api-alerts
                        - pagerduty-oncall
                        matchType: at_least_once
                        name: critical
                        op: above
                        target: 1
                  description: Noise-controlled 5xx error rate alert with renotify
                    on gaps
                  evaluation:
                    kind: rolling
                    spec:
                      evalWindow: 5m
                      frequency: 1m
                  labels:
                    team: platform
                  notificationSettings:
                    groupBy:
                    - service.name
                    - deployment.environment
                    newGroupEvalDelay: 2m
                    renotify:
                      alertStates:
                      - firing
                      - nodata
                      enabled: true
                      interval: 30m
                    usePolicy: false
                  ruleType: threshold_rule
                  schemaVersion: v2alpha1
                  version: v5
              tiered_thresholds:
                description: Two tiers (warning and critical) in a single rule, each
                  with its own target, op, matchType, and channels so warnings and
                  pages route to different receivers. `alertOnAbsent` + `absentFor`
                  fires a no-data alert when the query returns no series for 15 consecutive
                  evaluations.
                summary: Tiered thresholds with per-tier channels
                value:
                  alert: Kafka consumer lag warn / critical
                  alertType: METRIC_BASED_ALERT
                  annotations:
                    description: Consumer lag for {{$topic}} partition {{$partition}}
                      is {{$value}}.
                    summary: Kafka consumer lag
                  condition:
                    absentFor: 15
                    alertOnAbsent: true
                    compositeQuery:
                      panelType: graph
                      queries:
                      - spec:
                          aggregations:
                          - metricName: kafka_log_end_offset
                            spaceAggregation: max
                            timeAggregation: max
                          disabled: true
                          filter:
                            expression: topic != '__consumer_offsets'
                          groupBy:
                          - fieldContext: attribute
                            fieldDataType: string
                            name: topic
                          - fieldContext: attribute
                            fieldDataType: string
                            name: partition
                          name: A
                          signal: metrics
                          stepInterval: 60
                        type: builder_query
                      - spec:
                          aggregations:
                          - metricName: kafka_consumer_committed_offset
                            spaceAggregation: max
                            timeAggregation: max
                          disabled: true
                          filter:
                            expression: topic != '__consumer_offsets'
                          groupBy:
                          - fieldContext: attribute
                            fieldDataType: string
                            name: topic
                          - fieldContext: attribute
                            fieldDataType: string
                            name: partition
                          name: B
                          signal: metrics
                          stepInterval: 60
                        type: builder_query
                      - spec:
                          expression: A - B
                          legend: '{{topic}}/{{partition}}'
                          name: F1
                        type: builder_formula
                      queryType: builder
                    selectedQueryName: F1
                    thresholds:
                      kind: basic
                      spec:
                      - channels:
                        - slack-kafka-info
                        matchType: all_the_times
                        name: warning
                        op: above
                        target: 50
                      - channels:
                        - slack-kafka-alerts
                        - pagerduty-kafka
                        matchType: all_the_times
                        name: critical
                        op: above
                        target: 200
                  description: Warn at lag ≥ 50 and page at ≥ 200, tiered via thresholds.spec.
                  evaluation:
                    kind: rolling
                    spec:
                      evalWindow: 5m
                      frequency: 1m
                  labels:
                    team: data-platform
                  notificationSettings:
                    groupBy:
                    - topic
                    renotify:
                      alertStates:
                      - firing
                      enabled: true
                      interval: 15m
                  ruleType: threshold_rule
                  schemaVersion: v2alpha1
                  version: v5
              traces_error_rate_formula:
                description: Two disabled trace count queries (A = error spans where
                  hasError=true, B = total spans) combined via a builder_formula into
                  a percentage. Mirrors the common request-error-rate dashboard shape.
                summary: Traces error rate error spans / total spans × 100
                value:
                  alert: Search-api error rate above 5%
                  alertType: TRACES_BASED_ALERT
                  annotations:
                    description: Error rate on {{$service.name}} {{$http.route}} is
                      {{$value}}%
                    summary: Search-api error rate above {{$threshold}}%
                  condition:
                    compositeQuery:
                      panelType: graph
                      queries:
                      - spec:
                          aggregations:
                          - expression: count()
                          disabled: true
                          filter:
                            expression: service.name = 'search-api' AND hasError =
                              true
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: service.name
                          - fieldContext: attribute
                            fieldDataType: string
                            name: http.route
                          name: A
                          signal: traces
                          stepInterval: 60
                        type: builder_query
                      - spec:
                          aggregations:
                          - expression: count()
                          disabled: true
                          filter:
                            expression: service.name = 'search-api'
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: service.name
                          - fieldContext: attribute
                            fieldDataType: string
                            name: http.route
                          name: B
                          signal: traces
                          stepInterval: 60
                        type: builder_query
                      - spec:
                          expression: (A / B) * 100
                          legend: '{{service.name}} {{http.route}}'
                          name: F1
                        type: builder_formula
                      queryType: builder
                      unit: percent
                    selectedQueryName: F1
                    thresholds:
                      kind: basic
                      spec:
                      - channels:
                        - slack-search
                        - pagerduty-search
                        matchType: at_least_once
                        name: critical
                        op: above
                        target: 5
                  description: Request error rate for search-api, grouped by route
                  evaluation:
                    kind: rolling
                    spec:
                      evalWindow: 5m
                      frequency: 1m
                  labels:
                    severity: critical
                    team: search
                  notificationSettings:
                    groupBy:
                    - service.name
                    - http.route
                    renotify:
                      alertStates:
                      - firing
                      enabled: true
                      interval: 15m
                  ruleType: threshold_rule
                  schemaVersion: v2alpha1
                  version: v5
              traces_threshold_latency:
                description: Builder query against the traces signal with p99(duration_nano).
                  The series unit is ns (compositeQuery.unit), the target is in seconds
                  (threshold.targetUnit) SigNoz converts before comparing. Canonical
                  shape when series and target live in different units.
                summary: Traces threshold p99 latency (ns → s conversion)
                value:
                  alert: Search API p99 latency above 5s
                  alertType: TRACES_BASED_ALERT
                  annotations:
                    description: p99 latency for {{$service.name}} on {{$http.route}}
                      crossed {{$threshold}}s.
                    summary: Search-api latency degraded
                  condition:
                    compositeQuery:
                      panelType: graph
                      queries:
                      - spec:
                          aggregations:
                          - expression: p99(duration_nano)
                          filter:
                            expression: service.name = 'search-api' AND name = 'GET
                              /api/v1/search'
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: service.name
                          - fieldContext: attribute
                            fieldDataType: string
                            name: http.route
                          legend: '{{service.name}} {{http.route}}'
                          name: A
                          signal: traces
                          stepInterval: 60
                        type: builder_query
                      queryType: builder
                      unit: ns
                    selectedQueryName: A
                    thresholds:
                      kind: basic
                      spec:
                      - channels:
                        - slack-search
                        matchType: at_least_once
                        name: warning
                        op: above
                        target: 5
                        targetUnit: s
                  description: p99 duration of the search endpoint exceeds 5s
                  evaluation:
                    kind: rolling
                    spec:
                      evalWindow: 5m
                      frequency: 1m
                  labels:
                    severity: warning
                    team: search
                  notificationSettings:
                    groupBy:
                    - service.name
                    - http.route
                    renotify:
                      alertStates:
                      - firing
                      enabled: true
                      interval: 30m
                  ruleType: threshold_rule
                  schemaVersion: v2alpha1
                  version: v5
            schema:
              $ref: '#/components/schemas/RuletypesPostableRule'
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/RuletypesRule'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - EDITOR
      - tokenizer:
        - EDITOR
      summary: Patch alert rule
      tags:
      - rules
    put:
      deprecated: false
      description: This endpoint updates an alert rule by ID
      operationId: UpdateRuleByID
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            examples:
              logs_error_rate_formula:
                description: Two disabled log count queries (A = errors, B = total)
                  combined via a builder_formula into a percentage. Classic service-level
                  error-rate alert pattern for log-based signals.
                summary: Logs error rate error count / total count × 100
                value:
                  alert: Payments-api error log rate above 1%
                  alertType: LOGS_BASED_ALERT
                  annotations:
                    description: Error log rate in {{$deployment.environment}} is
                      {{$value}}%
                    summary: Payments-api error rate above {{$threshold}}%
                  condition:
                    compositeQuery:
                      panelType: graph
                      queries:
                      - spec:
                          aggregations:
                          - expression: count()
                          disabled: true
                          filter:
                            expression: service.name = 'payments-api' AND severity_text
                              IN ['ERROR', 'FATAL']
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: deployment.environment
                          name: A
                          signal: logs
                          stepInterval: 60
                        type: builder_query
                      - spec:
                          aggregations:
                          - expression: count()
                          disabled: true
                          filter:
                            expression: service.name = 'payments-api'
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: deployment.environment
                          name: B
                          signal: logs
                          stepInterval: 60
                        type: builder_query
                      - spec:
                          expression: (A / B) * 100
                          legend: '{{deployment.environment}}'
                          name: F1
                        type: builder_formula
                      queryType: builder
                      unit: percent
                    selectedQueryName: F1
                    thresholds:
                      kind: basic
                      spec:
                      - channels:
                        - slack-payments
                        matchType: at_least_once
                        name: critical
                        op: above
                        target: 1
                  description: Error log ratio as a percentage of total logs for payments-api
                  evaluation:
                    kind: rolling
                    spec:
                      evalWindow: 5m
                      frequency: 1m
                  labels:
                    severity: critical
                    team: payments
                  notificationSettings:
                    groupBy:
                    - deployment.environment
                    renotify:
                      alertStates:
                      - firing
                      enabled: true
                      interval: 30m
                  ruleType: threshold_rule
                  schemaVersion: v2alpha1
                  version: v5
              logs_threshold:
                description: Counts matching log records (ERROR severity + body contains)
                  over a rolling window. Fires at least once per evaluation when the
                  count exceeds zero.
                summary: Logs threshold count() over filter
                value:
                  alert: Payments service panic logs
                  alertType: LOGS_BASED_ALERT
                  annotations:
                    description: '{{$k8s.pod.name}} emitted {{$value}} panic log(s)
                      in {{$deployment.environment}}.'
                    summary: Payments service panic
                  condition:
                    compositeQuery:
                      panelType: graph
                      queries:
                      - spec:
                          aggregations:
                          - expression: count()
                          filter:
                            expression: service.name = 'payments-api' AND severity_text
                              = 'ERROR' AND body CONTAINS 'panic'
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: k8s.pod.name
                          - fieldContext: resource
                            fieldDataType: string
                            name: deployment.environment
                          legend: '{{k8s.pod.name}} ({{deployment.environment}})'
                          name: A
                          signal: logs
                          stepInterval: 60
                        type: builder_query
                      queryType: builder
                    selectedQueryName: A
                    thresholds:
                      kind: basic
                      spec:
                      - channels:
                        - slack-payments
                        - pagerduty-payments
                        matchType: at_least_once
                        name: critical
                        op: above
                        target: 0
                  description: Any panic log line emitted by the payments service
                  evaluation:
                    kind: rolling
                    spec:
                      evalWindow: 5m
                      frequency: 1m
                  labels:
                    severity: critical
                    team: payments
                  notificationSettings:
                    groupBy:
                    - k8s.pod.name
                    - deployment.environment
                    renotify:
                      alertStates:
                      - firing
                      enabled: true
                      interval: 15m
                  ruleType: threshold_rule
                  schemaVersion: v2alpha1
                  version: v5
              metric_anomaly:
                description: Anomaly rules are not yet supported under schemaVersion
                  v2alpha1, so this example uses the v1 shape. Wraps a builder query
                  in the `anomaly` function with daily seasonality SigNoz compares
                  each point against the forecast for that time of day. Fires when
                  the anomaly score stays below the threshold for the entire window;
                  `requireMinPoints` guards against noisy intervals.
                summary: Metric anomaly rule (v1 only)
                value:
                  alert: Anomalous drop in ingested spans
                  alertType: METRIC_BASED_ALERT
                  annotations:
                    description: Ingestion rate for tenant {{$tenant_id}} is anomalously
                      low (z-score {{$value}}).
                    summary: Span ingestion anomaly
                  condition:
                    algorithm: standard
                    compositeQuery:
                      panelType: graph
                      queries:
                      - spec:
                          aggregations:
                          - metricName: otelcol_receiver_accepted_spans
                            spaceAggregation: sum
                            timeAggregation: rate
                          filter:
                            expression: tenant_tier = 'premium'
                          functions:
                          - args:
                            - name: z_score_threshold
                              value: 2
                            name: anomaly
                          groupBy:
                          - fieldContext: attribute
                            fieldDataType: string
                            name: tenant_id
                          legend: '{{tenant_id}}'
                          name: A
                          signal: metrics
                          stepInterval: 21600
                        type: builder_query
                      queryType: builder
                    matchType: all_the_times
                    op: below
                    requireMinPoints: true
                    requiredNumPoints: 3
                    seasonality: daily
                    selectedQueryName: A
                    target: 2
                  description: Detect an abrupt drop in span ingestion using a z-score
                    anomaly function
                  evalWindow: 24h
                  frequency: 3h
                  labels:
                    severity: warning
                  preferredChannels:
                  - slack-ingestion
                  ruleType: anomaly_rule
                  version: v5
              metric_promql:
                description: PromQL expression instead of the builder. Dotted OTEL
                  resource attributes are quoted ("deployment.environment"). Useful
                  for queries that combine series with group_right or other Prom operators.
                summary: Metric threshold PromQL rule
                value:
                  alert: Kafka consumer group lag above 1000
                  alertType: METRIC_BASED_ALERT
                  annotations:
                    description: Consumer group {{$group}} is {{$value}} messages
                      behind on {{$topic}}/{{$partition}}.
                    summary: Kafka consumer lag high
                  condition:
                    compositeQuery:
                      panelType: graph
                      queries:
                      - spec:
                          legend: '{{topic}}/{{partition}} ({{group}})'
                          name: A
                          query: (max by(topic, partition, "deployment.environment")(kafka_log_end_offset)
                            - on(topic, partition, "deployment.environment") group_right
                            max by(group, topic, partition, "deployment.environment")(kafka_consumer_committed_offset))
                            > 0
                        type: promql
                      queryType: promql
                    selectedQueryName: A
                    thresholds:
                      kind: basic
                      spec:
                      - channels:
                        - slack-data-platform
                        - pagerduty-data
                        matchType: all_the_times
                        name: critical
                        op: above
                        target: 1000
                  description: Consumer group lag computed via PromQL
                  evaluation:
                    kind: rolling
                    spec:
                      evalWindow: 10m
                      frequency: 1m
                  labels:
                    severity: critical
                  notificationSettings:
                    groupBy:
                    - group
                    - topic
                    renotify:
                      alertStates:
                      - firing
                      enabled: true
                      interval: 1h
                  ruleType: promql_rule
                  schemaVersion: v2alpha1
                  version: v5
              metric_threshold_formula:
                description: Computes disk utilization as (1 - available/capacity)
                  * 100 by combining two disabled base queries with a builder_formula.
                  The formula emits 0–100, so compositeQuery.unit is set to "percent"
                  and the target is a bare number.
                summary: Metric threshold multi-query formula
                value:
                  alert: PersistentVolume above 80% utilization
                  alertType: METRIC_BASED_ALERT
                  annotations:
                    description: Volume {{$k8s.persistentvolumeclaim.name}} in {{$k8s.namespace.name}}
                      is {{$value}}% full.
                    summary: Disk utilization above {{$threshold}}%
                  condition:
                    compositeQuery:
                      panelType: graph
                      queries:
                      - spec:
                          aggregations:
                          - metricName: k8s.volume.available
                            spaceAggregation: max
                            timeAggregation: max
                          disabled: true
                          filter:
                            expression: k8s.volume.type = 'persistentVolumeClaim'
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: k8s.persistentvolumeclaim.name
                          - fieldContext: resource
                            fieldDataType: string
                            name: k8s.namespace.name
                          name: A
                          signal: metrics
                          stepInterval: 60
                        type: builder_query
                      - spec:
                          aggregations:
                          - metricName: k8s.volume.capacity
                            spaceAggregation: max
                            timeAggregation: max
                          disabled: true
                          filter:
                            expression: k8s.volume.type = 'persistentVolumeClaim'
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: k8s.persistentvolumeclaim.name
                          - fieldContext: resource
                            fieldDataType: string
                            name: k8s.namespace.name
                          name: B
                          signal: metrics
                          stepInterval: 60
                        type: builder_query
                      - spec:
                          expression: (1 - A/B) * 100
                          legend: '{{k8s.persistentvolumeclaim.name}} ({{k8s.namespace.name}})'
                          name: F1
                        type: builder_formula
                      queryType: builder
                      unit: percent
                    selectedQueryName: F1
                    thresholds:
                      kind: basic
                      spec:
                      - channels:
                        - slack-storage
                        matchType: at_least_once
                        name: critical
                        op: above
                        target: 80
                  description: Disk utilization for a persistent volume is above 80%
                  evaluation:
                    kind: rolling
                    spec:
                      evalWindow: 30m
                      frequency: 5m
                  labels:
                    severity: critical
                  notificationSettings:
                    groupBy:
                    - k8s.namespace.name
                    - k8s.persistentvolumeclaim.name
                    renotify:
                      alertStates:
                      - firing
                      enabled: true
                      interval: 2h
                  ruleType: threshold_rule
                  schemaVersion: v2alpha1
                  version: v5
              metric_threshold_single:
                description: Fires when a pod consumes more than 80% of its requested
                  CPU for the whole evaluation window. Uses `k8s.pod.cpu_request_utilization`.
                summary: Metric threshold single builder query
                value:
                  alert: Pod CPU above 80% of request
                  alertType: METRIC_BASED_ALERT
                  annotations:
                    description: Pod {{$k8s.pod.name}} CPU is at {{$value}} of request
                      in {{$deployment.environment}}.
                    summary: Pod CPU above {{$threshold}} of request
                  condition:
                    compositeQuery:
                      panelType: graph
                      queries:
                      - spec:
                          aggregations:
                          - metricName: k8s.pod.cpu_request_utilization
                            spaceAggregation: max
                            timeAggregation: avg
                          filter:
                            expression: k8s.deployment.name = 'api-service'
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: k8s.pod.name
                          - fieldContext: resource
                            fieldDataType: string
                            name: deployment.environment
                          legend: '{{k8s.pod.name}} ({{deployment.environment}})'
                          name: A
                          signal: metrics
                          stepInterval: 60
                        type: builder_query
                      queryType: builder
                      unit: percentunit
                    selectedQueryName: A
                    thresholds:
                      kind: basic
                      spec:
                      - channels:
                        - slack-platform
                        - pagerduty-oncall
                        matchType: all_the_times
                        name: critical
                        op: above
                        target: 0.8
                  description: CPU usage for api-service pods exceeds 80% of the requested
                    CPU
                  evaluation:
                    kind: rolling
                    spec:
                      evalWindow: 15m
                      frequency: 1m
                  labels:
                    severity: critical
                    team: platform
                  notificationSettings:
                    groupBy:
                    - k8s.pod.name
                    - deployment.environment
                    renotify:
                      alertStates:
                      - firing
                      enabled: true
                      interval: 4h
                  ruleType: threshold_rule
                  schemaVersion: v2alpha1
                  version: v5
              notification_settings:
                description: 'Demonstrates the full notificationSettings surface:
                  `groupBy` merges alerts across labels to cut noise, `newGroupEvalDelay`
                  gives newly-appearing series a grace period before firing, `renotify`
                  re-alerts every 30m while firing OR while the alert is in nodata
                  (missing data is treated as actionable), and `usePolicy: false`
                  means channels come from the threshold entries rather than global
                  routing policies. Set `usePolicy: true` to skip per-threshold channels
                  and route via the org-level notification policy instead.'
                summary: Full notification settings (grouping, nodata renotify, grace
                  period)
                value:
                  alert: API 5xx error rate above 1%
                  alertType: TRACES_BASED_ALERT
                  annotations:
                    description: '{{$service.name}} 5xx rate in {{$deployment.environment}}
                      is {{$value}}%.'
                    summary: API service error rate elevated
                  condition:
                    compositeQuery:
                      panelType: graph
                      queries:
                      - spec:
                          aggregations:
                          - expression: count()
                          disabled: true
                          filter:
                            expression: service.name CONTAINS 'api' AND http.status_code
                              >= 500
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: service.name
                          - fieldContext: resource
                            fieldDataType: string
                            name: deployment.environment
                          name: A
                          signal: traces
                          stepInterval: 60
                        type: builder_query
                      - spec:
                          aggregations:
                          - expression: count()
                          disabled: true
                          filter:
                            expression: service.name CONTAINS 'api'
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: service.name
                          - fieldContext: resource
                            fieldDataType: string
                            name: deployment.environment
                          name: B
                          signal: traces
                          stepInterval: 60
                        type: builder_query
                      - spec:
                          expression: (A / B) * 100
                          legend: '{{service.name}} ({{deployment.environment}})'
                          name: F1
                        type: builder_formula
                      queryType: builder
                      unit: percent
                    selectedQueryName: F1
                    thresholds:
                      kind: basic
                      spec:
                      - channels:
                        - slack-api-alerts
                        - pagerduty-oncall
                        matchType: at_least_once
                        name: critical
                        op: above
                        target: 1
                  description: Noise-controlled 5xx error rate alert with renotify
                    on gaps
                  evaluation:
                    kind: rolling
                    spec:
                      evalWindow: 5m
                      frequency: 1m
                  labels:
                    team: platform
                  notificationSettings:
                    groupBy:
                    - service.name
                    - deployment.environment
                    newGroupEvalDelay: 2m
                    renotify:
                      alertStates:
                      - firing
                      - nodata
                      enabled: true
                      interval: 30m
                    usePolicy: false
                  ruleType: threshold_rule
                  schemaVersion: v2alpha1
                  version: v5
              tiered_thresholds:
                description: Two tiers (warning and critical) in a single rule, each
                  with its own target, op, matchType, and channels so warnings and
                  pages route to different receivers. `alertOnAbsent` + `absentFor`
                  fires a no-data alert when the query returns no series for 15 consecutive
                  evaluations.
                summary: Tiered thresholds with per-tier channels
                value:
                  alert: Kafka consumer lag warn / critical
                  alertType: METRIC_BASED_ALERT
                  annotations:
                    description: Consumer lag for {{$topic}} partition {{$partition}}
                      is {{$value}}.
                    summary: Kafka consumer lag
                  condition:
                    absentFor: 15
                    alertOnAbsent: true
                    compositeQuery:
                      panelType: graph
                      queries:
                      - spec:
                          aggregations:
                          - metricName: kafka_log_end_offset
                            spaceAggregation: max
                            timeAggregation: max
                          disabled: true
                          filter:
                            expression: topic != '__consumer_offsets'
                          groupBy:
                          - fieldContext: attribute
                            fieldDataType: string
                            name: topic
                          - fieldContext: attribute
                            fieldDataType: string
                            name: partition
                          name: A
                          signal: metrics
                          stepInterval: 60
                        type: builder_query
                      - spec:
                          aggregations:
                          - metricName: kafka_consumer_committed_offset
                            spaceAggregation: max
                            timeAggregation: max
                          disabled: true
                          filter:
                            expression: topic != '__consumer_offsets'
                          groupBy:
                          - fieldContext: attribute
                            fieldDataType: string
                            name: topic
                          - fieldContext: attribute
                            fieldDataType: string
                            name: partition
                          name: B
                          signal: metrics
                          stepInterval: 60
                        type: builder_query
                      - spec:
                          expression: A - B
                          legend: '{{topic}}/{{partition}}'
                          name: F1
                        type: builder_formula
                      queryType: builder
                    selectedQueryName: F1
                    thresholds:
                      kind: basic
                      spec:
                      - channels:
                        - slack-kafka-info
                        matchType: all_the_times
                        name: warning
                        op: above
                        target: 50
                      - channels:
                        - slack-kafka-alerts
                        - pagerduty-kafka
                        matchType: all_the_times
                        name: critical
                        op: above
                        target: 200
                  description: Warn at lag ≥ 50 and page at ≥ 200, tiered via thresholds.spec.
                  evaluation:
                    kind: rolling
                    spec:
                      evalWindow: 5m
                      frequency: 1m
                  labels:
                    team: data-platform
                  notificationSettings:
                    groupBy:
                    - topic
                    renotify:
                      alertStates:
                      - firing
                      enabled: true
                      interval: 15m
                  ruleType: threshold_rule
                  schemaVersion: v2alpha1
                  version: v5
              traces_error_rate_formula:
                description: Two disabled trace count queries (A = error spans where
                  hasError=true, B = total spans) combined via a builder_formula into
                  a percentage. Mirrors the common request-error-rate dashboard shape.
                summary: Traces error rate error spans / total spans × 100
                value:
                  alert: Search-api error rate above 5%
                  alertType: TRACES_BASED_ALERT
                  annotations:
                    description: Error rate on {{$service.name}} {{$http.route}} is
                      {{$value}}%
                    summary: Search-api error rate above {{$threshold}}%
                  condition:
                    compositeQuery:
                      panelType: graph
                      queries:
                      - spec:
                          aggregations:
                          - expression: count()
                          disabled: true
                          filter:
                            expression: service.name = 'search-api' AND hasError =
                              true
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: service.name
                          - fieldContext: attribute
                            fieldDataType: string
                            name: http.route
                          name: A
                          signal: traces
                          stepInterval: 60
                        type: builder_query
                      - spec:
                          aggregations:
                          - expression: count()
                          disabled: true
                          filter:
                            expression: service.name = 'search-api'
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: service.name
                          - fieldContext: attribute
                            fieldDataType: string
                            name: http.route
                          name: B
                          signal: traces
                          stepInterval: 60
                        type: builder_query
                      - spec:
                          expression: (A / B) * 100
                          legend: '{{service.name}} {{http.route}}'
                          name: F1
                        type: builder_formula
                      queryType: builder
                      unit: percent
                    selectedQueryName: F1
                    thresholds:
                      kind: basic
                      spec:
                      - channels:
                        - slack-search
                        - pagerduty-search
                        matchType: at_least_once
                        name: critical
                        op: above
                        target: 5
                  description: Request error rate for search-api, grouped by route
                  evaluation:
                    kind: rolling
                    spec:
                      evalWindow: 5m
                      frequency: 1m
                  labels:
                    severity: critical
                    team: search
                  notificationSettings:
                    groupBy:
                    - service.name
                    - http.route
                    renotify:
                      alertStates:
                      - firing
                      enabled: true
                      interval: 15m
                  ruleType: threshold_rule
                  schemaVersion: v2alpha1
                  version: v5
              traces_threshold_latency:
                description: Builder query against the traces signal with p99(duration_nano).
                  The series unit is ns (compositeQuery.unit), the target is in seconds
                  (threshold.targetUnit) SigNoz converts before comparing. Canonical
                  shape when series and target live in different units.
                summary: Traces threshold p99 latency (ns → s conversion)
                value:
                  alert: Search API p99 latency above 5s
                  alertType: TRACES_BASED_ALERT
                  annotations:
                    description: p99 latency for {{$service.name}} on {{$http.route}}
                      crossed {{$threshold}}s.
                    summary: Search-api latency degraded
                  condition:
                    compositeQuery:
                      panelType: graph
                      queries:
                      - spec:
                          aggregations:
                          - expression: p99(duration_nano)
                          filter:
                            expression: service.name = 'search-api' AND name = 'GET
                              /api/v1/search'
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: service.name
                          - fieldContext: attribute
                            fieldDataType: string
                            name: http.route
                          legend: '{{service.name}} {{http.route}}'
                          name: A
                          signal: traces
                          stepInterval: 60
                        type: builder_query
                      queryType: builder
                      unit: ns
                    selectedQueryName: A
                    thresholds:
                      kind: basic
                      spec:
                      - channels:
                        - slack-search
                        matchType: at_least_once
                        name: warning
                        op: above
                        target: 5
                        targetUnit: s
                  description: p99 duration of the search endpoint exceeds 5s
                  evaluation:
                    kind: rolling
                    spec:
                      evalWindow: 5m
                      frequency: 1m
                  labels:
                    severity: warning
                    team: search
                  notificationSettings:
                    groupBy:
                    - service.name
                    - http.route
                    renotify:
                      alertStates:
                      - firing
                      enabled: true
                      interval: 30m
                  ruleType: threshold_rule
                  schemaVersion: v2alpha1
                  version: v5
            schema:
              $ref: '#/components/schemas/RuletypesPostableRule'
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - EDITOR
      - tokenizer:
        - EDITOR
      summary: Update alert rule
      tags:
      - rules
  /api/v2/rules/{id}/history/filter_keys:
    get:
      deprecated: false
      description: Returns distinct label keys from rule history entries for the selected
        range.
      operationId: GetRuleHistoryFilterKeys
      parameters:
      - in: query
        name: signal
        schema:
          $ref: '#/components/schemas/TelemetrytypesSignal'
      - in: query
        name: source
        schema:
          $ref: '#/components/schemas/TelemetrytypesSource'
      - in: query
        name: limit
        schema:
          type: integer
      - in: query
        name: startUnixMilli
        schema:
          format: int64
          type: integer
      - in: query
        name: endUnixMilli
        schema:
          format: int64
          type: integer
      - in: query
        name: fieldContext
        schema:
          $ref: '#/components/schemas/TelemetrytypesFieldContext'
      - in: query
        name: fieldDataType
        schema:
          $ref: '#/components/schemas/TelemetrytypesFieldDataType'
      - in: query
        name: metricName
        schema:
          type: string
      - in: query
        name: metricNamespace
        schema:
          type: string
      - in: query
        name: searchText
        schema:
          type: string
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/TelemetrytypesGettableFieldKeys'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - VIEWER
      - tokenizer:
        - VIEWER
      summary: Get rule history filter keys
      tags:
      - rules
  /api/v2/rules/{id}/history/filter_values:
    get:
      deprecated: false
      description: Returns distinct label values for a given key from rule history
        entries.
      operationId: GetRuleHistoryFilterValues
      parameters:
      - in: query
        name: signal
        schema:
          $ref: '#/components/schemas/TelemetrytypesSignal'
      - in: query
        name: source
        schema:
          $ref: '#/components/schemas/TelemetrytypesSource'
      - in: query
        name: limit
        schema:
          type: integer
      - in: query
        name: startUnixMilli
        schema:
          format: int64
          type: integer
      - in: query
        name: endUnixMilli
        schema:
          format: int64
          type: integer
      - in: query
        name: fieldContext
        schema:
          $ref: '#/components/schemas/TelemetrytypesFieldContext'
      - in: query
        name: fieldDataType
        schema:
          $ref: '#/components/schemas/TelemetrytypesFieldDataType'
      - in: query
        name: metricName
        schema:
          type: string
      - in: query
        name: metricNamespace
        schema:
          type: string
      - in: query
        name: searchText
        schema:
          type: string
      - in: query
        name: name
        schema:
          type: string
      - in: query
        name: existingQuery
        schema:
          type: string
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/TelemetrytypesGettableFieldValues'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - VIEWER
      - tokenizer:
        - VIEWER
      summary: Get rule history filter values
      tags:
      - rules
  /api/v2/rules/{id}/history/overall_status:
    get:
      deprecated: false
      description: Returns overall firing/inactive intervals for a rule in the selected
        time range.
      operationId: GetRuleHistoryOverallStatus
      parameters:
      - in: query
        name: start
        required: true
        schema:
          format: int64
          type: integer
      - in: query
        name: end
        required: true
        schema:
          format: int64
          type: integer
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/RulestatehistorytypesGettableRuleStateWindow'
                    nullable: true
                    type: array
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - VIEWER
      - tokenizer:
        - VIEWER
      summary: Get rule overall status timeline
      tags:
      - rules
  /api/v2/rules/{id}/history/stats:
    get:
      deprecated: false
      description: Returns trigger and resolution statistics for a rule in the selected
        time range.
      operationId: GetRuleHistoryStats
      parameters:
      - in: query
        name: start
        required: true
        schema:
          format: int64
          type: integer
      - in: query
        name: end
        required: true
        schema:
          format: int64
          type: integer
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/RulestatehistorytypesGettableRuleStateHistoryStats'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - VIEWER
      - tokenizer:
        - VIEWER
      summary: Get rule history stats
      tags:
      - rules
  /api/v2/rules/{id}/history/timeline:
    get:
      deprecated: false
      description: Returns paginated timeline entries for rule state transitions.
      operationId: GetRuleHistoryTimeline
      parameters:
      - in: query
        name: start
        required: true
        schema:
          format: int64
          type: integer
      - in: query
        name: end
        required: true
        schema:
          format: int64
          type: integer
      - in: query
        name: state
        schema:
          $ref: '#/components/schemas/RuletypesAlertState'
      - in: query
        name: filterExpression
        schema:
          type: string
      - in: query
        name: limit
        schema:
          format: int64
          type: integer
      - in: query
        name: order
        schema:
          $ref: '#/components/schemas/Querybuildertypesv5OrderDirection'
      - in: query
        name: cursor
        schema:
          type: string
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/RulestatehistorytypesGettableRuleStateTimeline'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - VIEWER
      - tokenizer:
        - VIEWER
      summary: Get rule history timeline
      tags:
      - rules
  /api/v2/rules/{id}/history/top_contributors:
    get:
      deprecated: false
      description: Returns top label combinations contributing to rule firing in the
        selected time range.
      operationId: GetRuleHistoryTopContributors
      parameters:
      - in: query
        name: start
        required: true
        schema:
          format: int64
          type: integer
      - in: query
        name: end
        required: true
        schema:
          format: int64
          type: integer
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/RulestatehistorytypesGettableRuleStateHistoryContributor'
                    nullable: true
                    type: array
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - VIEWER
      - tokenizer:
        - VIEWER
      summary: Get top contributors to rule firing
      tags:
      - rules
  /api/v2/rules/test:
    post:
      deprecated: false
      description: This endpoint fires a test notification for the given rule definition
      operationId: TestRule
      requestBody:
        content:
          application/json:
            examples:
              logs_error_rate_formula:
                description: Two disabled log count queries (A = errors, B = total)
                  combined via a builder_formula into a percentage. Classic service-level
                  error-rate alert pattern for log-based signals.
                summary: Logs error rate error count / total count × 100
                value:
                  alert: Payments-api error log rate above 1%
                  alertType: LOGS_BASED_ALERT
                  annotations:
                    description: Error log rate in {{$deployment.environment}} is
                      {{$value}}%
                    summary: Payments-api error rate above {{$threshold}}%
                  condition:
                    compositeQuery:
                      panelType: graph
                      queries:
                      - spec:
                          aggregations:
                          - expression: count()
                          disabled: true
                          filter:
                            expression: service.name = 'payments-api' AND severity_text
                              IN ['ERROR', 'FATAL']
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: deployment.environment
                          name: A
                          signal: logs
                          stepInterval: 60
                        type: builder_query
                      - spec:
                          aggregations:
                          - expression: count()
                          disabled: true
                          filter:
                            expression: service.name = 'payments-api'
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: deployment.environment
                          name: B
                          signal: logs
                          stepInterval: 60
                        type: builder_query
                      - spec:
                          expression: (A / B) * 100
                          legend: '{{deployment.environment}}'
                          name: F1
                        type: builder_formula
                      queryType: builder
                      unit: percent
                    selectedQueryName: F1
                    thresholds:
                      kind: basic
                      spec:
                      - channels:
                        - slack-payments
                        matchType: at_least_once
                        name: critical
                        op: above
                        target: 1
                  description: Error log ratio as a percentage of total logs for payments-api
                  evaluation:
                    kind: rolling
                    spec:
                      evalWindow: 5m
                      frequency: 1m
                  labels:
                    severity: critical
                    team: payments
                  notificationSettings:
                    groupBy:
                    - deployment.environment
                    renotify:
                      alertStates:
                      - firing
                      enabled: true
                      interval: 30m
                  ruleType: threshold_rule
                  schemaVersion: v2alpha1
                  version: v5
              logs_threshold:
                description: Counts matching log records (ERROR severity + body contains)
                  over a rolling window. Fires at least once per evaluation when the
                  count exceeds zero.
                summary: Logs threshold count() over filter
                value:
                  alert: Payments service panic logs
                  alertType: LOGS_BASED_ALERT
                  annotations:
                    description: '{{$k8s.pod.name}} emitted {{$value}} panic log(s)
                      in {{$deployment.environment}}.'
                    summary: Payments service panic
                  condition:
                    compositeQuery:
                      panelType: graph
                      queries:
                      - spec:
                          aggregations:
                          - expression: count()
                          filter:
                            expression: service.name = 'payments-api' AND severity_text
                              = 'ERROR' AND body CONTAINS 'panic'
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: k8s.pod.name
                          - fieldContext: resource
                            fieldDataType: string
                            name: deployment.environment
                          legend: '{{k8s.pod.name}} ({{deployment.environment}})'
                          name: A
                          signal: logs
                          stepInterval: 60
                        type: builder_query
                      queryType: builder
                    selectedQueryName: A
                    thresholds:
                      kind: basic
                      spec:
                      - channels:
                        - slack-payments
                        - pagerduty-payments
                        matchType: at_least_once
                        name: critical
                        op: above
                        target: 0
                  description: Any panic log line emitted by the payments service
                  evaluation:
                    kind: rolling
                    spec:
                      evalWindow: 5m
                      frequency: 1m
                  labels:
                    severity: critical
                    team: payments
                  notificationSettings:
                    groupBy:
                    - k8s.pod.name
                    - deployment.environment
                    renotify:
                      alertStates:
                      - firing
                      enabled: true
                      interval: 15m
                  ruleType: threshold_rule
                  schemaVersion: v2alpha1
                  version: v5
              metric_anomaly:
                description: Anomaly rules are not yet supported under schemaVersion
                  v2alpha1, so this example uses the v1 shape. Wraps a builder query
                  in the `anomaly` function with daily seasonality SigNoz compares
                  each point against the forecast for that time of day. Fires when
                  the anomaly score stays below the threshold for the entire window;
                  `requireMinPoints` guards against noisy intervals.
                summary: Metric anomaly rule (v1 only)
                value:
                  alert: Anomalous drop in ingested spans
                  alertType: METRIC_BASED_ALERT
                  annotations:
                    description: Ingestion rate for tenant {{$tenant_id}} is anomalously
                      low (z-score {{$value}}).
                    summary: Span ingestion anomaly
                  condition:
                    algorithm: standard
                    compositeQuery:
                      panelType: graph
                      queries:
                      - spec:
                          aggregations:
                          - metricName: otelcol_receiver_accepted_spans
                            spaceAggregation: sum
                            timeAggregation: rate
                          filter:
                            expression: tenant_tier = 'premium'
                          functions:
                          - args:
                            - name: z_score_threshold
                              value: 2
                            name: anomaly
                          groupBy:
                          - fieldContext: attribute
                            fieldDataType: string
                            name: tenant_id
                          legend: '{{tenant_id}}'
                          name: A
                          signal: metrics
                          stepInterval: 21600
                        type: builder_query
                      queryType: builder
                    matchType: all_the_times
                    op: below
                    requireMinPoints: true
                    requiredNumPoints: 3
                    seasonality: daily
                    selectedQueryName: A
                    target: 2
                  description: Detect an abrupt drop in span ingestion using a z-score
                    anomaly function
                  evalWindow: 24h
                  frequency: 3h
                  labels:
                    severity: warning
                  preferredChannels:
                  - slack-ingestion
                  ruleType: anomaly_rule
                  version: v5
              metric_promql:
                description: PromQL expression instead of the builder. Dotted OTEL
                  resource attributes are quoted ("deployment.environment"). Useful
                  for queries that combine series with group_right or other Prom operators.
                summary: Metric threshold PromQL rule
                value:
                  alert: Kafka consumer group lag above 1000
                  alertType: METRIC_BASED_ALERT
                  annotations:
                    description: Consumer group {{$group}} is {{$value}} messages
                      behind on {{$topic}}/{{$partition}}.
                    summary: Kafka consumer lag high
                  condition:
                    compositeQuery:
                      panelType: graph
                      queries:
                      - spec:
                          legend: '{{topic}}/{{partition}} ({{group}})'
                          name: A
                          query: (max by(topic, partition, "deployment.environment")(kafka_log_end_offset)
                            - on(topic, partition, "deployment.environment") group_right
                            max by(group, topic, partition, "deployment.environment")(kafka_consumer_committed_offset))
                            > 0
                        type: promql
                      queryType: promql
                    selectedQueryName: A
                    thresholds:
                      kind: basic
                      spec:
                      - channels:
                        - slack-data-platform
                        - pagerduty-data
                        matchType: all_the_times
                        name: critical
                        op: above
                        target: 1000
                  description: Consumer group lag computed via PromQL
                  evaluation:
                    kind: rolling
                    spec:
                      evalWindow: 10m
                      frequency: 1m
                  labels:
                    severity: critical
                  notificationSettings:
                    groupBy:
                    - group
                    - topic
                    renotify:
                      alertStates:
                      - firing
                      enabled: true
                      interval: 1h
                  ruleType: promql_rule
                  schemaVersion: v2alpha1
                  version: v5
              metric_threshold_formula:
                description: Computes disk utilization as (1 - available/capacity)
                  * 100 by combining two disabled base queries with a builder_formula.
                  The formula emits 0–100, so compositeQuery.unit is set to "percent"
                  and the target is a bare number.
                summary: Metric threshold multi-query formula
                value:
                  alert: PersistentVolume above 80% utilization
                  alertType: METRIC_BASED_ALERT
                  annotations:
                    description: Volume {{$k8s.persistentvolumeclaim.name}} in {{$k8s.namespace.name}}
                      is {{$value}}% full.
                    summary: Disk utilization above {{$threshold}}%
                  condition:
                    compositeQuery:
                      panelType: graph
                      queries:
                      - spec:
                          aggregations:
                          - metricName: k8s.volume.available
                            spaceAggregation: max
                            timeAggregation: max
                          disabled: true
                          filter:
                            expression: k8s.volume.type = 'persistentVolumeClaim'
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: k8s.persistentvolumeclaim.name
                          - fieldContext: resource
                            fieldDataType: string
                            name: k8s.namespace.name
                          name: A
                          signal: metrics
                          stepInterval: 60
                        type: builder_query
                      - spec:
                          aggregations:
                          - metricName: k8s.volume.capacity
                            spaceAggregation: max
                            timeAggregation: max
                          disabled: true
                          filter:
                            expression: k8s.volume.type = 'persistentVolumeClaim'
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: k8s.persistentvolumeclaim.name
                          - fieldContext: resource
                            fieldDataType: string
                            name: k8s.namespace.name
                          name: B
                          signal: metrics
                          stepInterval: 60
                        type: builder_query
                      - spec:
                          expression: (1 - A/B) * 100
                          legend: '{{k8s.persistentvolumeclaim.name}} ({{k8s.namespace.name}})'
                          name: F1
                        type: builder_formula
                      queryType: builder
                      unit: percent
                    selectedQueryName: F1
                    thresholds:
                      kind: basic
                      spec:
                      - channels:
                        - slack-storage
                        matchType: at_least_once
                        name: critical
                        op: above
                        target: 80
                  description: Disk utilization for a persistent volume is above 80%
                  evaluation:
                    kind: rolling
                    spec:
                      evalWindow: 30m
                      frequency: 5m
                  labels:
                    severity: critical
                  notificationSettings:
                    groupBy:
                    - k8s.namespace.name
                    - k8s.persistentvolumeclaim.name
                    renotify:
                      alertStates:
                      - firing
                      enabled: true
                      interval: 2h
                  ruleType: threshold_rule
                  schemaVersion: v2alpha1
                  version: v5
              metric_threshold_single:
                description: Fires when a pod consumes more than 80% of its requested
                  CPU for the whole evaluation window. Uses `k8s.pod.cpu_request_utilization`.
                summary: Metric threshold single builder query
                value:
                  alert: Pod CPU above 80% of request
                  alertType: METRIC_BASED_ALERT
                  annotations:
                    description: Pod {{$k8s.pod.name}} CPU is at {{$value}} of request
                      in {{$deployment.environment}}.
                    summary: Pod CPU above {{$threshold}} of request
                  condition:
                    compositeQuery:
                      panelType: graph
                      queries:
                      - spec:
                          aggregations:
                          - metricName: k8s.pod.cpu_request_utilization
                            spaceAggregation: max
                            timeAggregation: avg
                          filter:
                            expression: k8s.deployment.name = 'api-service'
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: k8s.pod.name
                          - fieldContext: resource
                            fieldDataType: string
                            name: deployment.environment
                          legend: '{{k8s.pod.name}} ({{deployment.environment}})'
                          name: A
                          signal: metrics
                          stepInterval: 60
                        type: builder_query
                      queryType: builder
                      unit: percentunit
                    selectedQueryName: A
                    thresholds:
                      kind: basic
                      spec:
                      - channels:
                        - slack-platform
                        - pagerduty-oncall
                        matchType: all_the_times
                        name: critical
                        op: above
                        target: 0.8
                  description: CPU usage for api-service pods exceeds 80% of the requested
                    CPU
                  evaluation:
                    kind: rolling
                    spec:
                      evalWindow: 15m
                      frequency: 1m
                  labels:
                    severity: critical
                    team: platform
                  notificationSettings:
                    groupBy:
                    - k8s.pod.name
                    - deployment.environment
                    renotify:
                      alertStates:
                      - firing
                      enabled: true
                      interval: 4h
                  ruleType: threshold_rule
                  schemaVersion: v2alpha1
                  version: v5
              notification_settings:
                description: 'Demonstrates the full notificationSettings surface:
                  `groupBy` merges alerts across labels to cut noise, `newGroupEvalDelay`
                  gives newly-appearing series a grace period before firing, `renotify`
                  re-alerts every 30m while firing OR while the alert is in nodata
                  (missing data is treated as actionable), and `usePolicy: false`
                  means channels come from the threshold entries rather than global
                  routing policies. Set `usePolicy: true` to skip per-threshold channels
                  and route via the org-level notification policy instead.'
                summary: Full notification settings (grouping, nodata renotify, grace
                  period)
                value:
                  alert: API 5xx error rate above 1%
                  alertType: TRACES_BASED_ALERT
                  annotations:
                    description: '{{$service.name}} 5xx rate in {{$deployment.environment}}
                      is {{$value}}%.'
                    summary: API service error rate elevated
                  condition:
                    compositeQuery:
                      panelType: graph
                      queries:
                      - spec:
                          aggregations:
                          - expression: count()
                          disabled: true
                          filter:
                            expression: service.name CONTAINS 'api' AND http.status_code
                              >= 500
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: service.name
                          - fieldContext: resource
                            fieldDataType: string
                            name: deployment.environment
                          name: A
                          signal: traces
                          stepInterval: 60
                        type: builder_query
                      - spec:
                          aggregations:
                          - expression: count()
                          disabled: true
                          filter:
                            expression: service.name CONTAINS 'api'
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: service.name
                          - fieldContext: resource
                            fieldDataType: string
                            name: deployment.environment
                          name: B
                          signal: traces
                          stepInterval: 60
                        type: builder_query
                      - spec:
                          expression: (A / B) * 100
                          legend: '{{service.name}} ({{deployment.environment}})'
                          name: F1
                        type: builder_formula
                      queryType: builder
                      unit: percent
                    selectedQueryName: F1
                    thresholds:
                      kind: basic
                      spec:
                      - channels:
                        - slack-api-alerts
                        - pagerduty-oncall
                        matchType: at_least_once
                        name: critical
                        op: above
                        target: 1
                  description: Noise-controlled 5xx error rate alert with renotify
                    on gaps
                  evaluation:
                    kind: rolling
                    spec:
                      evalWindow: 5m
                      frequency: 1m
                  labels:
                    team: platform
                  notificationSettings:
                    groupBy:
                    - service.name
                    - deployment.environment
                    newGroupEvalDelay: 2m
                    renotify:
                      alertStates:
                      - firing
                      - nodata
                      enabled: true
                      interval: 30m
                    usePolicy: false
                  ruleType: threshold_rule
                  schemaVersion: v2alpha1
                  version: v5
              tiered_thresholds:
                description: Two tiers (warning and critical) in a single rule, each
                  with its own target, op, matchType, and channels so warnings and
                  pages route to different receivers. `alertOnAbsent` + `absentFor`
                  fires a no-data alert when the query returns no series for 15 consecutive
                  evaluations.
                summary: Tiered thresholds with per-tier channels
                value:
                  alert: Kafka consumer lag warn / critical
                  alertType: METRIC_BASED_ALERT
                  annotations:
                    description: Consumer lag for {{$topic}} partition {{$partition}}
                      is {{$value}}.
                    summary: Kafka consumer lag
                  condition:
                    absentFor: 15
                    alertOnAbsent: true
                    compositeQuery:
                      panelType: graph
                      queries:
                      - spec:
                          aggregations:
                          - metricName: kafka_log_end_offset
                            spaceAggregation: max
                            timeAggregation: max
                          disabled: true
                          filter:
                            expression: topic != '__consumer_offsets'
                          groupBy:
                          - fieldContext: attribute
                            fieldDataType: string
                            name: topic
                          - fieldContext: attribute
                            fieldDataType: string
                            name: partition
                          name: A
                          signal: metrics
                          stepInterval: 60
                        type: builder_query
                      - spec:
                          aggregations:
                          - metricName: kafka_consumer_committed_offset
                            spaceAggregation: max
                            timeAggregation: max
                          disabled: true
                          filter:
                            expression: topic != '__consumer_offsets'
                          groupBy:
                          - fieldContext: attribute
                            fieldDataType: string
                            name: topic
                          - fieldContext: attribute
                            fieldDataType: string
                            name: partition
                          name: B
                          signal: metrics
                          stepInterval: 60
                        type: builder_query
                      - spec:
                          expression: A - B
                          legend: '{{topic}}/{{partition}}'
                          name: F1
                        type: builder_formula
                      queryType: builder
                    selectedQueryName: F1
                    thresholds:
                      kind: basic
                      spec:
                      - channels:
                        - slack-kafka-info
                        matchType: all_the_times
                        name: warning
                        op: above
                        target: 50
                      - channels:
                        - slack-kafka-alerts
                        - pagerduty-kafka
                        matchType: all_the_times
                        name: critical
                        op: above
                        target: 200
                  description: Warn at lag ≥ 50 and page at ≥ 200, tiered via thresholds.spec.
                  evaluation:
                    kind: rolling
                    spec:
                      evalWindow: 5m
                      frequency: 1m
                  labels:
                    team: data-platform
                  notificationSettings:
                    groupBy:
                    - topic
                    renotify:
                      alertStates:
                      - firing
                      enabled: true
                      interval: 15m
                  ruleType: threshold_rule
                  schemaVersion: v2alpha1
                  version: v5
              traces_error_rate_formula:
                description: Two disabled trace count queries (A = error spans where
                  hasError=true, B = total spans) combined via a builder_formula into
                  a percentage. Mirrors the common request-error-rate dashboard shape.
                summary: Traces error rate error spans / total spans × 100
                value:
                  alert: Search-api error rate above 5%
                  alertType: TRACES_BASED_ALERT
                  annotations:
                    description: Error rate on {{$service.name}} {{$http.route}} is
                      {{$value}}%
                    summary: Search-api error rate above {{$threshold}}%
                  condition:
                    compositeQuery:
                      panelType: graph
                      queries:
                      - spec:
                          aggregations:
                          - expression: count()
                          disabled: true
                          filter:
                            expression: service.name = 'search-api' AND hasError =
                              true
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: service.name
                          - fieldContext: attribute
                            fieldDataType: string
                            name: http.route
                          name: A
                          signal: traces
                          stepInterval: 60
                        type: builder_query
                      - spec:
                          aggregations:
                          - expression: count()
                          disabled: true
                          filter:
                            expression: service.name = 'search-api'
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: service.name
                          - fieldContext: attribute
                            fieldDataType: string
                            name: http.route
                          name: B
                          signal: traces
                          stepInterval: 60
                        type: builder_query
                      - spec:
                          expression: (A / B) * 100
                          legend: '{{service.name}} {{http.route}}'
                          name: F1
                        type: builder_formula
                      queryType: builder
                      unit: percent
                    selectedQueryName: F1
                    thresholds:
                      kind: basic
                      spec:
                      - channels:
                        - slack-search
                        - pagerduty-search
                        matchType: at_least_once
                        name: critical
                        op: above
                        target: 5
                  description: Request error rate for search-api, grouped by route
                  evaluation:
                    kind: rolling
                    spec:
                      evalWindow: 5m
                      frequency: 1m
                  labels:
                    severity: critical
                    team: search
                  notificationSettings:
                    groupBy:
                    - service.name
                    - http.route
                    renotify:
                      alertStates:
                      - firing
                      enabled: true
                      interval: 15m
                  ruleType: threshold_rule
                  schemaVersion: v2alpha1
                  version: v5
              traces_threshold_latency:
                description: Builder query against the traces signal with p99(duration_nano).
                  The series unit is ns (compositeQuery.unit), the target is in seconds
                  (threshold.targetUnit) SigNoz converts before comparing. Canonical
                  shape when series and target live in different units.
                summary: Traces threshold p99 latency (ns → s conversion)
                value:
                  alert: Search API p99 latency above 5s
                  alertType: TRACES_BASED_ALERT
                  annotations:
                    description: p99 latency for {{$service.name}} on {{$http.route}}
                      crossed {{$threshold}}s.
                    summary: Search-api latency degraded
                  condition:
                    compositeQuery:
                      panelType: graph
                      queries:
                      - spec:
                          aggregations:
                          - expression: p99(duration_nano)
                          filter:
                            expression: service.name = 'search-api' AND name = 'GET
                              /api/v1/search'
                          groupBy:
                          - fieldContext: resource
                            fieldDataType: string
                            name: service.name
                          - fieldContext: attribute
                            fieldDataType: string
                            name: http.route
                          legend: '{{service.name}} {{http.route}}'
                          name: A
                          signal: traces
                          stepInterval: 60
                        type: builder_query
                      queryType: builder
                      unit: ns
                    selectedQueryName: A
                    thresholds:
                      kind: basic
                      spec:
                      - channels:
                        - slack-search
                        matchType: at_least_once
                        name: warning
                        op: above
                        target: 5
                        targetUnit: s
                  description: p99 duration of the search endpoint exceeds 5s
                  evaluation:
                    kind: rolling
                    spec:
                      evalWindow: 5m
                      frequency: 1m
                  labels:
                    severity: warning
                    team: search
                  notificationSettings:
                    groupBy:
                    - service.name
                    - http.route
                    renotify:
                      alertStates:
                      - firing
                      enabled: true
                      interval: 30m
                  ruleType: threshold_rule
                  schemaVersion: v2alpha1
                  version: v5
            schema:
              $ref: '#/components/schemas/RuletypesPostableRule'
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/RuletypesGettableTestRule'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - EDITOR
      - tokenizer:
        - EDITOR
      summary: Test alert rule
      tags:
      - rules
  /api/v2/sessions:
    delete:
      deprecated: false
      description: This endpoint deletes the session
      operationId: DeleteSession
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - tokenizer: []
      summary: Delete session
      tags:
      - sessions
  /api/v2/sessions/context:
    get:
      deprecated: false
      description: This endpoint returns the context for the session
      operationId: GetSessionContext
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/AuthtypesSessionContext'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      summary: Get session context
      tags:
      - sessions
  /api/v2/sessions/email_password:
    post:
      deprecated: false
      description: This endpoint creates a session for a user using email and password.
      operationId: CreateSessionByEmailPassword
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthtypesPostableEmailPasswordSession'
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/AuthtypesGettableToken'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      summary: Create session by email and password
      tags:
      - sessions
  /api/v2/sessions/rotate:
    post:
      deprecated: false
      description: This endpoint rotates the session
      operationId: RotateSession
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthtypesPostableRotateToken'
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/AuthtypesGettableToken'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      summary: Rotate session
      tags:
      - sessions
  /api/v2/users:
    get:
      deprecated: false
      description: This endpoint lists all users for the organization
      operationId: ListUsers
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/TypesUser'
                    type: array
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: List users v2
      tags:
      - users
  /api/v2/users/{id}:
    get:
      deprecated: false
      description: This endpoint returns the user by id
      operationId: GetUser
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/AuthtypesUserWithRoles'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Get user by user id
      tags:
      - users
    put:
      deprecated: false
      description: This endpoint updates the user by id
      operationId: UpdateUser
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TypesUpdatableUser'
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Update user v2
      tags:
      - users
  /api/v2/users/{id}/reset_password_tokens:
    get:
      deprecated: false
      description: This endpoint returns the existing reset password token for a user.
      operationId: GetResetPasswordToken
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/TypesResetPasswordToken'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Get reset password token for a user
      tags:
      - users
    put:
      deprecated: false
      description: This endpoint creates or regenerates a reset password token for
        a user. If a valid token exists, it is returned. If expired, a new one is
        created.
      operationId: CreateResetPasswordToken
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        "201":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/TypesResetPasswordToken'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: Created
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Create or regenerate reset password token for a user
      tags:
      - users
  /api/v2/users/{id}/roles:
    get:
      deprecated: false
      description: This endpoint returns the user roles by user id
      operationId: GetRolesByUserID
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/AuthtypesRole'
                    type: array
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Get user roles
      tags:
      - users
    post:
      deprecated: false
      description: This endpoint assigns the role to the user roles by user id
      operationId: SetRoleByUserID
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TypesPostableRole'
      responses:
        "200":
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Set user roles
      tags:
      - users
  /api/v2/users/{id}/roles/{roleId}:
    delete:
      deprecated: false
      description: This endpoint removes a role from the user by user id and role
        id
      operationId: RemoveUserRoleByUserIDAndRoleID
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      - in: path
        name: roleId
        required: true
        schema:
          type: string
      responses:
        "204":
          description: No Content
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Remove a role from user
      tags:
      - users
  /api/v2/users/me:
    get:
      deprecated: false
      description: This endpoint returns the user I belong to
      operationId: GetMyUser
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/AuthtypesUserWithRoles'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - tokenizer: []
      summary: Get my user v2
      tags:
      - users
    put:
      deprecated: false
      description: This endpoint updates the user I belong to
      operationId: UpdateMyUserV2
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TypesUpdatableUser'
      responses:
        "204":
          description: No Content
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - tokenizer: []
      summary: Update my user v2
      tags:
      - users
  /api/v2/users/me/factor_password:
    put:
      deprecated: false
      description: This endpoint updates the password of the user I belong to
      operationId: UpdateMyPassword
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TypesChangePasswordRequest'
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Updates my password
      tags:
      - users
  /api/v2/zeus/hosts:
    get:
      deprecated: false
      description: This endpoint gets the host info from zeus.
      operationId: GetHosts
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/ZeustypesGettableHost'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Get host info from Zeus.
      tags:
      - zeus
    put:
      deprecated: false
      description: This endpoint saves the host of a deployment to zeus.
      operationId: PutHost
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ZeustypesPostableHost'
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Conflict
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Put host in Zeus for a deployment.
      tags:
      - zeus
  /api/v2/zeus/profiles:
    put:
      deprecated: false
      description: This endpoint saves the profile of a deployment to zeus.
      operationId: PutProfile
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ZeustypesPostableProfile'
      responses:
        "204":
          description: No Content
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "409":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Conflict
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - ADMIN
      - tokenizer:
        - ADMIN
      summary: Put profile in Zeus for a deployment.
      tags:
      - zeus
  /api/v3/traces/{traceID}/waterfall:
    post:
      deprecated: false
      description: Returns the waterfall view of spans for a given trace ID with tree
        structure, metadata, and windowed pagination
      operationId: GetWaterfall
      parameters:
      - in: path
        name: traceID
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TracedetailtypesPostableWaterfall'
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/TracedetailtypesGettableWaterfallTrace'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "404":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Not Found
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - VIEWER
      - tokenizer:
        - VIEWER
      summary: Get waterfall view for a trace
      tags:
      - tracedetail
  /api/v5/query_range:
    post:
      deprecated: false
      description: Execute a composite query over a time range. Supports builder queries
        (traces, logs, metrics), formulas, trace operators, PromQL, and ClickHouse
        SQL.
      operationId: QueryRangeV5
      requestBody:
        content:
          application/json:
            examples:
              clickhouse_sql_logs_raw:
                summary: 'ClickHouse SQL: raw logs with resource filter'
                value:
                  compositeQuery:
                    queries:
                    - spec:
                        name: recent_errors
                        query: WITH __resource_filter AS ( SELECT fingerprint FROM
                          signoz_logs.distributed_logs_v2_resource WHERE seen_at_ts_bucket_start
                          >= $start_timestamp - 1800 AND seen_at_ts_bucket_start <=
                          $end_timestamp ) SELECT timestamp, body FROM signoz_logs.distributed_logs_v2
                          WHERE resource_fingerprint GLOBAL IN (SELECT fingerprint
                          FROM __resource_filter) AND timestamp >= $start_timestamp_nano
                          AND timestamp <= $end_timestamp_nano AND ts_bucket_start
                          >= $start_timestamp - 1800 AND ts_bucket_start <= $end_timestamp
                          AND severity_text = 'ERROR' ORDER BY timestamp DESC LIMIT
                          100
                      type: clickhouse_sql
                  end: 1640998800000
                  requestType: raw
                  schemaVersion: v1
                  start: 1640995200000
              clickhouse_sql_traces_scalar:
                summary: 'ClickHouse SQL: scalar aggregate with resource filter'
                value:
                  compositeQuery:
                    queries:
                    - spec:
                        name: total_spans
                        query: WITH __resource_filter AS ( SELECT fingerprint FROM
                          signoz_traces.distributed_traces_v3_resource WHERE seen_at_ts_bucket_start
                          >= $start_timestamp - 1800 AND seen_at_ts_bucket_start <=
                          $end_timestamp ) SELECT count() AS value FROM signoz_traces.distributed_signoz_index_v3
                          WHERE resource_fingerprint GLOBAL IN (SELECT fingerprint
                          FROM __resource_filter) AND timestamp >= $start_datetime
                          AND timestamp <= $end_datetime AND ts_bucket_start >= $start_timestamp
                          - 1800 AND ts_bucket_start <= $end_timestamp
                      type: clickhouse_sql
                  end: 1640998800000
                  requestType: scalar
                  schemaVersion: v1
                  start: 1640995200000
              clickhouse_sql_traces_time_series:
                summary: 'ClickHouse SQL: traces time series with resource filter'
                value:
                  compositeQuery:
                    queries:
                    - spec:
                        name: span_rate
                        query: WITH __resource_filter AS ( SELECT fingerprint FROM
                          signoz_traces.distributed_traces_v3_resource WHERE seen_at_ts_bucket_start
                          >= $start_timestamp - 1800 AND seen_at_ts_bucket_start <=
                          $end_timestamp ) SELECT toStartOfInterval(timestamp, INTERVAL
                          60 SECOND) AS ts, count() AS value FROM signoz_traces.distributed_signoz_index_v3
                          WHERE resource_fingerprint GLOBAL IN (SELECT fingerprint
                          FROM __resource_filter) AND timestamp >= $start_datetime
                          AND timestamp <= $end_datetime AND ts_bucket_start >= $start_timestamp
                          - 1800 AND ts_bucket_start <= $end_timestamp GROUP BY ts
                          ORDER BY ts
                      type: clickhouse_sql
                  end: 1640998800000
                  requestType: time_series
                  schemaVersion: v1
                  start: 1640995200000
              formula:
                summary: 'Formula: error rate from two trace queries'
                value:
                  compositeQuery:
                    queries:
                    - spec:
                        aggregations:
                        - expression: countIf(has_error = true)
                        groupBy:
                        - fieldContext: resource
                          name: service.name
                        name: A
                        signal: traces
                        stepInterval: 60s
                      type: builder_query
                    - spec:
                        aggregations:
                        - expression: count()
                        groupBy:
                        - fieldContext: resource
                          name: service.name
                        name: B
                        signal: traces
                        stepInterval: 60s
                      type: builder_query
                    - spec:
                        expression: A / B * 100
                        name: error_rate
                      type: builder_formula
                  end: 1640998800000
                  requestType: time_series
                  schemaVersion: v1
                  start: 1640995200000
              logs_raw:
                summary: 'Raw: fetch raw log records'
                value:
                  compositeQuery:
                    queries:
                    - spec:
                        filter:
                          expression: severity_text = 'ERROR'
                        limit: 50
                        name: A
                        offset: 0
                        order:
                        - direction: desc
                          key:
                            fieldContext: log
                            name: timestamp
                        - direction: desc
                          key:
                            name: id
                        selectFields:
                        - fieldContext: log
                          name: body
                        - fieldContext: resource
                          name: service.name
                        signal: logs
                      type: builder_query
                  end: 1640998800000
                  requestType: raw
                  schemaVersion: v1
                  start: 1640995200000
              logs_scalar:
                summary: 'Scalar: total error log count'
                value:
                  compositeQuery:
                    queries:
                    - spec:
                        aggregations:
                        - alias: error_count
                          expression: count()
                        filter:
                          expression: severity_text = 'ERROR'
                        name: A
                        signal: logs
                      type: builder_query
                  end: 1640998800000
                  requestType: scalar
                  schemaVersion: v1
                  start: 1640995200000
              logs_time_series:
                summary: 'Time series: count error logs grouped by service'
                value:
                  compositeQuery:
                    queries:
                    - spec:
                        aggregations:
                        - alias: log_count
                          expression: count()
                        filter:
                          expression: severity_text = 'ERROR'
                        groupBy:
                        - fieldContext: resource
                          name: service.name
                        limit: 10
                        name: A
                        order:
                        - direction: desc
                          key:
                            name: log_count
                        signal: logs
                        stepInterval: 60s
                      type: builder_query
                  end: 1640998800000
                  requestType: time_series
                  schemaVersion: v1
                  start: 1640995200000
              metrics_gauge_time_series:
                summary: 'Time series: latest gauge value averaged across series'
                value:
                  compositeQuery:
                    queries:
                    - spec:
                        aggregations:
                        - metricName: system.cpu.utilization
                          spaceAggregation: avg
                          timeAggregation: latest
                        groupBy:
                        - fieldContext: resource
                          name: host.name
                        name: A
                        signal: metrics
                        stepInterval: 60s
                      type: builder_query
                  end: 1640998800000
                  requestType: time_series
                  schemaVersion: v1
                  start: 1640995200000
              metrics_histogram_time_series:
                summary: 'Time series: p99 latency from histogram'
                value:
                  compositeQuery:
                    queries:
                    - spec:
                        aggregations:
                        - metricName: http.server.duration.bucket
                          spaceAggregation: p99
                        groupBy:
                        - fieldContext: resource
                          name: service.name
                        name: A
                        signal: metrics
                        stepInterval: 60s
                      type: builder_query
                  end: 1640998800000
                  requestType: time_series
                  schemaVersion: v1
                  start: 1640995200000
              metrics_rate_time_series:
                summary: 'Time series: rate of cumulative counter'
                value:
                  compositeQuery:
                    queries:
                    - spec:
                        aggregations:
                        - metricName: http.server.duration.count
                          spaceAggregation: sum
                          timeAggregation: rate
                        groupBy:
                        - fieldContext: resource
                          name: service.name
                        name: A
                        signal: metrics
                        stepInterval: 120
                      type: builder_query
                  end: 1640998800000
                  requestType: time_series
                  schemaVersion: v1
                  start: 1640995200000
              metrics_scalar:
                summary: 'Scalar: single reduced metric value'
                value:
                  compositeQuery:
                    queries:
                    - spec:
                        aggregations:
                        - metricName: http.server.duration.count
                          reduceTo: sum
                          spaceAggregation: sum
                          timeAggregation: rate
                        name: A
                        signal: metrics
                        stepInterval: 60s
                      type: builder_query
                  end: 1640998800000
                  requestType: scalar
                  schemaVersion: v1
                  start: 1640995200000
              promql:
                summary: 'PromQL: request rate with UTF-8 metric name'
                value:
                  compositeQuery:
                    queries:
                    - spec:
                        name: request_rate
                        query: sum(rate({"http.server.duration.count"}[5m])) by ("service.name")
                        step: 60
                      type: promql
                  end: 1640998800000
                  requestType: time_series
                  schemaVersion: v1
                  start: 1640995200000
              traces_raw:
                summary: 'Raw: fetch raw span records'
                value:
                  compositeQuery:
                    queries:
                    - spec:
                        filter:
                          expression: service.name = 'frontend' AND has_error = true
                        limit: 100
                        name: A
                        order:
                        - direction: desc
                          key:
                            fieldContext: span
                            name: timestamp
                        selectFields:
                        - fieldContext: span
                          name: name
                        - fieldContext: span
                          name: duration_nano
                        signal: traces
                      type: builder_query
                  end: 1640998800000
                  requestType: raw
                  schemaVersion: v1
                  start: 1640995200000
              traces_scalar:
                summary: 'Scalar: total span count'
                value:
                  compositeQuery:
                    queries:
                    - spec:
                        aggregations:
                        - alias: span_count
                          expression: count()
                        filter:
                          expression: service.name = 'frontend'
                        name: A
                        signal: traces
                      type: builder_query
                  end: 1640998800000
                  requestType: scalar
                  schemaVersion: v1
                  start: 1640995200000
              traces_time_series:
                summary: 'Time series: count spans grouped by service'
                value:
                  compositeQuery:
                    queries:
                    - spec:
                        aggregations:
                        - alias: span_count
                          expression: count()
                        filter:
                          expression: service.name = 'frontend'
                        groupBy:
                        - fieldContext: resource
                          name: service.name
                        limit: 10
                        name: A
                        order:
                        - direction: desc
                          key:
                            name: span_count
                        signal: traces
                        stepInterval: 60s
                      type: builder_query
                  end: 1640998800000
                  requestType: time_series
                  schemaVersion: v1
                  start: 1640995200000
            schema:
              $ref: '#/components/schemas/Querybuildertypesv5QueryRangeRequest'
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/Querybuildertypesv5QueryRangeResponse'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - VIEWER
      - tokenizer:
        - VIEWER
      summary: Query range
      tags:
      - querier
  /api/v5/substitute_vars:
    post:
      deprecated: false
      description: Replace variables in a query
      operationId: ReplaceVariables
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Querybuildertypesv5QueryRangeRequest'
      responses:
        "200":
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/Querybuildertypesv5QueryRangeRequest'
                  status:
                    type: string
                required:
                - status
                - data
                type: object
          description: OK
        "400":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Bad Request
        "401":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Unauthorized
        "403":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Forbidden
        "500":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RenderErrorResponse'
          description: Internal Server Error
      security:
      - api_key:
        - VIEWER
      - tokenizer:
        - VIEWER
      summary: Replace variables
      tags:
      - querier