Methods

Name Description
AddOrUpdateMaintenanceWindows This web method is used for creating new maintenance windows. For each maintenance window type, the pre-existing window definitions under the monitor governed by the maintenance are removed before creating new ones. The safe way to use this method is to retrieve the pre-existing window definitions and add the new maintenance window definitions to the collections before doing the add. This ensures that pre-existing window definitions will be preserved when you add new ones. To remove a window definition, retrieve the pre-existing window definitions and send an add request with the definition to be removed omitted from the collection.
AddOrUpdateSubstitutionParameters This method is used to add or update one or more monitors’ substitution parameters. For global substitution parameters (those parameterized originally defined in the GSL script), the parameter value may be updated. New global substitution parameters can only be added to the GSL script. A site-level substitution parameter is essentially a copy of a global substitution parameter and bears the same name and id as its global counterpart, but its value will differ from the global value. The global value is the default value and will always be used in the script unless a site-level value has been defined. This method allows you to create and update site-level substitution parameters, provided those parameters each match a global substitution parameter with respect to id and name. For example, if username has been parameterized in a script at the global level, this method may be used to create a site-level username with a value different from what is set at the global level.
ApplyMaintenanceWindowTemplateToMonitors This method applies a common set of maintenance window definitions to multiple monitors. 
GetMaintenanceWindows This method retrieves all of the one-time and recurring maintenance windows under an account. Filtering results on monitor IDs is supported as well as the maintenance window type. 
GetParameterizedTests This method obtains, under a given account, the list of monitors containing substitution parameters. Only monitors containing substitution parameters are returned. Substitution parameters are created in the GSL script at the global level. Their values may be overridden for specific monitor sites (Backbone nodes in the network). For example, in a given script, username and password may be parameterized and have default values. However, when the script is deployed to Backbone sites in the form of a test, user name and password can be overridden on any or all of the sites where the test is deployed.
GetScripts This web method returns all the scripts under a qualified account. A ScriptFilter can be included in the request, restricting the output of the query to scripts matching the filter.
GetSites This method returns all the Backbone nodes (or sites) available to run browser tests for a given account. The ability of the site to run an IPv6 test is also shown in the output for each site returned.
GetTests This web method returns all the browser tests, active or inactive, under a qualified account. A MonitorFilter can be sent with the request to restrict the output.
GetTestsEx This method returns all the active and inactive tests for Backbone, Last Mile, Private Peer, or mobile monitors for an account. A GetTestsRequest and a MonitorClass can be sent with the request to restrict the output.
GetTestsSummary This method is used to request abbreviated test summary data for all of the browser tests of an account. You can request either summaries of active tests or those of inactive tests.
ProvisionLastMileTests This web method is used to provision one or more Last Mile Single Step browser tests. Each test defined in the request constitutes a monitor order. The response indicates the success or failure of each monitor order in the request. Each monitor order will be handled in its own transaction, and the service will process the monitor orders in sequence until all the monitor orders have been processed or one monitor order fails.
ProvisionTests This web method is used to provision one or more Single Step or Multi Step browser tests. Each test defined in the request constitutes a monitor order. The response indicates the success or failure of each monitor order in the request. Each monitor order will be handled in its own transaction, and the service will process the monitor orders in sequence until all the monitor orders have been processed or one monitor order fails.
TestStatusUpdate This method is used to update the status of an existing test.
UpdateTestParameters This method performs partial updates on existing tests. It can be used to change one-to-many monitor properties and/or one-to-many test steps and/or one-to-many monitor site relations.
UpdateTests This method is used to update one or more browser tests (Single Step or Multi-Step). Each update order is processed in its own transaction. The service processes all the update orders in sequence until all the update orders have been processed or a failure is encountered. The response shows the success or failure of each update order processed.