Skip to main content
GET
/
devices
/
{deviceId}
/
overlay
JavaScript
import Mobilerun from '@mobilerun/sdk';

const client = new Mobilerun({
  apiKey: process.env['MOBILERUN_CLOUD_API_KEY'], // This is the default and can be omitted
});

const response = await client.devices.actions.overlayVisible('deviceId');

console.log(response.visible);
{
  "visible": true,
  "$schema": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer token via Authorization header

Headers

X-Device-Display-ID
integer<int64>
default:0
Required range: x >= 0

Path Parameters

deviceId
string
required

Response

OK

visible
boolean
required
$schema
string<uri>
read-only

A URL to the JSON Schema for this object.

Example:

"https://example.com/schemas/OverlayVisibleBody.json"