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

CreateTailSession

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

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

    Example: tenant-xyz

  • userUuidStringRequired

    UUID of the user creating this session

    Example: user-001-abc

  • filterStringRequired

    Log filter expression to apply to the tail stream

    Example: level=error

  • serviceStringRequired

    Service name to restrict the tail stream to

    Example: auth-service

  • lastCursorStringRequired

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

    Example: cursor-0000001

Responses

200 OK

On success, this API returns the following response structure.

  • idString

    Unique identifier of this live-tail session

    Example: session-abc-001

  • tenantIdString

    Tenant identifier that owns this session

    Example: tenant-xyz

  • userUuidString

    UUID of the user who created this session

    Example: user-001-abc

  • filterString

    Log filter expression applied to this tail session

    Example: level=error

  • serviceString

    Service name to tail logs from

    Example: payment-service

  • lastCursorString

    Cursor position marking the last consumed log entry

    Example: cursor-0000001

  • createdAtString

    Created at

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

  • activeBoolean

    Whether this session is currently active and receiving messages

    Example: true

Endpoint

POST/api/v1/logs/tail/sessions

/api/v1/logs/tail/sessions

Operation ID

CreateTailSession

Permalink

Request Example

curl -X POST '{host}/api/v1/logs/tail/sessions' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"tenantId":"tenant-xyz","userUuid":"user-001-abc","filter":"level=error","service":"auth-service","lastCursor":"cursor-0000001"}'

Response Example

200
{
  "id": "session-abc-001",
  "tenantId": "tenant-xyz",
  "userUuid": "user-001-abc",
  "filter": "level=error",
  "service": "payment-service",
  "lastCursor": "cursor-0000001",
  "createdAt": "example",
  "active": true
}

Change History

This API has no change history records yet.

View all change history