Skip to main content
ZStack
Monitoring & Collection/Logging

CreateTailSession

Create a new live-tail streaming session for real-time log monitoring

POST/api/v1/logs/tail/sessions

Operation ID

CreateTailSession

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 session ownership and quota enforcement

    Example: tenant-xyz

  • userUuid
    StringRequired

    UUID of the user creating this session

    Example: user-001-abc

  • filter
    StringRequired

    Log filter expression to apply to the tail stream

    Example: level=error

  • service
    StringRequired

    Service name to restrict the tail stream to

    Example: auth-service

  • lastCursor
    StringRequired

    Cursor position to resume tailing from; omit to start from now

    Example: cursor-0000001

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • id
    String

    Unique identifier of this live-tail session

    Example: session-abc-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
    String

    Log filter expression applied to this tail session

    Example: level=error

  • service
    String

    Service name to tail logs from

    Example: payment-service

  • lastCursor
    String

    Cursor position marking the last consumed log entry

    Example: cursor-0000001

  • createdAt
    String

    Created at

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

  • active
    Boolean

    Whether this session is currently active and receiving messages

    Example: true