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.

PUTSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/allowedBeaconOriginsForCors
Environment ActiveGatehttps://{your-activegate-domain}:9999/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

Parameter
Type
Description
In
Required
body

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

body
optional

Request body objects

The AllowedBeaconOrigins object

Configuration of the allowed beacon origins for CORS requests.

Element
Type
Description
Required
allowedBeaconOrigins

A list of allowed beacon origins for CORS requests.

optional
metadata

Metadata useful for debugging

optional
rejectBeaconsWithoutOriginHeader
boolean

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

If not set, false is used.

optional

The BeaconDomainPattern object

Allowed beacon origin for CORS requests.

Element
Type
Description
Required
domainNameMatcher
string

The matching operation for the domainNamePattern.

  • CONTAINS
  • ENDS_WITH
  • EQUALS
  • STARTS_WITH
required
domainNamePattern
string

The pattern of the allowed domain name.

required

The ConfigurationMetadata object

Metadata useful for debugging

Element
Type
Description
Required
clusterVersion
string

Dynatrace version.

optional
configurationVersions
integer[]

A sorted list of the version numbers of the configuration.

optional
currentConfigurationVersions
string[]

A sorted list of version numbers of the configuration.

optional

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.

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

Response

Response codes

Code
Type
Description
204
-

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

400

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.

POSTSaaShttps://{your-environment-id}.live.dynatrace.com/api/config/v1/allowedBeaconOriginsForCors/validator
Environment ActiveGatehttps://{your-activegate-domain}:9999/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

Code
Type
Description
204
-

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

400

Failed. The input is invalid.