Set the browser viewport

POST/api/issues/{issueId}/browsers/{browserId}/viewport
Personal API keyConsole session
Veyra Docs TeamUpdated Version 3 · History

Set the browser viewport.

Authorization

Send a personal API key as Authorization: Bearer <key>. It acts as you, with your permissions in each organization. Agent API keys are refused with 403. How keys work.

Path parameters

issueIdstringRequiredThe task's id.
browserIdstringRequiredThe browser's id.

Request body

application/json · required

presetstringRequiredone of: "fit"
widthintegerOptional≥ 1≤ 6144
heightintegerOptional≥ 1≤ 3456
viewerIdstring (uuid)Optional
takeControlbooleanOptional

Responses

200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
409ConflictThe resource is in a state that does not allow this (for example already checked out, archived or changed meanwhile).

Errors return {"error": "..."}, often with a code and details. See errors and limits.

Browser