1. Support
  2. Knowledge base
  3. Uptrends' API
  4. API v3 vs v4 object definitions

API v3 versus v4 object definitions

We’re changing our user interface. Some info may not yet be up to date. Please check From classic to new UI.

This article is a continuation of the API v3 to v4 upgrade guide, and will contain an overview of object definitions as used in version 3 of the API and their version 4 counterparts. Different API responses contain definitions of their respective resources, such as monitors, operators, checkpoints or statistical data. This data is represented as a set of objects, with some overlap (for example, each monitor definition has a MonitorGuid and Name field), and some unique fields depending on the resource type (for example, the SelfServiceTransactionScript field applies only to Transaction monitors).

In this article, we will only cover those objects that were added, changed, or removed in the transition from API version 3 to version 4. If a particular object is not mentioned, you can assume it has remained the same over the two versions.

Generic (applies to most monitor types)

version 3 version 4 Comments
Port  - Port-field still exists for Connect and DNS monitors in API version 4
CheckFrequency CheckInterval
Guid MonitorGuid
 - Hash API field only for deduplication
ProbeType MonitorType
Mode MonitorMode
IsSecure  -
MinBytes MinimumBytes
 - NameForPhoneAlerts Only available if phone alerts integration is active
 - CustomFields Array containing custom fields
 - Name Object property in CustomFields array
 - Value Object property in CustomFields array
MatchPattern MatchPatterns Array containing match patterns - some exceptions, see monitor-specific tables
 - Pattern Object property in MatchPatterns array
 - IsPositive Object property in MatchPatterns array
 - RequestHeaders
Checkpoints SelectedCheckpoints
 - Checkpoints Array containing checkpoint IDs - object under SelectedCheckpoints
UseOnlyPrimaryCheckpoints UsePrimaryCheckpointsOnly
 - UseConcurrentMonitoring
 - ConcurrentUnconfirmedErrorThreshold Only available if UseConcurrentMonitoring is set to ‘true’
 - ConcurrentConfirmedErrorThreshold Only available if UseConcurrentMonitoring is set to ‘true’
URL Url

Http(s) monitors

version 3 version 4 Notes
ErrorOnMinBytes AlertOnMinimumBytes
MinBytes MinimumBytes
PostData RequestBody
 - ExpectedHttpStatusCode
 - ExpectedHttpStatusCodeSpecified
 - TlsVersion
 - IpVersion
 - NativeIPv6Only
 - RequestHeaders Array containing request headers
 - Name Object property in RequestHeaders array
 - Value Object property in RequestHeaders array
 - AuthenticationType
UserName Username

Full Page Checks

version 3 version 4
TotalMaximumSize MaximumBytes
UseTotalMaximumSize AlertOnMaximumBytes
ElementMaximumSize ElementMaximumSize
UseElementMaximumSize AlertOnMaximumSize
FailedObjectPercentage FailedObjectPercentage
UseFailedObjectPercentage AlertOnPercentageFail
IgnoreThirdPartyElements IgnoreExternalElements
 - DomainGroupGuidSpecified
 - BlockGoogleAnalytics
 - BlockUptrendsRum
 - BlockUrls Array containing simple list of blocked URLs
 - ThrottlingOptions
 - ThrottlingType Property under ThrottlingOptions
 - BrowserType
 - BrowserWindowDimensions
 - IsMobile Property under BrowserWindowDimensions
 - Width Property under BrowserWindowDimensions
 - Height Property under BrowserWindowDimensions
 - PixelRatio Property under BrowserWindowDimensions
 - MobileDevice Property under BrowserWindowDimensions

Transactions

version 3 version 4
TransactionJsonScript SelfServiceTransactionScript
 - ThrottlingOptions
 - ThrottlingType
 - Credits May not be edited
 - BrowserType
 - BrowserWindowDimensions
 - IsMobile Property under BrowserWindowDimensions
 - Width Property under BrowserWindowDimensions
 - Height Property under BrowserWindowDimensions
 - PixelRatio Property under BrowserWindowDimensions
 - MobileDevice Property under BrowserWindowDimensions
MatchPattern  -

Multi-step API

version 3 version 4 Notes
HttpMethod -
PostData -
- PredefinedVariables Array
- Key Object property in PredefinedVariables array
- Value Object property in PredefinedVariables array
- MsaSteps Array containing step definitions
- Url Request URL for N-th step
- Method Request method for N-th step
- Body Request body for N-th step
- BodyType Body type (Raw/file) for N-th step
- VaultFileId If file - vault item guid
- RequestHeaders Array - request headers for N-th step
- Key Object property in RequestHeaders array
- Value Object property in RequestHeaders array
- Variables Array - variables to create for N-th step
- Source Object property in Variables array
- Property Object property in Variables array
- Name Object property in Variables array
- Arguments Object property in Variables array
- Assertions Array - assertions for N-th step
- Source Object property in Assertions array
- Property Object property in Assertions array
- Equal Object property in Assertions array
- TargetValue Object property in Assertions array
- UseFixedClientCertificate Option to use custom client cert for N-th step
- Authentication Authentication setting for N-th step
- Id Property under Authentication
- AuthenticationType Property under Authentication
- UserName Property under Authentication
- PasswordSpecified Property under Authentication
- IgnoreCertificateErrors Option to ignore cert errors for N-th step
- Delay Delay for N-th step
- StepType Type (wait / http request) of N-th step
- RetryUntilSuccessful Retry until successful option for Nth step
- MaxAttempts Max attempts for Retry until successful option
- UserDefinedFunctions Array containing individual user-defined functions
- Name Object property in UserDefinedFunctions array
- Type Object property in UserDefinedFunctions array
- Regex Object property in UserDefinedFunctions array
- CustomMetrics Array - contains any custom metrics to be generated
- Name Object property in CustomMetrics array
- VariableName Object property in CustomMetrics array

Webservice Http(s)

version 3 version 4 Notes
PostData  -
 - RequestHeaders Array of Request headers, 1 per line
 - Name Object property in RequestHeaders array
 - Value Object property in RequestHeaders array
 - IpVersion
 - NativeIPv6Only
 - TlsVersion
 - RequestBody

DNS monitor

version 3 version 4 Notes
URL DnsServer
DNSQueryType DnsQuery

SSL certificate monitor

version 3 version 4 Notes
SSLCommonName CertificateName
SSLOrganization CertificateOrganization
SSLOrganizationalUnit CertificateOrganizationalUnit
SSLIssuedByCommonName CertificateIssuerName
SSLIssuedByOrganization CertificateIssuerCompanyName
SSLIssuedByOrganizationalUnit CertificateIssuerOrganizationalUnit
SSLSerialNumber CertificateSerialNumber
SSLFingerPrint CertificateFingerpring
SSLExpirationWarningDays CerticifaceExpirationWarningDays

SFTP monitor

version 3 version 4 Notes
URL NetworkAddress
Action SftpAction
DownloadFilename SftpActionPath Empty if only connecting

FTP/SMTP/POP3/MS SQL/MySQL

version 3 version 4 Notes
URL NetworkAddress

IMAP

version 3 version 4 Notes
URL NetworkAddress
 - ImapSecureConnection

Ping

version 3 version 4 Notes
URL NetworkAddress
 - IpVersion
 - NativeIPv6Only

Connect monitor

version 3 version 4 Notes
URL NetworkAddress
ConnectMethod  -
 - IpVersion
 - NativeIPv6Only
By using the Uptrends website, you consent to the use of cookies in accordance with our Cookie Policy.