Accounts - Get Browsers

Service:

Playwright Testing Service

API Version:

2024-12-01

Gets remote browsers corresponding to given account id and redirects the client for running Playwright tests. Authorization required is Bearer JWT Access token provided by EntraID or Microsoft Playwright Testing Service.

GET {endpoint}/accounts/{accountId}/browsers?api-version=2024-12-01

With optional parameters:

GET {endpoint}/accounts/{accountId}/browsers?api-version=2024-12-01&runId={runId}&os={os}

URI Parameters

Name	In	Required	Type	Description
accountId	path	True	string	The account id.
endpoint	path	True	string	Supported Azure Playwright Service API Endpoints (protocol and hostname, for example: https://{region}.api.playwright.microsoft.com).
api-version	query	True	string minLength: 1	The API version to use for this operation.
os	query		OS	The os provided by client for remote test runs.
runId	query		string	The run id provided by client for corresponding remote test run.

Request Header

Name	Required	Type	Description
x-ms-client-request-id		string (uuid)	An opaque, globally-unique, client-generated string identifier for the request.

Responses

Name	Type	Description
Other Status Codes		Redirection Headers location: string x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	An unexpected error response. Headers x-ms-error-code: string

Security

OAuth2Auth

Type: oauth2
Flow: accessCode
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/v2.0/oauth2/token

Scopes

Name	Description
https://playwright.microsoft.com/.default

Examples

Accounts_GetBrowsers

Sample request

HTTP

GET {endpoint}/accounts/sampleAccountId_00000000-0000-0000-0000-000000000000/browsers?api-version=2024-12-01&os=Linux

Sample response

Status code:

302

location: wss://{region}.api.playwright.microsoft.com/redirectURL?api-version=2024-12-01&os=linux

Definitions

Name	Description
Azure.Core.Foundations.Error	The error object.
Azure.Core.Foundations.ErrorResponse	A response containing error details.
Azure.Core.Foundations.InnerError	An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
OS	The os provided by client for remote test runs.

Azure.Core.Foundations.Error

Object

The error object.

Name	Type	Description
code	string	One of a server-defined set of error codes.
details	Azure.Core.Foundations.Error[]	An array of details about specific errors that led to this reported error.
innererror	Azure.Core.Foundations.InnerError	An object containing more specific information than the current object about the error.
message	string	A human-readable representation of the error.
target	string	The target of the error.

Azure.Core.Foundations.ErrorResponse

Object

A response containing error details.

Name	Type	Description
error	Azure.Core.Foundations.Error	The error object.

Azure.Core.Foundations.InnerError

Object

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Name	Type	Description
code	string	One of a server-defined set of error codes.
innererror	Azure.Core.Foundations.InnerError	Inner error.

OS

Enumeration

The os provided by client for remote test runs.

Value	Description
Linux	Linux OS.
Windows	Windows OS.