v1

latestOpenAPI 3.0.32026-07-17136180270.3 KB

Sessions

Patch a session

Patch a session. Applies a partial update to the target resource.

patch/api/projects/{projectId}/sessions/{sessionId}/

Request body

namestring nullable

Human-readable name.

displayNamestring nullable

Optional display name shown to users.

descriptionstring nullable

Optional human-readable description.

Response

Session

idstring required

Stable identifier for the object.

projectIdstring required

Project identifier that owns or scopes this object.

workspaceIdstring required

Workspace identifier associated with this object.

providerIdstring

Sandbox provider identifier.

namestring required

Human-readable name.

displayNamestring nullable

Optional display name shown to users.

descriptionstring nullable

Optional human-readable description.

sandboxStatusstring required

Collection of sandbox statu values.

sandboxStatusMessagestring nullable

sandbox Status Message value for the session object.

commitStatusstring required

Collection of commit statu values.

commitOperationstring nullable

commit Operation value for the session object.

commitErrorstring nullable

commit Error value for the session object.

targetRefstring nullable

target Ref value for the session object.

appliedCommitstring nullable

applied Commit value for the session object.

errorMessagestring nullable

Detailed error message, when present.

workspacePathstring nullable

workspace Path value for the session object.

createdAtstring date-time required

Time when the object was created.

updatedAtstring date-time required

Time when the object was last updated.