sessions

List sessions

Changed on
get/api/v1/sessions

Request

  • Base URL
    http://127.0.0.1:3001
  • URL
    http://127.0.0.1:3001/api/v1/sessions
  • Auth
    none declared

Query parameters

projectstring

Project id filter.

activeboolean nullable

When true, return non-terminated sessions; when false, return terminated sessions.

orchestratorOnlyboolean nullable

When true, return only orchestrator sessions.

freshboolean nullable

When true, return only fresh non-terminated sessions.

kind'worker' | 'orchestrator'

Session kind filter. worker keeps every session that is not an orchestrator.

limitinteger

Page size. When set, sessions are ordered pinned first, then most recently updated, and nextCursor resumes the list. When omitted, every match is returned.

cursorstring

Opaque cursor returned by the previous page. Requires limit.

Response

OK

nextCursorstring

Changes

  • 4d365432d662Revision changes
    • info

      added the new optional query request parameter cursor

    • info

      added the new optional query request parameter kind

    • info

      added the new optional query request parameter limit

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 4bc07ee6043bRevision changes
    • info

      added the optional property // to the response with the status