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.
| 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 | |
| Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/allowedBeaconOriginsForCors |
Authentication
To execute this request, you need 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 | Allowed | 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 |
|---|---|---|---|
| metadata | Configuration | Metadata useful for debugging | optional |
| allowedBeaconOrigins | Beacon | A list of allowed beacon origins for CORS requests. | optional |
| rejectBeaconsWithoutOriginHeader | boolean | Discard ( If not set, | optional |
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 version numbers of the configuration. | optional |
| clusterVersion | string | Dynatrace version. | optional |
The BeaconDomainPattern object
Allowed beacon origin for CORS requests.
| Element | Type | Description | Required |
|---|---|---|---|
| domainNameMatcher | string | The matching operation for the domainNamePattern. | required |
| domainNamePattern | string | 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.
{
"metadata": {
"configurationVersions": [
4,
2
],
"clusterVersion": "Mock version"
},
"allowedBeaconOrigins": [
{
"domainNameMatcher": "EQUALS",
"domainNamePattern": "dynatrace.com"
}
]
}Response
Response codes
| Code | Type | Description |
|---|---|---|
| 204 | - | Success. The configuration has been updated. Response doesn't have a body. |
| 400 | Error | 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.
| 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 | |
| Environment ActiveGate | https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/allowedBeaconOriginsForCors/validator |
Authentication
To execute this request, you need Write configuration (WriteConfig) permission assigned to your API token. 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 | Error | Failed. The input is invalid. |