Skip to main content
API Explorer|API Explorer
Monitoring & Collection/Logging
POSTLoggingSince 1.0SynchronousAuth Required

CreateFilteredTailSession

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

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

Body Fields

  • tenantIdStringRequired

    Tenant identifier for quota enforcement and session ownership

    Example: tenant-xyz

  • userUuidStringRequired

    UUID of the user creating this filtered session

    Example: user-001-abc

  • filterObjectRequired

    Filter for this resource

    • includeKeywordsList

      Include keywords

      Example: item1,item2

    • excludeKeywordsList

      Exclude keywords

      Example: item1,item2

    • regexString

      Regular expression pattern to match against log message content

      Example: error.*timeout

    • logLevelMinString

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

      Example: warn

    • serviceFilterString

      Service name filter to restrict matching to a specific service

      Example: payment-service

  • serviceStringRequired

    Service name to restrict the tail stream to

    Example: order-service

Responses

200 OK

On success, this API returns the following response structure.

  • sessionIdString

    Unique identifier of this filtered live-tail session

    Example: fsession-001

  • tenantIdString

    Tenant identifier that owns this session

    Example: tenant-xyz

  • userUuidString

    UUID of the user who created this session

    Example: user-001-abc

  • filterObject

    Filter for this resource

    • includeKeywordsList

      Include keywords

      Example: item1,item2

    • excludeKeywordsList

      Exclude keywords

      Example: item1,item2

    • regexString

      Regular expression pattern to match against log message content

      Example: error.*timeout

    • logLevelMinString

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

      Example: warn

    • serviceFilterString

      Service name filter to restrict matching to a specific service

      Example: payment-service

  • createdAtString

    Created at

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

  • updatedAtString

    Updated at

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

  • activeBoolean

    Whether this filtered session is currently active

    Example: true

  • cursorPosString

    Cursor position marking the last consumed log entry

    Example: cursor-0000099

  • expiresAtString

    Expires at

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

Endpoint

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

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

Operation ID

CreateFilteredTailSession

Permalink

Request Example

curl -X POST '{host}/api/v1/logs/tail/filtered-sessions' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"tenantId":"tenant-xyz","userUuid":"user-001-abc","filter":{"includeKeywords":"item1,item2","excludeKeywords":"item1,item2","regex":"error.*timeout","logLevelMin":"warn","serviceFilter":"payment-service"},"service":"order-service"}'

Response Example

200
{
  "sessionId": "fsession-001",
  "tenantId": "tenant-xyz",
  "userUuid": "user-001-abc",
  "filter": {},
  "createdAt": "example",
  "updatedAt": "example",
  "active": true,
  "cursorPos": "cursor-0000099"
}

Change History

This API has no change history records yet.

View all change history