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 |
|
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 | AllowedBeaconOrigins |
The JSON body of the request. Contains the configuration of the allowed beacon origins for CORS requests. |
body | optional |
Body format
The AllowedBeaconOrigins object
Configuration of the allowed beacon origins for CORS requests.
| Element | Type | Description | Required |
|---|---|---|---|
| metadata | ConfigurationMetadata | optional | |
| allowedBeaconOrigins | BeaconDomainPattern[] |
A list of allowed beacon origins for CORS requests. |
optional |
| rejectBeaconsWithoutOriginHeader | boolean |
Discard ( If not set, |
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 |
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 |
This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request. See the Example expandable section for working sample request.
{
"metadata": {
"configurationVersions": [
4,
2
],
"clusterVersion": "Mock version"
},
"allowedBeaconOrigins": [
{
"domainNameMatcher": "EQUALS",
"domainNamePattern": "dynatrace.com"
}
]
}
Response
Response codes
| Code | Description |
|---|---|
| 204 | Success. The configuration has been updated. Response doesn't have a body. |
| 400 | Failed. The input is invalid. |
Response body
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.
| POST |
|
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
Response codes
| Code | Description |
|---|---|
| 204 | Success. The submitted configuration is valid. Response doesn't have a body. |
| 400 | Failed. The input is invalid. |
Response body
A successful request doesn't return any content.