• Home
  • Dynatrace API
  • Configuration
  • RUM
  • Allowed beacon domains
  • PUT configuration

Allowed beacon domains API - PUT configuration

Updates the configuration of the allowed beacon origins for Cross Origin Resource Sharing (CORS) requests.

The request consumes an application/json payload.

PUTManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/config/v1/allowedBeaconOriginsForCors
SaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/allowedBeaconOriginsForCors
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/allowedBeaconOriginsForCors

Authentication

To execute this request, you need an access token with WriteConfig scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
bodyAllowedBeaconOrigins

The JSON body of the request. Contains the configuration of the allowed beacon origins for CORS requests.

bodyoptional

Request body objects

The AllowedBeaconOrigins object

Configuration of the allowed beacon origins for CORS requests.

ElementTypeDescriptionRequired
metadataConfigurationMetadata

Metadata useful for debugging

optional
allowedBeaconOriginsBeaconDomainPattern[]

A list of allowed beacon origins for CORS requests.

optional
rejectBeaconsWithoutOriginHeaderboolean

Discard (true) or keep (false) beacons without the Origin HTTP header on the BeaconForwarder.

If not set, false is used.

optional

The ConfigurationMetadata object

Metadata useful for debugging

ElementTypeDescriptionRequired
configurationVersionsinteger[]

A sorted list of the version numbers of the configuration.

optional
currentConfigurationVersionsstring[]

A sorted list of version numbers of the configuration.

optional
clusterVersionstring

Dynatrace version.

optional

The BeaconDomainPattern object

Allowed beacon origin for CORS requests.

ElementTypeDescriptionRequired
domainNameMatcherstring

The matching operation for the domainNamePattern.

The element can hold these values
  • CONTAINS
  • ENDS_WITH
  • EQUALS
  • STARTS_WITH
required
domainNamePatternstring

The pattern of the allowed domain name.

required

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

json
{ "metadata": { "configurationVersions": [ 4, 2 ], "clusterVersion": "Mock version" }, "allowedBeaconOrigins": [ { "domainNameMatcher": "EQUALS", "domainNamePattern": "dynatrace.com" } ] }

Response

Response codes

CodeTypeDescription
204

Success. The configuration has been updated. Response doesn't have a body.

400ErrorEnvelope

Failed. The input is invalid.

Validate payload

We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.

The request consumes an application/json payload.

POSTManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/config/v1/allowedBeaconOriginsForCors/validator
SaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/allowedBeaconOriginsForCors/validator
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/allowedBeaconOriginsForCors/validator

Authentication

To execute this request, you need an access token with WriteConfig scope.

To learn how to obtain and use it, see Tokens and authentication.

Response

Response codes

CodeTypeDescription
204

Success. The submitted configuration is valid. Response doesn't have a body.

400ErrorEnvelope

Failed. The input is invalid.