Content resources API - PUT configuration

  • Reference
  • Published Sep 23, 2020

Updates the configuration of content providers in your Dynatrace environment.

The request consumes an application/json payload.

PUTManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/config/v1/contentResources
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/contentResources

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
bodyContentResources

The JSON body of the request. Contains the configuration of content resources.

bodyOptional

Request body objects

The ContentResources object

The configuration of content resources.

ElementTypeDescriptionRequired
resourceProvidersResourceProvider[]

An ordered list of manually added content providers.

Rules are evaluated from top to bottom; the first matching rules applies.

Optional
resourceTypesResourceType[]

An ordered list of manually defined resource types.

Rules are evaluated from top to bottom; the first matching rules applies.

Optional
resourceUrlCleanupRulesResourceUrlCleanupRule[]

An ordered list of resource URL cleanup rules.

Rules are evaluated from top to bottom; the first matching rules applies.

Optional

The ResourceProvider object

A rule for the content provider.

ElementTypeDescriptionRequired
brandIconUrlstring

The URL of the provider's icon.

Optional
domainNamePatternsstring[]

A list of domain patterns of the provider.

Required
resourceNamestring

The name of the provider.

Required
resourceTypestring

The type of the provider.

The element can hold these values
  • CDN_RESOURCES
  • FIRST_PARTY_RESOURCES
  • THIRD_PARTY_RESOURCES
Required

The ResourceType object

A rule for the resource type.

ElementTypeDescriptionRequired
primaryResourceTypestring

The primary type of the resource.

The element can hold these values
  • CSS
  • IMAGE
  • OTHER
  • SCRIPT
Required
regularExpressionstring

The regular expression to detect the resource.

Required
secondaryResourceTypestring

The secondary type of the resource.

Optional

The ResourceUrlCleanupRule object

A rule for the URL cleanup rule.

ElementTypeDescriptionRequired
regularExpressionstring

The pattern (regular expression) to look for.

Required
replaceWithstring

The text to replace the found pattern with.

Required
resourceNamestring

The name of the rule.

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.

{
  "resourceProviders": [
    {
      "brandIconUrl": "string",
      "domainNamePatterns": [
        "string"
      ],
      "resourceName": "string",
      "resourceType": "CDN_RESOURCES"
    }
  ],
  "resourceTypes": [
    {
      "primaryResourceType": "CSS",
      "regularExpression": "string",
      "secondaryResourceType": "string"
    }
  ],
  "resourceUrlCleanupRules": [
    {
      "regularExpression": "string",
      "replaceWith": "string",
      "resourceName": "string"
    }
  ]
}

Response

Response codes

CodeTypeDescription
204-

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

400ErrorEnvelope

Failed. The input is invalid

Response body objects

The ErrorEnvelope object

ElementTypeDescription
errorError-

The Error object

ElementTypeDescription
codeinteger

The HTTP status code

constraintViolationsConstraintViolation[]

A list of constraint violations

messagestring

The error message

The ConstraintViolation object

A list of constraint violations

ElementTypeDescription
locationstring-
messagestring-
parameterLocationstring-
The element can hold these values
  • HEADER
  • PATH
  • PAYLOAD_BODY
  • QUERY
pathstring-

Response body JSON models

{
  "error": {
    "code": 1,
    "constraintViolations": [
      {
        "location": "string",
        "message": "string",
        "parameterLocation": "HEADER",
        "path": "string"
      }
    ],
    "message": "string"
  }
}

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/contentResources/validator
Environment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/contentResources/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-

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

400ErrorEnvelope

Failed. The input is invalid

Response body objects

The ErrorEnvelope object

ElementTypeDescription
errorError-

The Error object

ElementTypeDescription
codeinteger

The HTTP status code

constraintViolationsConstraintViolation[]

A list of constraint violations

messagestring

The error message

The ConstraintViolation object

A list of constraint violations

ElementTypeDescription
locationstring-
messagestring-
parameterLocationstring-
The element can hold these values
  • HEADER
  • PATH
  • PAYLOAD_BODY
  • QUERY
pathstring-

Response body JSON models

{
  "error": {
    "code": 1,
    "constraintViolations": [
      {
        "location": "string",
        "message": "string",
        "parameterLocation": "HEADER",
        "path": "string"
      }
    ],
    "message": "string"
  }
}