Sign in
sessions

Patch Session

Update the title or status of a session within the authenticated user's workspace.

Parameters: body (SessionPatchRequest): Fields to update; at least one field is required.

Returns: SessionDetailResponse: The updated session details.

Raises: HTTPException: If no fields are provided, the title is blank, the status is invalid, or the session cannot be updated.

patch/api/sessions/{session_id}

Path parameters

session_idstring uuid required

Request body

titlestring nullable
status'active' | 'archived' nullable

Response

Successful Response

idstring uuid required
titlestring required
status'active' | 'archived' required
checkpoint_versioninteger required
created_atstring nullable
updated_atstring nullable

Changes

Changed in 5 of the 85 revisions of this API.367

  • 655778279cb11See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 91 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 62e8c152aa181See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 15 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 216311cd30ec3See the full diff
    • ●

      deleted the header request parameter Authorization

      request-parameter-removed

    • ●

      deleted the header request parameter X-Fleet-User-Id

      request-parameter-removed

    • ●

      deleted the header request parameter X-Fleet-Workspace-Id

      request-parameter-removed

  • f18c4c8586ca235See the full diff
    • ▲

      request property status/anyOf[subschema #1]/ was restricted to a list of enum values

      request-property-became-enum

    • ▲

      removed the required property turn_count from the response with the 200 status

      response-required-property-removed

    • ●

      removed the optional property detail from the response with the 422 status

      response-optional-property-removed

    • ●

      added the new active enum value to the status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new archived enum value to the status response property for the response status 200

      response-property-enum-value-added

    • ○

      api operation id patch_session_api_sessions__session_id__patch removed and replaced with update_session

      api-operation-id-removed

    • ○

      added the new active enum value to the request property status/anyOf[subschema #1]/

      request-property-enum-value-added

    • ○

      added the new archived enum value to the request property status/anyOf[subschema #1]/

      request-property-enum-value-added

    • ○

      added the required property code to the response with the 422 status

      response-required-property-added

    • ○

      added the required property message to the response with the 422 status

      response-required-property-added

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 1afc045b25c01See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 136 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog