Settings API - Http monitor's requests schema table

  • Reference
  • Published Oct 14, 2024

Http monitor's requests (builtin:synthetic.http.requests)

Set http monitor's requests.

Schema IDSchema groupsScope
builtin:synthetic.http.requests-
HTTP_CHECK - HTTP monitor
Retrieve schema via Settings API
GETManagedhttps://{your-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:synthetic.http.requests
GETSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/settings/schemas/builtin:synthetic.http.requests
GETEnvironment ActiveGatehttps://{your-activegate-domain}/e/{your-environment-id}/api/v2/settings/schemas/builtin:synthetic.http.requests

Authentication

To execute this request, you need an access token with Read settings (settings.read) scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

PropertyTypeDescriptionRequired
Requests
requests		Request[]-Required
The Request object
PropertyTypeDescriptionRequired
Description
description		text-Required
Request's URL address
url		text-Required
HTTP method
method		enum
The element has these enums
  • GET
  • POST
  • PUT
  • DELETE
  • HEAD
  • OPTIONS
  • PATCH
Required
Request body
requestBody		text-Optional
Set of request constraints
constraints		Set<Constraint>-Required
Pre-execution script
preScript		text-Optional
Post-execution script
postScript		text-Optional
Authentication
authentication		Authentication-Optional
Request's configuration
configuration		Configuration-Required
The Constraint object
PropertyTypeDescriptionRequired
Constraint type
type		text-Required
Properties
properties		Set<Property>-Required
The Authentication object
PropertyTypeDescriptionRequired
Authentication type
type		enum
The element has these enums
  • BASIC_AUTHENTICATION
  • NTLM
  • KERBEROS
Required
Credential vault id
credentials		text-Required
Realm name
realmName		text-Required
KDC IP
kdcIp		text-Required
The Configuration object
PropertyTypeDescriptionRequired
Headers
headers		Set<Header>-Required
Accept any certificate flag
acceptAnyCertificate		boolean-Required
Follow redirects flag
followRedirects		boolean-Required
Sensitive data is not persisted
doNotPersistSensitiveData		boolean-Required
Generate a problem if the SSL certificate expires within the given days
sslCertificateExpirationDaysToAlert		integer-Optional
Identifier of stored client's certificate
clientCertificateId		text-Optional
The Property object
PropertyTypeDescriptionRequired
Property key
key		text-Required
Property value
value		text-Required