Skip to main content
ZStack
Monitoring & Collection/Logging

CreateFilteredTailSession

Create a live-tail session with a compound multi-criteria filter

POST/api/v1/logs/tail/filtered-sessions

Operation ID

CreateFilteredTailSession

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

  • tenantId
    StringRequired

    Tenant identifier for quota enforcement and session ownership

    Example: tenant-xyz

  • userUuid
    StringRequired

    UUID of the user creating this filtered session

    Example: user-001-abc

  • filter
    ObjectRequired

    Filter for this resource

    • includeKeywords
      List

      Include keywords

      Example: item1,item2

    • excludeKeywords
      List

      Exclude keywords

      Example: item1,item2

    • regex
      String

      Regular expression pattern to match against log message content

      Example: error.*timeout

    • logLevelMin
      String

      Minimum log level to include; entries below this level are excluded

      Example: warn

    • serviceFilter
      String

      Service name filter to restrict matching to a specific service

      Example: payment-service

  • service
    StringRequired

    Service name to restrict the tail stream to

    Example: order-service

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • sessionId
    String

    Unique identifier of this filtered live-tail session

    Example: fsession-001

  • tenantId
    String

    Tenant identifier that owns this session

    Example: tenant-xyz

  • userUuid
    String

    UUID of the user who created this session

    Example: user-001-abc

  • filter
    Object

    Filter for this resource

    • includeKeywords
      List

      Include keywords

      Example: item1,item2

    • excludeKeywords
      List

      Exclude keywords

      Example: item1,item2

    • regex
      String

      Regular expression pattern to match against log message content

      Example: error.*timeout

    • logLevelMin
      String

      Minimum log level to include; entries below this level are excluded

      Example: warn

    • serviceFilter
      String

      Service name filter to restrict matching to a specific service

      Example: payment-service

  • createdAt
    String

    Created at

    Example: 2026-01-15T08:00:00Z

  • updatedAt
    String

    Updated at

    Example: 2026-01-15T08:00:00Z

  • active
    Boolean

    Whether this filtered session is currently active

    Example: true

  • cursorPos
    String

    Cursor position marking the last consumed log entry

    Example: cursor-0000099

  • expiresAt
    String

    Expires at

    Example: 2026-01-15T08:00:00Z