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

GetTailSessionConfig

Retrieve the current filter configuration for a filtered live-tail session

Execution Availability

Try It Out

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

Path Parameters

Request Inputs

Path Parameters

  • sessionIdStringRequired

    Unique identifier of the filtered session to retrieve config for

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

GET/api/v1/logs/tail/filtered-sessions/{sessionId}/config

/api/v1/logs/tail/filtered-sessions/{sessionId}/config

Operation ID

GetTailSessionConfig

Permalink

Request Example

curl -X GET '{host}/api/v1/logs/tail/filtered-sessions/{sessionId}/config' -H 'Authorization: Bearer {token}'

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