v4

latestSwagger 2.02026-07-13112457.8 KB

Get a browser session for the specified session and workspace ID. Requires Bearer JWT access token provided by Entra ID.

get/playwrightworkspaces/{workspaceId}/browser-sessions/{sessionId}

Path parameters

workspaceIdstring required

The workspace ID in GUID format.

sessionIdstring required

The browser session ID in GUID format.

Query parameters

api-versionstring required

The API version to use for this operation.

Headers

x-ms-client-request-idstring uuid

An opaque, globally-unique, client-generated string identifier for the request.

x-ms-useragentstring

Optional header to specify additional client information when the standard 'User-Agent' header cannot be explicitly set, such as when using Playwright Client. The value should follow the standard 'User-Agent' header format.

Response

The request has succeeded.

idstring required

The browser session ID in GUID format.

displayNamestring required

The browser session display name.

creatorIdstring required

The browser session creator's ID.

startTimestring date-time

The browser session start time in UTC.

endTimestring date-time

The browser session end time in UTC.

durationInMillisecondsinteger

The browser session duration in milliseconds.

status'Created' | 'Active' | 'Completed' | 'Failed' required

The browser session status.

browserType'Chromium' | 'Firefox' | 'Webkit' required

The browser type to configure for remote script execution.

operatingSystem'Linux' | 'Windows' required

The operating system to configure for remote script execution.