• Home
  • API
  • Environment
  • Settings
  • Schemas
  • Beacon endpoint settings

Settings API - Beacon endpoint settings schema table

Beacon endpoint settings (builtin:rum.mobile.beacon-endpoint)

Define where OneAgent is to send your iOS and Android monitoring data.
Note: To use an Environment ActiveGate as beacon endpoint, beacon forwarding must be enabled in the ActiveGate config first. Learn more about how to configure an ActiveGate.

Schema IDSchema groupsScope
builtin:rum.mobile.beacon-endpoint
  • group:rum-general
MOBILE_APPLICATION - Mobile App
CUSTOM_APPLICATION - Custom Application
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:rum.mobile.beacon-endpoint
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:rum.mobile.beacon-endpoint
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:rum.mobile.beacon-endpoint

Authentication

To execute this request, you need an access token with Read settings (settings.read) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

PropertyLabelTypeDescriptionRequired
typeTypeenum-required
urlURLtext

This must be a valid beacon endpoint URL.

The URL must start with 'http://' or 'https://'. Environment ActiveGate URL must end with '/mbeacon/{{environment-id}}', Instrumented Web Server URL must end with '/dtmb'.

required