Create a web or mobile frontend for Dynatrace Real User Monitoring with the RUM API by setting its name, display name, type, and whether RUM is enabled.
| POST | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/rum/v1/frontends |
You use this operation to create a web or mobile frontend for Real User Monitoring. The request body sets the frontendName, displayName, type, and enableRum fields. A 201 response returns information about the created frontend, including its new Smartscape FRONTEND ID, which other RUM operations use.
To execute this request, you need a platform token or OAuth access token with rum:frontends:write scope. To learn how to obtain and use it, see Tokens and authentication.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| body | Frontend | Define your frontend | body | Required |
FrontendRequestDto objectDefine your frontend
| Element | Type | Description | Required |
|---|---|---|---|
| displayName | string | The display name of the frontend. | Required |
| enableRum | boolean | Whether RUM should be enabled for this frontend. Also applies the same value to RUM's enabledOnGrail setting. | Optional |
| frontendName | string | The unique frontend name. Must be unique across web and mobile. Can't be changed later. | Required |
| type | string | The type of the frontend. The element can hold these values
| Required |
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.
{"displayName": "string","enableRum": true,"frontendName": "string","type": "CORDOVA"}
| Code | Type | Description |
|---|---|---|
| 201 | Frontend | Frontend created. The response contains info about the created application including the new FRONTEND ID. |
| 400 | Error | Bad request. |
| 4XX | Error | Client error. |
| 5XX | Error | Server error. |
FrontendResponseDto objectYour frontend
| Element | Type | Description |
|---|---|---|
| displayName | string | The display name of the frontend. |
| frontendName | string | The unique frontend name. |
| id | string | The Smartscape FRONTEND ID. |
| type | string | The type of the frontend. The element can hold these values
|
ErrorEnvelope object| Element | Type | Description |
|---|---|---|
| error | Error | - |
Error object| Element | Type | Description |
|---|---|---|
| code | integer | The HTTP status code |
| constraintViolations | Constraint | A list of constraint violations |
| message | string | The error message |
ConstraintViolation objectA list of constraint violations
| Element | Type | Description |
|---|---|---|
| location | string | - |
| message | string | - |
| parameterLocation | string | -The element can hold these values
|
| path | string | - |
{"displayName": "string","frontendName": "string","id": "string","type": "CORDOVA"}
{"error": {"code": 1,"constraintViolations": [{"location": "string","message": "string","parameterLocation": "HEADER","path": "string"}],"message": "string"}}