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.

Early Adopter

This request is an Early Adopter release and may be changed in non-compatible way.

PUT
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/allowedBeaconOriginsForCors
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/allowedBeaconOriginsForCors

Authentication

To execute this request, you need the Write configuration (WriteConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter Type Description In Required
body AllowedBeaconOriginsDto

The allowed beacon origins for CORS requests.

body optional

The AllowedBeaconOriginsDto object

Element Type Description Required
metadata ConfigurationMetadata optional
allowedBeaconOrigins BeaconDomainPattern[]

A list of allowed beacon origins for CORS requests.

optional
rejectBeaconsWithoutOriginHeader boolean

If set to true, beacons without an HTTP Header 'Origin' will be discarded on the BeaconForwarder. Defaults to false.

optional

The BeaconDomainPattern object

Allowed beacon domain pattern for CORS requests

Element Type Description Required
domainNameMatcher string

Enum for the domain matcher

The domainNameMatcher element can hold these values.
required
domainNamePattern string

Pattern of the domain name

required

The ConfigurationMetadata object

Metadata useful for debugging

Element Type Description Required
configurationVersions integer[]

A Sorted list of the version numbers of the configuration.

optional
currentConfigurationVersions string[]

A Sorted list of string version numbers of the configuration.

optional
clusterVersion string

Dynatrace server version.

optional

Possible values

Possible values for the domainNameMatcher element in the BeaconDomainPattern object:

  • CONTAINS
  • ENDS_WITH
  • EQUALS
  • STARTS_WITH

Response codes

Code Description
204 The submitted configuration has been updated.
400 Failed. The input is invalid

Response format

A successful request doesn't return any content.

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.

Early Adopter

This request is an Early Adopter release and may be changed in non-compatible way.

POST
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/allowedBeaconOriginsForCors/validator
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/allowedBeaconOriginsForCors/validator

Authentication

To execute this request, you need the Write configuration (WriteConfig) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Response codes

Code Description
204 Validated. The submitted configuration is valid. Response does not have a body.
400 Failed. The input is invalid