1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. ApmSynthetics
  5. getMonitors
Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi

oci.ApmSynthetics.getMonitors

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi

This data source provides the list of Monitors in Oracle Cloud Infrastructure APM Availability Monitoring service (aka APM Synthetics Service).

Returns a list of monitors.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testMonitors = oci.ApmSynthetics.getMonitors({
    apmDomainId: testApmDomain.id,
    displayName: monitorDisplayName,
    isMaintenanceWindowActive: monitorIsMaintenanceWindowActive,
    isMaintenanceWindowSet: monitorIsMaintenanceWindowSet,
    monitorType: monitorMonitorType,
    scriptId: testScript.id,
    status: monitorStatus,
    vantagePoint: monitorVantagePoint,
});
Copy
import pulumi
import pulumi_oci as oci

test_monitors = oci.ApmSynthetics.get_monitors(apm_domain_id=test_apm_domain["id"],
    display_name=monitor_display_name,
    is_maintenance_window_active=monitor_is_maintenance_window_active,
    is_maintenance_window_set=monitor_is_maintenance_window_set,
    monitor_type=monitor_monitor_type,
    script_id=test_script["id"],
    status=monitor_status,
    vantage_point=monitor_vantage_point)
Copy
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/apmsynthetics"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apmsynthetics.GetMonitors(ctx, &apmsynthetics.GetMonitorsArgs{
			ApmDomainId:               testApmDomain.Id,
			DisplayName:               pulumi.StringRef(monitorDisplayName),
			IsMaintenanceWindowActive: pulumi.BoolRef(monitorIsMaintenanceWindowActive),
			IsMaintenanceWindowSet:    pulumi.BoolRef(monitorIsMaintenanceWindowSet),
			MonitorType:               pulumi.StringRef(monitorMonitorType),
			ScriptId:                  pulumi.StringRef(testScript.Id),
			Status:                    pulumi.StringRef(monitorStatus),
			VantagePoint:              pulumi.StringRef(monitorVantagePoint),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testMonitors = Oci.ApmSynthetics.GetMonitors.Invoke(new()
    {
        ApmDomainId = testApmDomain.Id,
        DisplayName = monitorDisplayName,
        IsMaintenanceWindowActive = monitorIsMaintenanceWindowActive,
        IsMaintenanceWindowSet = monitorIsMaintenanceWindowSet,
        MonitorType = monitorMonitorType,
        ScriptId = testScript.Id,
        Status = monitorStatus,
        VantagePoint = monitorVantagePoint,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.ApmSynthetics.ApmSyntheticsFunctions;
import com.pulumi.oci.ApmSynthetics.inputs.GetMonitorsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testMonitors = ApmSyntheticsFunctions.getMonitors(GetMonitorsArgs.builder()
            .apmDomainId(testApmDomain.id())
            .displayName(monitorDisplayName)
            .isMaintenanceWindowActive(monitorIsMaintenanceWindowActive)
            .isMaintenanceWindowSet(monitorIsMaintenanceWindowSet)
            .monitorType(monitorMonitorType)
            .scriptId(testScript.id())
            .status(monitorStatus)
            .vantagePoint(monitorVantagePoint)
            .build());

    }
}
Copy
variables:
  testMonitors:
    fn::invoke:
      function: oci:ApmSynthetics:getMonitors
      arguments:
        apmDomainId: ${testApmDomain.id}
        displayName: ${monitorDisplayName}
        isMaintenanceWindowActive: ${monitorIsMaintenanceWindowActive}
        isMaintenanceWindowSet: ${monitorIsMaintenanceWindowSet}
        monitorType: ${monitorMonitorType}
        scriptId: ${testScript.id}
        status: ${monitorStatus}
        vantagePoint: ${monitorVantagePoint}
Copy

Using getMonitors

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getMonitors(args: GetMonitorsArgs, opts?: InvokeOptions): Promise<GetMonitorsResult>
function getMonitorsOutput(args: GetMonitorsOutputArgs, opts?: InvokeOptions): Output<GetMonitorsResult>
Copy
def get_monitors(apm_domain_id: Optional[str] = None,
                 display_name: Optional[str] = None,
                 filters: Optional[Sequence[_apmsynthetics.GetMonitorsFilter]] = None,
                 is_maintenance_window_active: Optional[bool] = None,
                 is_maintenance_window_set: Optional[bool] = None,
                 monitor_type: Optional[str] = None,
                 script_id: Optional[str] = None,
                 status: Optional[str] = None,
                 vantage_point: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetMonitorsResult
def get_monitors_output(apm_domain_id: Optional[pulumi.Input[str]] = None,
                 display_name: Optional[pulumi.Input[str]] = None,
                 filters: Optional[pulumi.Input[Sequence[pulumi.Input[_apmsynthetics.GetMonitorsFilterArgs]]]] = None,
                 is_maintenance_window_active: Optional[pulumi.Input[bool]] = None,
                 is_maintenance_window_set: Optional[pulumi.Input[bool]] = None,
                 monitor_type: Optional[pulumi.Input[str]] = None,
                 script_id: Optional[pulumi.Input[str]] = None,
                 status: Optional[pulumi.Input[str]] = None,
                 vantage_point: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetMonitorsResult]
Copy
func GetMonitors(ctx *Context, args *GetMonitorsArgs, opts ...InvokeOption) (*GetMonitorsResult, error)
func GetMonitorsOutput(ctx *Context, args *GetMonitorsOutputArgs, opts ...InvokeOption) GetMonitorsResultOutput
Copy

> Note: This function is named GetMonitors in the Go SDK.

public static class GetMonitors 
{
    public static Task<GetMonitorsResult> InvokeAsync(GetMonitorsArgs args, InvokeOptions? opts = null)
    public static Output<GetMonitorsResult> Invoke(GetMonitorsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetMonitorsResult> getMonitors(GetMonitorsArgs args, InvokeOptions options)
public static Output<GetMonitorsResult> getMonitors(GetMonitorsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:ApmSynthetics/getMonitors:getMonitors
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ApmDomainId This property is required. string
The APM domain ID the request is intended for.
DisplayName string
A filter to return only the resources that match the entire display name.
Filters Changes to this property will trigger replacement. List<GetMonitorsFilter>
IsMaintenanceWindowActive bool
A filter to return the monitors whose maintenance window is currently active.
IsMaintenanceWindowSet bool
A filter to return the monitors whose maintenance window is set.
MonitorType string
A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST, REST, NETWORK, DNS, FTP and SQL.
ScriptId string
A filter to return only monitors using scriptId.
Status string
A filter to return only monitors that match the status given.
VantagePoint string
The name of the public or dedicated vantage point.
ApmDomainId This property is required. string
The APM domain ID the request is intended for.
DisplayName string
A filter to return only the resources that match the entire display name.
Filters Changes to this property will trigger replacement. []GetMonitorsFilter
IsMaintenanceWindowActive bool
A filter to return the monitors whose maintenance window is currently active.
IsMaintenanceWindowSet bool
A filter to return the monitors whose maintenance window is set.
MonitorType string
A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST, REST, NETWORK, DNS, FTP and SQL.
ScriptId string
A filter to return only monitors using scriptId.
Status string
A filter to return only monitors that match the status given.
VantagePoint string
The name of the public or dedicated vantage point.
apmDomainId This property is required. String
The APM domain ID the request is intended for.
displayName String
A filter to return only the resources that match the entire display name.
filters Changes to this property will trigger replacement. List<GetMonitorsFilter>
isMaintenanceWindowActive Boolean
A filter to return the monitors whose maintenance window is currently active.
isMaintenanceWindowSet Boolean
A filter to return the monitors whose maintenance window is set.
monitorType String
A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST, REST, NETWORK, DNS, FTP and SQL.
scriptId String
A filter to return only monitors using scriptId.
status String
A filter to return only monitors that match the status given.
vantagePoint String
The name of the public or dedicated vantage point.
apmDomainId This property is required. string
The APM domain ID the request is intended for.
displayName string
A filter to return only the resources that match the entire display name.
filters Changes to this property will trigger replacement. GetMonitorsFilter[]
isMaintenanceWindowActive boolean
A filter to return the monitors whose maintenance window is currently active.
isMaintenanceWindowSet boolean
A filter to return the monitors whose maintenance window is set.
monitorType string
A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST, REST, NETWORK, DNS, FTP and SQL.
scriptId string
A filter to return only monitors using scriptId.
status string
A filter to return only monitors that match the status given.
vantagePoint string
The name of the public or dedicated vantage point.
apm_domain_id This property is required. str
The APM domain ID the request is intended for.
display_name str
A filter to return only the resources that match the entire display name.
filters Changes to this property will trigger replacement. Sequence[apmsynthetics.GetMonitorsFilter]
is_maintenance_window_active bool
A filter to return the monitors whose maintenance window is currently active.
is_maintenance_window_set bool
A filter to return the monitors whose maintenance window is set.
monitor_type str
A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST, REST, NETWORK, DNS, FTP and SQL.
script_id str
A filter to return only monitors using scriptId.
status str
A filter to return only monitors that match the status given.
vantage_point str
The name of the public or dedicated vantage point.
apmDomainId This property is required. String
The APM domain ID the request is intended for.
displayName String
A filter to return only the resources that match the entire display name.
filters Changes to this property will trigger replacement. List<Property Map>
isMaintenanceWindowActive Boolean
A filter to return the monitors whose maintenance window is currently active.
isMaintenanceWindowSet Boolean
A filter to return the monitors whose maintenance window is set.
monitorType String
A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST, REST, NETWORK, DNS, FTP and SQL.
scriptId String
A filter to return only monitors using scriptId.
status String
A filter to return only monitors that match the status given.
vantagePoint String
The name of the public or dedicated vantage point.

getMonitors Result

The following output properties are available:

ApmDomainId string
Id string
The provider-assigned unique ID for this managed resource.
MonitorCollections List<GetMonitorsMonitorCollection>
The list of monitor_collection.
DisplayName string
Unique name that can be edited. The name should not contain any confidential information.
Filters List<GetMonitorsFilter>
IsMaintenanceWindowActive bool
IsMaintenanceWindowSet bool
MonitorType string
Type of monitor.
ScriptId string
The OCID of the script. scriptId is mandatory for creation of SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null.
Status string
Enables or disables the monitor.
VantagePoint string
ApmDomainId string
Id string
The provider-assigned unique ID for this managed resource.
MonitorCollections []GetMonitorsMonitorCollection
The list of monitor_collection.
DisplayName string
Unique name that can be edited. The name should not contain any confidential information.
Filters []GetMonitorsFilter
IsMaintenanceWindowActive bool
IsMaintenanceWindowSet bool
MonitorType string
Type of monitor.
ScriptId string
The OCID of the script. scriptId is mandatory for creation of SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null.
Status string
Enables or disables the monitor.
VantagePoint string
apmDomainId String
id String
The provider-assigned unique ID for this managed resource.
monitorCollections List<GetMonitorsMonitorCollection>
The list of monitor_collection.
displayName String
Unique name that can be edited. The name should not contain any confidential information.
filters List<GetMonitorsFilter>
isMaintenanceWindowActive Boolean
isMaintenanceWindowSet Boolean
monitorType String
Type of monitor.
scriptId String
The OCID of the script. scriptId is mandatory for creation of SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null.
status String
Enables or disables the monitor.
vantagePoint String
apmDomainId string
id string
The provider-assigned unique ID for this managed resource.
monitorCollections GetMonitorsMonitorCollection[]
The list of monitor_collection.
displayName string
Unique name that can be edited. The name should not contain any confidential information.
filters GetMonitorsFilter[]
isMaintenanceWindowActive boolean
isMaintenanceWindowSet boolean
monitorType string
Type of monitor.
scriptId string
The OCID of the script. scriptId is mandatory for creation of SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null.
status string
Enables or disables the monitor.
vantagePoint string
apm_domain_id str
id str
The provider-assigned unique ID for this managed resource.
monitor_collections Sequence[apmsynthetics.GetMonitorsMonitorCollection]
The list of monitor_collection.
display_name str
Unique name that can be edited. The name should not contain any confidential information.
filters Sequence[apmsynthetics.GetMonitorsFilter]
is_maintenance_window_active bool
is_maintenance_window_set bool
monitor_type str
Type of monitor.
script_id str
The OCID of the script. scriptId is mandatory for creation of SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null.
status str
Enables or disables the monitor.
vantage_point str
apmDomainId String
id String
The provider-assigned unique ID for this managed resource.
monitorCollections List<Property Map>
The list of monitor_collection.
displayName String
Unique name that can be edited. The name should not contain any confidential information.
filters List<Property Map>
isMaintenanceWindowActive Boolean
isMaintenanceWindowSet Boolean
monitorType String
Type of monitor.
scriptId String
The OCID of the script. scriptId is mandatory for creation of SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null.
status String
Enables or disables the monitor.
vantagePoint String

Supporting Types

GetMonitorsFilter

Name This property is required. string
Name of the vantage point.
Values This property is required. List<string>
Regex bool
Name This property is required. string
Name of the vantage point.
Values This property is required. []string
Regex bool
name This property is required. String
Name of the vantage point.
values This property is required. List<String>
regex Boolean
name This property is required. string
Name of the vantage point.
values This property is required. string[]
regex boolean
name This property is required. str
Name of the vantage point.
values This property is required. Sequence[str]
regex bool
name This property is required. String
Name of the vantage point.
values This property is required. List<String>
regex Boolean

GetMonitorsMonitorCollection

Items This property is required. []GetMonitorsMonitorCollectionItem
items This property is required. GetMonitorsMonitorCollectionItem[]
items This property is required. List<Property Map>

GetMonitorsMonitorCollectionItem

ApmDomainId This property is required. string
The APM domain ID the request is intended for.
AvailabilityConfigurations This property is required. List<GetMonitorsMonitorCollectionItemAvailabilityConfiguration>
Monitor availability configuration details.
BatchIntervalInSeconds This property is required. int
Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN).
Configurations This property is required. List<GetMonitorsMonitorCollectionItemConfiguration>
Details of monitor configuration.
CreatedBy This property is required. string
Name of the user that created the monitor.
DefinedTags This property is required. Dictionary<string, string>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DisplayName This property is required. string
A filter to return only the resources that match the entire display name.
FreeformTags This property is required. Dictionary<string, string>
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id This property is required. string
The OCID of the monitor.
IsIpv6 This property is required. bool
If enabled, domain name will resolve to an IPv6 address.
IsRunNow This property is required. bool
If isRunNow is enabled, then the monitor will run immediately.
IsRunOnce This property is required. bool
If runOnce is enabled, then the monitor will run once.
LastUpdatedBy This property is required. string
Name of the user that recently updated the monitor.
MaintenanceWindowSchedules This property is required. List<GetMonitorsMonitorCollectionItemMaintenanceWindowSchedule>
Details required to schedule maintenance window.
MonitorType This property is required. string
A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST, REST, NETWORK, DNS, FTP and SQL.
RepeatIntervalInSeconds This property is required. int
Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds for Scripted REST, Scripted Browser and Browser monitors, and 60 seconds for REST monitor.
SchedulingPolicy This property is required. string
Scheduling policy to decide the distribution of monitor executions on vantage points.
ScriptId This property is required. string
A filter to return only monitors using scriptId.
ScriptName This property is required. string
Name of the script.
ScriptParameters This property is required. List<GetMonitorsMonitorCollectionItemScriptParameter>
List of script parameters. Example: [{"monitorScriptParameter": {"paramName": "userid", "paramValue":"testuser"}, "isSecret": false, "isOverwritten": false}]
Status This property is required. string
A filter to return only monitors that match the status given.
Target This property is required. string
Specify the endpoint on which to run the monitor. For BROWSER, REST, NETWORK, DNS and FTP monitor types, target is mandatory. If target is specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script (specified by scriptId in monitor) against the specified target endpoint. If target is not specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script as it is. For NETWORK monitor with TCP protocol, a port needs to be provided along with target. Example: 192.168.0.1:80.
TimeCreated This property is required. string
The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
TimeUpdated This property is required. string
The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z
TimeoutInSeconds This property is required. int
Timeout in seconds. If isFailureRetried is true, then timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. If isFailureRetried is false, then timeout cannot be more than 50% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60 for Scripted REST, Scripted Browser and Browser monitors. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.
VantagePointCount This property is required. int
Number of vantage points where monitor is running.
VantagePoints This property is required. List<GetMonitorsMonitorCollectionItemVantagePoint>
List of public, dedicated and onPremise vantage points where the monitor is running.
ApmDomainId This property is required. string
The APM domain ID the request is intended for.
AvailabilityConfigurations This property is required. []GetMonitorsMonitorCollectionItemAvailabilityConfiguration
Monitor availability configuration details.
BatchIntervalInSeconds This property is required. int
Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN).
Configurations This property is required. []GetMonitorsMonitorCollectionItemConfiguration
Details of monitor configuration.
CreatedBy This property is required. string
Name of the user that created the monitor.
DefinedTags This property is required. map[string]string
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DisplayName This property is required. string
A filter to return only the resources that match the entire display name.
FreeformTags This property is required. map[string]string
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id This property is required. string
The OCID of the monitor.
IsIpv6 This property is required. bool
If enabled, domain name will resolve to an IPv6 address.
IsRunNow This property is required. bool
If isRunNow is enabled, then the monitor will run immediately.
IsRunOnce This property is required. bool
If runOnce is enabled, then the monitor will run once.
LastUpdatedBy This property is required. string
Name of the user that recently updated the monitor.
MaintenanceWindowSchedules This property is required. []GetMonitorsMonitorCollectionItemMaintenanceWindowSchedule
Details required to schedule maintenance window.
MonitorType This property is required. string
A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST, REST, NETWORK, DNS, FTP and SQL.
RepeatIntervalInSeconds This property is required. int
Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds for Scripted REST, Scripted Browser and Browser monitors, and 60 seconds for REST monitor.
SchedulingPolicy This property is required. string
Scheduling policy to decide the distribution of monitor executions on vantage points.
ScriptId This property is required. string
A filter to return only monitors using scriptId.
ScriptName This property is required. string
Name of the script.
ScriptParameters This property is required. []GetMonitorsMonitorCollectionItemScriptParameter
List of script parameters. Example: [{"monitorScriptParameter": {"paramName": "userid", "paramValue":"testuser"}, "isSecret": false, "isOverwritten": false}]
Status This property is required. string
A filter to return only monitors that match the status given.
Target This property is required. string
Specify the endpoint on which to run the monitor. For BROWSER, REST, NETWORK, DNS and FTP monitor types, target is mandatory. If target is specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script (specified by scriptId in monitor) against the specified target endpoint. If target is not specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script as it is. For NETWORK monitor with TCP protocol, a port needs to be provided along with target. Example: 192.168.0.1:80.
TimeCreated This property is required. string
The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
TimeUpdated This property is required. string
The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z
TimeoutInSeconds This property is required. int
Timeout in seconds. If isFailureRetried is true, then timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. If isFailureRetried is false, then timeout cannot be more than 50% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60 for Scripted REST, Scripted Browser and Browser monitors. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.
VantagePointCount This property is required. int
Number of vantage points where monitor is running.
VantagePoints This property is required. []GetMonitorsMonitorCollectionItemVantagePoint
List of public, dedicated and onPremise vantage points where the monitor is running.
apmDomainId This property is required. String
The APM domain ID the request is intended for.
availabilityConfigurations This property is required. List<GetMonitorsMonitorCollectionItemAvailabilityConfiguration>
Monitor availability configuration details.
batchIntervalInSeconds This property is required. Integer
Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN).
configurations This property is required. List<GetMonitorsMonitorCollectionItemConfiguration>
Details of monitor configuration.
createdBy This property is required. String
Name of the user that created the monitor.
definedTags This property is required. Map<String,String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName This property is required. String
A filter to return only the resources that match the entire display name.
freeformTags This property is required. Map<String,String>
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id This property is required. String
The OCID of the monitor.
isIpv6 This property is required. Boolean
If enabled, domain name will resolve to an IPv6 address.
isRunNow This property is required. Boolean
If isRunNow is enabled, then the monitor will run immediately.
isRunOnce This property is required. Boolean
If runOnce is enabled, then the monitor will run once.
lastUpdatedBy This property is required. String
Name of the user that recently updated the monitor.
maintenanceWindowSchedules This property is required. List<GetMonitorsMonitorCollectionItemMaintenanceWindowSchedule>
Details required to schedule maintenance window.
monitorType This property is required. String
A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST, REST, NETWORK, DNS, FTP and SQL.
repeatIntervalInSeconds This property is required. Integer
Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds for Scripted REST, Scripted Browser and Browser monitors, and 60 seconds for REST monitor.
schedulingPolicy This property is required. String
Scheduling policy to decide the distribution of monitor executions on vantage points.
scriptId This property is required. String
A filter to return only monitors using scriptId.
scriptName This property is required. String
Name of the script.
scriptParameters This property is required. List<GetMonitorsMonitorCollectionItemScriptParameter>
List of script parameters. Example: [{"monitorScriptParameter": {"paramName": "userid", "paramValue":"testuser"}, "isSecret": false, "isOverwritten": false}]
status This property is required. String
A filter to return only monitors that match the status given.
target This property is required. String
Specify the endpoint on which to run the monitor. For BROWSER, REST, NETWORK, DNS and FTP monitor types, target is mandatory. If target is specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script (specified by scriptId in monitor) against the specified target endpoint. If target is not specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script as it is. For NETWORK monitor with TCP protocol, a port needs to be provided along with target. Example: 192.168.0.1:80.
timeCreated This property is required. String
The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
timeUpdated This property is required. String
The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z
timeoutInSeconds This property is required. Integer
Timeout in seconds. If isFailureRetried is true, then timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. If isFailureRetried is false, then timeout cannot be more than 50% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60 for Scripted REST, Scripted Browser and Browser monitors. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.
vantagePointCount This property is required. Integer
Number of vantage points where monitor is running.
vantagePoints This property is required. List<GetMonitorsMonitorCollectionItemVantagePoint>
List of public, dedicated and onPremise vantage points where the monitor is running.
apmDomainId This property is required. string
The APM domain ID the request is intended for.
availabilityConfigurations This property is required. GetMonitorsMonitorCollectionItemAvailabilityConfiguration[]
Monitor availability configuration details.
batchIntervalInSeconds This property is required. number
Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN).
configurations This property is required. GetMonitorsMonitorCollectionItemConfiguration[]
Details of monitor configuration.
createdBy This property is required. string
Name of the user that created the monitor.
definedTags This property is required. {[key: string]: string}
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName This property is required. string
A filter to return only the resources that match the entire display name.
freeformTags This property is required. {[key: string]: string}
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id This property is required. string
The OCID of the monitor.
isIpv6 This property is required. boolean
If enabled, domain name will resolve to an IPv6 address.
isRunNow This property is required. boolean
If isRunNow is enabled, then the monitor will run immediately.
isRunOnce This property is required. boolean
If runOnce is enabled, then the monitor will run once.
lastUpdatedBy This property is required. string
Name of the user that recently updated the monitor.
maintenanceWindowSchedules This property is required. GetMonitorsMonitorCollectionItemMaintenanceWindowSchedule[]
Details required to schedule maintenance window.
monitorType This property is required. string
A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST, REST, NETWORK, DNS, FTP and SQL.
repeatIntervalInSeconds This property is required. number
Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds for Scripted REST, Scripted Browser and Browser monitors, and 60 seconds for REST monitor.
schedulingPolicy This property is required. string
Scheduling policy to decide the distribution of monitor executions on vantage points.
scriptId This property is required. string
A filter to return only monitors using scriptId.
scriptName This property is required. string
Name of the script.
scriptParameters This property is required. GetMonitorsMonitorCollectionItemScriptParameter[]
List of script parameters. Example: [{"monitorScriptParameter": {"paramName": "userid", "paramValue":"testuser"}, "isSecret": false, "isOverwritten": false}]
status This property is required. string
A filter to return only monitors that match the status given.
target This property is required. string
Specify the endpoint on which to run the monitor. For BROWSER, REST, NETWORK, DNS and FTP monitor types, target is mandatory. If target is specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script (specified by scriptId in monitor) against the specified target endpoint. If target is not specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script as it is. For NETWORK monitor with TCP protocol, a port needs to be provided along with target. Example: 192.168.0.1:80.
timeCreated This property is required. string
The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
timeUpdated This property is required. string
The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z
timeoutInSeconds This property is required. number
Timeout in seconds. If isFailureRetried is true, then timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. If isFailureRetried is false, then timeout cannot be more than 50% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60 for Scripted REST, Scripted Browser and Browser monitors. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.
vantagePointCount This property is required. number
Number of vantage points where monitor is running.
vantagePoints This property is required. GetMonitorsMonitorCollectionItemVantagePoint[]
List of public, dedicated and onPremise vantage points where the monitor is running.
apm_domain_id This property is required. str
The APM domain ID the request is intended for.
availability_configurations This property is required. Sequence[apmsynthetics.GetMonitorsMonitorCollectionItemAvailabilityConfiguration]
Monitor availability configuration details.
batch_interval_in_seconds This property is required. int
Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN).
configurations This property is required. Sequence[apmsynthetics.GetMonitorsMonitorCollectionItemConfiguration]
Details of monitor configuration.
created_by This property is required. str
Name of the user that created the monitor.
defined_tags This property is required. Mapping[str, str]
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
display_name This property is required. str
A filter to return only the resources that match the entire display name.
freeform_tags This property is required. Mapping[str, str]
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id This property is required. str
The OCID of the monitor.
is_ipv6 This property is required. bool
If enabled, domain name will resolve to an IPv6 address.
is_run_now This property is required. bool
If isRunNow is enabled, then the monitor will run immediately.
is_run_once This property is required. bool
If runOnce is enabled, then the monitor will run once.
last_updated_by This property is required. str
Name of the user that recently updated the monitor.
maintenance_window_schedules This property is required. Sequence[apmsynthetics.GetMonitorsMonitorCollectionItemMaintenanceWindowSchedule]
Details required to schedule maintenance window.
monitor_type This property is required. str
A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST, REST, NETWORK, DNS, FTP and SQL.
repeat_interval_in_seconds This property is required. int
Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds for Scripted REST, Scripted Browser and Browser monitors, and 60 seconds for REST monitor.
scheduling_policy This property is required. str
Scheduling policy to decide the distribution of monitor executions on vantage points.
script_id This property is required. str
A filter to return only monitors using scriptId.
script_name This property is required. str
Name of the script.
script_parameters This property is required. Sequence[apmsynthetics.GetMonitorsMonitorCollectionItemScriptParameter]
List of script parameters. Example: [{"monitorScriptParameter": {"paramName": "userid", "paramValue":"testuser"}, "isSecret": false, "isOverwritten": false}]
status This property is required. str
A filter to return only monitors that match the status given.
target This property is required. str
Specify the endpoint on which to run the monitor. For BROWSER, REST, NETWORK, DNS and FTP monitor types, target is mandatory. If target is specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script (specified by scriptId in monitor) against the specified target endpoint. If target is not specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script as it is. For NETWORK monitor with TCP protocol, a port needs to be provided along with target. Example: 192.168.0.1:80.
time_created This property is required. str
The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
time_updated This property is required. str
The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z
timeout_in_seconds This property is required. int
Timeout in seconds. If isFailureRetried is true, then timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. If isFailureRetried is false, then timeout cannot be more than 50% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60 for Scripted REST, Scripted Browser and Browser monitors. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.
vantage_point_count This property is required. int
Number of vantage points where monitor is running.
vantage_points This property is required. Sequence[apmsynthetics.GetMonitorsMonitorCollectionItemVantagePoint]
List of public, dedicated and onPremise vantage points where the monitor is running.
apmDomainId This property is required. String
The APM domain ID the request is intended for.
availabilityConfigurations This property is required. List<Property Map>
Monitor availability configuration details.
batchIntervalInSeconds This property is required. Number
Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN).
configurations This property is required. List<Property Map>
Details of monitor configuration.
createdBy This property is required. String
Name of the user that created the monitor.
definedTags This property is required. Map<String>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName This property is required. String
A filter to return only the resources that match the entire display name.
freeformTags This property is required. Map<String>
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id This property is required. String
The OCID of the monitor.
isIpv6 This property is required. Boolean
If enabled, domain name will resolve to an IPv6 address.
isRunNow This property is required. Boolean
If isRunNow is enabled, then the monitor will run immediately.
isRunOnce This property is required. Boolean
If runOnce is enabled, then the monitor will run once.
lastUpdatedBy This property is required. String
Name of the user that recently updated the monitor.
maintenanceWindowSchedules This property is required. List<Property Map>
Details required to schedule maintenance window.
monitorType This property is required. String
A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST, REST, NETWORK, DNS, FTP and SQL.
repeatIntervalInSeconds This property is required. Number
Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds for Scripted REST, Scripted Browser and Browser monitors, and 60 seconds for REST monitor.
schedulingPolicy This property is required. String
Scheduling policy to decide the distribution of monitor executions on vantage points.
scriptId This property is required. String
A filter to return only monitors using scriptId.
scriptName This property is required. String
Name of the script.
scriptParameters This property is required. List<Property Map>
List of script parameters. Example: [{"monitorScriptParameter": {"paramName": "userid", "paramValue":"testuser"}, "isSecret": false, "isOverwritten": false}]
status This property is required. String
A filter to return only monitors that match the status given.
target This property is required. String
Specify the endpoint on which to run the monitor. For BROWSER, REST, NETWORK, DNS and FTP monitor types, target is mandatory. If target is specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script (specified by scriptId in monitor) against the specified target endpoint. If target is not specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script as it is. For NETWORK monitor with TCP protocol, a port needs to be provided along with target. Example: 192.168.0.1:80.
timeCreated This property is required. String
The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
timeUpdated This property is required. String
The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z
timeoutInSeconds This property is required. Number
Timeout in seconds. If isFailureRetried is true, then timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. If isFailureRetried is false, then timeout cannot be more than 50% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60 for Scripted REST, Scripted Browser and Browser monitors. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.
vantagePointCount This property is required. Number
Number of vantage points where monitor is running.
vantagePoints This property is required. List<Property Map>
List of public, dedicated and onPremise vantage points where the monitor is running.

GetMonitorsMonitorCollectionItemAvailabilityConfiguration

MaxAllowedFailuresPerInterval This property is required. int
Maximum number of failed runs allowed in an interval. If an interval has more failed runs than the specified value, then the interval will be classified as UNAVAILABLE.
MinAllowedRunsPerInterval This property is required. int
Minimum number of runs allowed in an interval. If an interval has fewer runs than the specified value, then the interval will be classified as UNKNOWN and will be excluded from the availability calculations.
MaxAllowedFailuresPerInterval This property is required. int
Maximum number of failed runs allowed in an interval. If an interval has more failed runs than the specified value, then the interval will be classified as UNAVAILABLE.
MinAllowedRunsPerInterval This property is required. int
Minimum number of runs allowed in an interval. If an interval has fewer runs than the specified value, then the interval will be classified as UNKNOWN and will be excluded from the availability calculations.
maxAllowedFailuresPerInterval This property is required. Integer
Maximum number of failed runs allowed in an interval. If an interval has more failed runs than the specified value, then the interval will be classified as UNAVAILABLE.
minAllowedRunsPerInterval This property is required. Integer
Minimum number of runs allowed in an interval. If an interval has fewer runs than the specified value, then the interval will be classified as UNKNOWN and will be excluded from the availability calculations.
maxAllowedFailuresPerInterval This property is required. number
Maximum number of failed runs allowed in an interval. If an interval has more failed runs than the specified value, then the interval will be classified as UNAVAILABLE.
minAllowedRunsPerInterval This property is required. number
Minimum number of runs allowed in an interval. If an interval has fewer runs than the specified value, then the interval will be classified as UNKNOWN and will be excluded from the availability calculations.
max_allowed_failures_per_interval This property is required. int
Maximum number of failed runs allowed in an interval. If an interval has more failed runs than the specified value, then the interval will be classified as UNAVAILABLE.
min_allowed_runs_per_interval This property is required. int
Minimum number of runs allowed in an interval. If an interval has fewer runs than the specified value, then the interval will be classified as UNKNOWN and will be excluded from the availability calculations.
maxAllowedFailuresPerInterval This property is required. Number
Maximum number of failed runs allowed in an interval. If an interval has more failed runs than the specified value, then the interval will be classified as UNAVAILABLE.
minAllowedRunsPerInterval This property is required. Number
Minimum number of runs allowed in an interval. If an interval has fewer runs than the specified value, then the interval will be classified as UNKNOWN and will be excluded from the availability calculations.

GetMonitorsMonitorCollectionItemConfiguration

ClientCertificateDetails This property is required. List<GetMonitorsMonitorCollectionItemConfigurationClientCertificateDetail>
Details for client certificate.
ConfigType This property is required. string
Type of configuration.
ConnectionString This property is required. string
Database connection string.
DatabaseAuthenticationDetails This property is required. List<GetMonitorsMonitorCollectionItemConfigurationDatabaseAuthenticationDetail>
Details for basic authentication.
DatabaseConnectionType This property is required. string
Database connection type. Only CUSTOM_JDBC is supported for MYSQL database type.
DatabaseRole This property is required. string
Database role.
DatabaseType This property is required. string
Database type.
DatabaseWalletDetails This property is required. List<GetMonitorsMonitorCollectionItemConfigurationDatabaseWalletDetail>
Details for database wallet.
DnsConfigurations This property is required. List<GetMonitorsMonitorCollectionItemConfigurationDnsConfiguration>
Information about the DNS settings.
DownloadSizeLimitInBytes This property is required. int
Download size limit in Bytes, at which to stop the transfer. Maximum download size limit is 5 MiB.
FtpBasicAuthenticationDetails This property is required. List<GetMonitorsMonitorCollectionItemConfigurationFtpBasicAuthenticationDetail>
Details for basic authentication.
FtpProtocol This property is required. string
FTP protocol type.
FtpRequestType This property is required. string
FTP monitor request type.
IsActiveMode This property is required. bool
If enabled, Active mode will be used for the FTP connection.
IsCertificateValidationEnabled This property is required. bool
If certificate validation is enabled, then the call will fail in case of certification errors.
IsDefaultSnapshotEnabled This property is required. bool
If disabled, auto snapshots are not collected.
IsFailureRetried This property is required. bool
If isFailureRetried is enabled, then a failed call will be retried.
IsQueryRecursive This property is required. bool
If isQueryRecursive is enabled, then queries will be sent recursively to the target server.
IsRedirectionEnabled This property is required. bool
If redirection is enabled, then redirects will be allowed while accessing target URL.
NameServer This property is required. string
Name of the server that will be used to perform DNS lookup.
NetworkConfigurations This property is required. List<GetMonitorsMonitorCollectionItemConfigurationNetworkConfiguration>
Details of the network configuration. For NETWORK monitor type, NetworkConfiguration is mandatory.
Protocol This property is required. string
Type of protocol.
Query This property is required. string
SQL query to be executed.
RecordType This property is required. string
DNS record type.
ReqAuthenticationDetails This property is required. List<GetMonitorsMonitorCollectionItemConfigurationReqAuthenticationDetail>
Details for request HTTP authentication.
ReqAuthenticationScheme This property is required. string
Request HTTP authentication scheme.
RequestHeaders This property is required. List<GetMonitorsMonitorCollectionItemConfigurationRequestHeader>
List of request headers. Example: [{"headerName": "content-type", "headerValue":"json"}]
RequestMethod This property is required. string
Request HTTP method.
RequestPostBody This property is required. string
Request post body content.
RequestQueryParams This property is required. List<GetMonitorsMonitorCollectionItemConfigurationRequestQueryParam>
List of request query params. Example: [{"paramName": "sortOrder", "paramValue": "asc"}]
UploadFileSizeInBytes This property is required. int
File upload size in Bytes, at which to stop the transfer. Maximum upload size is 5 MiB.
VerifyResponseCodes This property is required. List<string>
Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.
VerifyResponseContent This property is required. string
Verify response content against regular expression based string. If response content does not match the verifyResponseContent value, then it will be considered a failure.
VerifyTexts This property is required. List<GetMonitorsMonitorCollectionItemConfigurationVerifyText>
Verifies all the search strings present in the response. If any search string is not present in the response, then it will be considered as a failure.
ClientCertificateDetails This property is required. []GetMonitorsMonitorCollectionItemConfigurationClientCertificateDetail
Details for client certificate.
ConfigType This property is required. string
Type of configuration.
ConnectionString This property is required. string
Database connection string.
DatabaseAuthenticationDetails This property is required. []GetMonitorsMonitorCollectionItemConfigurationDatabaseAuthenticationDetail
Details for basic authentication.
DatabaseConnectionType This property is required. string
Database connection type. Only CUSTOM_JDBC is supported for MYSQL database type.
DatabaseRole This property is required. string
Database role.
DatabaseType This property is required. string
Database type.
DatabaseWalletDetails This property is required. []GetMonitorsMonitorCollectionItemConfigurationDatabaseWalletDetail
Details for database wallet.
DnsConfigurations This property is required. []GetMonitorsMonitorCollectionItemConfigurationDnsConfiguration
Information about the DNS settings.
DownloadSizeLimitInBytes This property is required. int
Download size limit in Bytes, at which to stop the transfer. Maximum download size limit is 5 MiB.
FtpBasicAuthenticationDetails This property is required. []GetMonitorsMonitorCollectionItemConfigurationFtpBasicAuthenticationDetail
Details for basic authentication.
FtpProtocol This property is required. string
FTP protocol type.
FtpRequestType This property is required. string
FTP monitor request type.
IsActiveMode This property is required. bool
If enabled, Active mode will be used for the FTP connection.
IsCertificateValidationEnabled This property is required. bool
If certificate validation is enabled, then the call will fail in case of certification errors.
IsDefaultSnapshotEnabled This property is required. bool
If disabled, auto snapshots are not collected.
IsFailureRetried This property is required. bool
If isFailureRetried is enabled, then a failed call will be retried.
IsQueryRecursive This property is required. bool
If isQueryRecursive is enabled, then queries will be sent recursively to the target server.
IsRedirectionEnabled This property is required. bool
If redirection is enabled, then redirects will be allowed while accessing target URL.
NameServer This property is required. string
Name of the server that will be used to perform DNS lookup.
NetworkConfigurations This property is required. []GetMonitorsMonitorCollectionItemConfigurationNetworkConfiguration
Details of the network configuration. For NETWORK monitor type, NetworkConfiguration is mandatory.
Protocol This property is required. string
Type of protocol.
Query This property is required. string
SQL query to be executed.
RecordType This property is required. string
DNS record type.
ReqAuthenticationDetails This property is required. []GetMonitorsMonitorCollectionItemConfigurationReqAuthenticationDetail
Details for request HTTP authentication.
ReqAuthenticationScheme This property is required. string
Request HTTP authentication scheme.
RequestHeaders This property is required. []GetMonitorsMonitorCollectionItemConfigurationRequestHeader
List of request headers. Example: [{"headerName": "content-type", "headerValue":"json"}]
RequestMethod This property is required. string
Request HTTP method.
RequestPostBody This property is required. string
Request post body content.
RequestQueryParams This property is required. []GetMonitorsMonitorCollectionItemConfigurationRequestQueryParam
List of request query params. Example: [{"paramName": "sortOrder", "paramValue": "asc"}]
UploadFileSizeInBytes This property is required. int
File upload size in Bytes, at which to stop the transfer. Maximum upload size is 5 MiB.
VerifyResponseCodes This property is required. []string
Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.
VerifyResponseContent This property is required. string
Verify response content against regular expression based string. If response content does not match the verifyResponseContent value, then it will be considered a failure.
VerifyTexts This property is required. []GetMonitorsMonitorCollectionItemConfigurationVerifyText
Verifies all the search strings present in the response. If any search string is not present in the response, then it will be considered as a failure.
clientCertificateDetails This property is required. List<GetMonitorsMonitorCollectionItemConfigurationClientCertificateDetail>
Details for client certificate.
configType This property is required. String
Type of configuration.
connectionString This property is required. String
Database connection string.
databaseAuthenticationDetails This property is required. List<GetMonitorsMonitorCollectionItemConfigurationDatabaseAuthenticationDetail>
Details for basic authentication.
databaseConnectionType This property is required. String
Database connection type. Only CUSTOM_JDBC is supported for MYSQL database type.
databaseRole This property is required. String
Database role.
databaseType This property is required. String
Database type.
databaseWalletDetails This property is required. List<GetMonitorsMonitorCollectionItemConfigurationDatabaseWalletDetail>
Details for database wallet.
dnsConfigurations This property is required. List<GetMonitorsMonitorCollectionItemConfigurationDnsConfiguration>
Information about the DNS settings.
downloadSizeLimitInBytes This property is required. Integer
Download size limit in Bytes, at which to stop the transfer. Maximum download size limit is 5 MiB.
ftpBasicAuthenticationDetails This property is required. List<GetMonitorsMonitorCollectionItemConfigurationFtpBasicAuthenticationDetail>
Details for basic authentication.
ftpProtocol This property is required. String
FTP protocol type.
ftpRequestType This property is required. String
FTP monitor request type.
isActiveMode This property is required. Boolean
If enabled, Active mode will be used for the FTP connection.
isCertificateValidationEnabled This property is required. Boolean
If certificate validation is enabled, then the call will fail in case of certification errors.
isDefaultSnapshotEnabled This property is required. Boolean
If disabled, auto snapshots are not collected.
isFailureRetried This property is required. Boolean
If isFailureRetried is enabled, then a failed call will be retried.
isQueryRecursive This property is required. Boolean
If isQueryRecursive is enabled, then queries will be sent recursively to the target server.
isRedirectionEnabled This property is required. Boolean
If redirection is enabled, then redirects will be allowed while accessing target URL.
nameServer This property is required. String
Name of the server that will be used to perform DNS lookup.
networkConfigurations This property is required. List<GetMonitorsMonitorCollectionItemConfigurationNetworkConfiguration>
Details of the network configuration. For NETWORK monitor type, NetworkConfiguration is mandatory.
protocol This property is required. String
Type of protocol.
query This property is required. String
SQL query to be executed.
recordType This property is required. String
DNS record type.
reqAuthenticationDetails This property is required. List<GetMonitorsMonitorCollectionItemConfigurationReqAuthenticationDetail>
Details for request HTTP authentication.
reqAuthenticationScheme This property is required. String
Request HTTP authentication scheme.
requestHeaders This property is required. List<GetMonitorsMonitorCollectionItemConfigurationRequestHeader>
List of request headers. Example: [{"headerName": "content-type", "headerValue":"json"}]
requestMethod This property is required. String
Request HTTP method.
requestPostBody This property is required. String
Request post body content.
requestQueryParams This property is required. List<GetMonitorsMonitorCollectionItemConfigurationRequestQueryParam>
List of request query params. Example: [{"paramName": "sortOrder", "paramValue": "asc"}]
uploadFileSizeInBytes This property is required. Integer
File upload size in Bytes, at which to stop the transfer. Maximum upload size is 5 MiB.
verifyResponseCodes This property is required. List<String>
Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.
verifyResponseContent This property is required. String
Verify response content against regular expression based string. If response content does not match the verifyResponseContent value, then it will be considered a failure.
verifyTexts This property is required. List<GetMonitorsMonitorCollectionItemConfigurationVerifyText>
Verifies all the search strings present in the response. If any search string is not present in the response, then it will be considered as a failure.
clientCertificateDetails This property is required. GetMonitorsMonitorCollectionItemConfigurationClientCertificateDetail[]
Details for client certificate.
configType This property is required. string
Type of configuration.
connectionString This property is required. string
Database connection string.
databaseAuthenticationDetails This property is required. GetMonitorsMonitorCollectionItemConfigurationDatabaseAuthenticationDetail[]
Details for basic authentication.
databaseConnectionType This property is required. string
Database connection type. Only CUSTOM_JDBC is supported for MYSQL database type.
databaseRole This property is required. string
Database role.
databaseType This property is required. string
Database type.
databaseWalletDetails This property is required. GetMonitorsMonitorCollectionItemConfigurationDatabaseWalletDetail[]
Details for database wallet.
dnsConfigurations This property is required. GetMonitorsMonitorCollectionItemConfigurationDnsConfiguration[]
Information about the DNS settings.
downloadSizeLimitInBytes This property is required. number
Download size limit in Bytes, at which to stop the transfer. Maximum download size limit is 5 MiB.
ftpBasicAuthenticationDetails This property is required. GetMonitorsMonitorCollectionItemConfigurationFtpBasicAuthenticationDetail[]
Details for basic authentication.
ftpProtocol This property is required. string
FTP protocol type.
ftpRequestType This property is required. string
FTP monitor request type.
isActiveMode This property is required. boolean
If enabled, Active mode will be used for the FTP connection.
isCertificateValidationEnabled This property is required. boolean
If certificate validation is enabled, then the call will fail in case of certification errors.
isDefaultSnapshotEnabled This property is required. boolean
If disabled, auto snapshots are not collected.
isFailureRetried This property is required. boolean
If isFailureRetried is enabled, then a failed call will be retried.
isQueryRecursive This property is required. boolean
If isQueryRecursive is enabled, then queries will be sent recursively to the target server.
isRedirectionEnabled This property is required. boolean
If redirection is enabled, then redirects will be allowed while accessing target URL.
nameServer This property is required. string
Name of the server that will be used to perform DNS lookup.
networkConfigurations This property is required. GetMonitorsMonitorCollectionItemConfigurationNetworkConfiguration[]
Details of the network configuration. For NETWORK monitor type, NetworkConfiguration is mandatory.
protocol This property is required. string
Type of protocol.
query This property is required. string
SQL query to be executed.
recordType This property is required. string
DNS record type.
reqAuthenticationDetails This property is required. GetMonitorsMonitorCollectionItemConfigurationReqAuthenticationDetail[]
Details for request HTTP authentication.
reqAuthenticationScheme This property is required. string
Request HTTP authentication scheme.
requestHeaders This property is required. GetMonitorsMonitorCollectionItemConfigurationRequestHeader[]
List of request headers. Example: [{"headerName": "content-type", "headerValue":"json"}]
requestMethod This property is required. string
Request HTTP method.
requestPostBody This property is required. string
Request post body content.
requestQueryParams This property is required. GetMonitorsMonitorCollectionItemConfigurationRequestQueryParam[]
List of request query params. Example: [{"paramName": "sortOrder", "paramValue": "asc"}]
uploadFileSizeInBytes This property is required. number
File upload size in Bytes, at which to stop the transfer. Maximum upload size is 5 MiB.
verifyResponseCodes This property is required. string[]
Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.
verifyResponseContent This property is required. string
Verify response content against regular expression based string. If response content does not match the verifyResponseContent value, then it will be considered a failure.
verifyTexts This property is required. GetMonitorsMonitorCollectionItemConfigurationVerifyText[]
Verifies all the search strings present in the response. If any search string is not present in the response, then it will be considered as a failure.
client_certificate_details This property is required. Sequence[apmsynthetics.GetMonitorsMonitorCollectionItemConfigurationClientCertificateDetail]
Details for client certificate.
config_type This property is required. str
Type of configuration.
connection_string This property is required. str
Database connection string.
database_authentication_details This property is required. Sequence[apmsynthetics.GetMonitorsMonitorCollectionItemConfigurationDatabaseAuthenticationDetail]
Details for basic authentication.
database_connection_type This property is required. str
Database connection type. Only CUSTOM_JDBC is supported for MYSQL database type.
database_role This property is required. str
Database role.
database_type This property is required. str
Database type.
database_wallet_details This property is required. Sequence[apmsynthetics.GetMonitorsMonitorCollectionItemConfigurationDatabaseWalletDetail]
Details for database wallet.
dns_configurations This property is required. Sequence[apmsynthetics.GetMonitorsMonitorCollectionItemConfigurationDnsConfiguration]
Information about the DNS settings.
download_size_limit_in_bytes This property is required. int
Download size limit in Bytes, at which to stop the transfer. Maximum download size limit is 5 MiB.
ftp_basic_authentication_details This property is required. Sequence[apmsynthetics.GetMonitorsMonitorCollectionItemConfigurationFtpBasicAuthenticationDetail]
Details for basic authentication.
ftp_protocol This property is required. str
FTP protocol type.
ftp_request_type This property is required. str
FTP monitor request type.
is_active_mode This property is required. bool
If enabled, Active mode will be used for the FTP connection.
is_certificate_validation_enabled This property is required. bool
If certificate validation is enabled, then the call will fail in case of certification errors.
is_default_snapshot_enabled This property is required. bool
If disabled, auto snapshots are not collected.
is_failure_retried This property is required. bool
If isFailureRetried is enabled, then a failed call will be retried.
is_query_recursive This property is required. bool
If isQueryRecursive is enabled, then queries will be sent recursively to the target server.
is_redirection_enabled This property is required. bool
If redirection is enabled, then redirects will be allowed while accessing target URL.
name_server This property is required. str
Name of the server that will be used to perform DNS lookup.
network_configurations This property is required. Sequence[apmsynthetics.GetMonitorsMonitorCollectionItemConfigurationNetworkConfiguration]
Details of the network configuration. For NETWORK monitor type, NetworkConfiguration is mandatory.
protocol This property is required. str
Type of protocol.
query This property is required. str
SQL query to be executed.
record_type This property is required. str
DNS record type.
req_authentication_details This property is required. Sequence[apmsynthetics.GetMonitorsMonitorCollectionItemConfigurationReqAuthenticationDetail]
Details for request HTTP authentication.
req_authentication_scheme This property is required. str
Request HTTP authentication scheme.
request_headers This property is required. Sequence[apmsynthetics.GetMonitorsMonitorCollectionItemConfigurationRequestHeader]
List of request headers. Example: [{"headerName": "content-type", "headerValue":"json"}]
request_method This property is required. str
Request HTTP method.
request_post_body This property is required. str
Request post body content.
request_query_params This property is required. Sequence[apmsynthetics.GetMonitorsMonitorCollectionItemConfigurationRequestQueryParam]
List of request query params. Example: [{"paramName": "sortOrder", "paramValue": "asc"}]
upload_file_size_in_bytes This property is required. int
File upload size in Bytes, at which to stop the transfer. Maximum upload size is 5 MiB.
verify_response_codes This property is required. Sequence[str]
Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.
verify_response_content This property is required. str
Verify response content against regular expression based string. If response content does not match the verifyResponseContent value, then it will be considered a failure.
verify_texts This property is required. Sequence[apmsynthetics.GetMonitorsMonitorCollectionItemConfigurationVerifyText]
Verifies all the search strings present in the response. If any search string is not present in the response, then it will be considered as a failure.
clientCertificateDetails This property is required. List<Property Map>
Details for client certificate.
configType This property is required. String
Type of configuration.
connectionString This property is required. String
Database connection string.
databaseAuthenticationDetails This property is required. List<Property Map>
Details for basic authentication.
databaseConnectionType This property is required. String
Database connection type. Only CUSTOM_JDBC is supported for MYSQL database type.
databaseRole This property is required. String
Database role.
databaseType This property is required. String
Database type.
databaseWalletDetails This property is required. List<Property Map>
Details for database wallet.
dnsConfigurations This property is required. List<Property Map>
Information about the DNS settings.
downloadSizeLimitInBytes This property is required. Number
Download size limit in Bytes, at which to stop the transfer. Maximum download size limit is 5 MiB.
ftpBasicAuthenticationDetails This property is required. List<Property Map>
Details for basic authentication.
ftpProtocol This property is required. String
FTP protocol type.
ftpRequestType This property is required. String
FTP monitor request type.
isActiveMode This property is required. Boolean
If enabled, Active mode will be used for the FTP connection.
isCertificateValidationEnabled This property is required. Boolean
If certificate validation is enabled, then the call will fail in case of certification errors.
isDefaultSnapshotEnabled This property is required. Boolean
If disabled, auto snapshots are not collected.
isFailureRetried This property is required. Boolean
If isFailureRetried is enabled, then a failed call will be retried.
isQueryRecursive This property is required. Boolean
If isQueryRecursive is enabled, then queries will be sent recursively to the target server.
isRedirectionEnabled This property is required. Boolean
If redirection is enabled, then redirects will be allowed while accessing target URL.
nameServer This property is required. String
Name of the server that will be used to perform DNS lookup.
networkConfigurations This property is required. List<Property Map>
Details of the network configuration. For NETWORK monitor type, NetworkConfiguration is mandatory.
protocol This property is required. String
Type of protocol.
query This property is required. String
SQL query to be executed.
recordType This property is required. String
DNS record type.
reqAuthenticationDetails This property is required. List<Property Map>
Details for request HTTP authentication.
reqAuthenticationScheme This property is required. String
Request HTTP authentication scheme.
requestHeaders This property is required. List<Property Map>
List of request headers. Example: [{"headerName": "content-type", "headerValue":"json"}]
requestMethod This property is required. String
Request HTTP method.
requestPostBody This property is required. String
Request post body content.
requestQueryParams This property is required. List<Property Map>
List of request query params. Example: [{"paramName": "sortOrder", "paramValue": "asc"}]
uploadFileSizeInBytes This property is required. Number
File upload size in Bytes, at which to stop the transfer. Maximum upload size is 5 MiB.
verifyResponseCodes This property is required. List<String>
Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.
verifyResponseContent This property is required. String
Verify response content against regular expression based string. If response content does not match the verifyResponseContent value, then it will be considered a failure.
verifyTexts This property is required. List<Property Map>
Verifies all the search strings present in the response. If any search string is not present in the response, then it will be considered as a failure.

GetMonitorsMonitorCollectionItemConfigurationClientCertificateDetail

ClientCertificates This property is required. List<GetMonitorsMonitorCollectionItemConfigurationClientCertificateDetailClientCertificate>
Client certificate in PEM format.
PrivateKeys This property is required. List<GetMonitorsMonitorCollectionItemConfigurationClientCertificateDetailPrivateKey>
The private key associated with the client certificate in PEM format.
ClientCertificates This property is required. []GetMonitorsMonitorCollectionItemConfigurationClientCertificateDetailClientCertificate
Client certificate in PEM format.
PrivateKeys This property is required. []GetMonitorsMonitorCollectionItemConfigurationClientCertificateDetailPrivateKey
The private key associated with the client certificate in PEM format.
clientCertificates This property is required. List<GetMonitorsMonitorCollectionItemConfigurationClientCertificateDetailClientCertificate>
Client certificate in PEM format.
privateKeys This property is required. List<GetMonitorsMonitorCollectionItemConfigurationClientCertificateDetailPrivateKey>
The private key associated with the client certificate in PEM format.
clientCertificates This property is required. GetMonitorsMonitorCollectionItemConfigurationClientCertificateDetailClientCertificate[]
Client certificate in PEM format.
privateKeys This property is required. GetMonitorsMonitorCollectionItemConfigurationClientCertificateDetailPrivateKey[]
The private key associated with the client certificate in PEM format.
clientCertificates This property is required. List<Property Map>
Client certificate in PEM format.
privateKeys This property is required. List<Property Map>
The private key associated with the client certificate in PEM format.

GetMonitorsMonitorCollectionItemConfigurationClientCertificateDetailClientCertificate

Content This property is required. string
Content of the private key file.
FileName This property is required. string
Name of the private key file.
Content This property is required. string
Content of the private key file.
FileName This property is required. string
Name of the private key file.
content This property is required. String
Content of the private key file.
fileName This property is required. String
Name of the private key file.
content This property is required. string
Content of the private key file.
fileName This property is required. string
Name of the private key file.
content This property is required. str
Content of the private key file.
file_name This property is required. str
Name of the private key file.
content This property is required. String
Content of the private key file.
fileName This property is required. String
Name of the private key file.

GetMonitorsMonitorCollectionItemConfigurationClientCertificateDetailPrivateKey

Content This property is required. string
Content of the private key file.
FileName This property is required. string
Name of the private key file.
Content This property is required. string
Content of the private key file.
FileName This property is required. string
Name of the private key file.
content This property is required. String
Content of the private key file.
fileName This property is required. String
Name of the private key file.
content This property is required. string
Content of the private key file.
fileName This property is required. string
Name of the private key file.
content This property is required. str
Content of the private key file.
file_name This property is required. str
Name of the private key file.
content This property is required. String
Content of the private key file.
fileName This property is required. String
Name of the private key file.

GetMonitorsMonitorCollectionItemConfigurationDatabaseAuthenticationDetail

Passwords This property is required. List<GetMonitorsMonitorCollectionItemConfigurationDatabaseAuthenticationDetailPassword>
Password.
Username This property is required. string
Username for authentication.
Passwords This property is required. []GetMonitorsMonitorCollectionItemConfigurationDatabaseAuthenticationDetailPassword
Password.
Username This property is required. string
Username for authentication.
passwords This property is required. List<GetMonitorsMonitorCollectionItemConfigurationDatabaseAuthenticationDetailPassword>
Password.
username This property is required. String
Username for authentication.
passwords This property is required. GetMonitorsMonitorCollectionItemConfigurationDatabaseAuthenticationDetailPassword[]
Password.
username This property is required. string
Username for authentication.
passwords This property is required. Sequence[apmsynthetics.GetMonitorsMonitorCollectionItemConfigurationDatabaseAuthenticationDetailPassword]
Password.
username This property is required. str
Username for authentication.
passwords This property is required. List<Property Map>
Password.
username This property is required. String
Username for authentication.

GetMonitorsMonitorCollectionItemConfigurationDatabaseAuthenticationDetailPassword

Password This property is required. string
Password.
PasswordType This property is required. string
Type of method to pass password.
VaultSecretId This property is required. string
Vault secret OCID.
Password This property is required. string
Password.
PasswordType This property is required. string
Type of method to pass password.
VaultSecretId This property is required. string
Vault secret OCID.
password This property is required. String
Password.
passwordType This property is required. String
Type of method to pass password.
vaultSecretId This property is required. String
Vault secret OCID.
password This property is required. string
Password.
passwordType This property is required. string
Type of method to pass password.
vaultSecretId This property is required. string
Vault secret OCID.
password This property is required. str
Password.
password_type This property is required. str
Type of method to pass password.
vault_secret_id This property is required. str
Vault secret OCID.
password This property is required. String
Password.
passwordType This property is required. String
Type of method to pass password.
vaultSecretId This property is required. String
Vault secret OCID.

GetMonitorsMonitorCollectionItemConfigurationDatabaseWalletDetail

DatabaseWallet This property is required. string
The database wallet configuration zip file.
ServiceName This property is required. string
Service name of the database.
DatabaseWallet This property is required. string
The database wallet configuration zip file.
ServiceName This property is required. string
Service name of the database.
databaseWallet This property is required. String
The database wallet configuration zip file.
serviceName This property is required. String
Service name of the database.
databaseWallet This property is required. string
The database wallet configuration zip file.
serviceName This property is required. string
Service name of the database.
database_wallet This property is required. str
The database wallet configuration zip file.
service_name This property is required. str
Service name of the database.
databaseWallet This property is required. String
The database wallet configuration zip file.
serviceName This property is required. String
Service name of the database.

GetMonitorsMonitorCollectionItemConfigurationDnsConfiguration

IsOverrideDns This property is required. bool
If isOverrideDns is true, then DNS settings will be overridden.
OverrideDnsIp This property is required. string
Attribute to override the DNS IP value. This value will be honored only if isOverrideDns is set to true.
IsOverrideDns This property is required. bool
If isOverrideDns is true, then DNS settings will be overridden.
OverrideDnsIp This property is required. string
Attribute to override the DNS IP value. This value will be honored only if isOverrideDns is set to true.
isOverrideDns This property is required. Boolean
If isOverrideDns is true, then DNS settings will be overridden.
overrideDnsIp This property is required. String
Attribute to override the DNS IP value. This value will be honored only if isOverrideDns is set to true.
isOverrideDns This property is required. boolean
If isOverrideDns is true, then DNS settings will be overridden.
overrideDnsIp This property is required. string
Attribute to override the DNS IP value. This value will be honored only if isOverrideDns is set to true.
is_override_dns This property is required. bool
If isOverrideDns is true, then DNS settings will be overridden.
override_dns_ip This property is required. str
Attribute to override the DNS IP value. This value will be honored only if isOverrideDns is set to true.
isOverrideDns This property is required. Boolean
If isOverrideDns is true, then DNS settings will be overridden.
overrideDnsIp This property is required. String
Attribute to override the DNS IP value. This value will be honored only if isOverrideDns is set to true.

GetMonitorsMonitorCollectionItemConfigurationFtpBasicAuthenticationDetail

Passwords This property is required. List<GetMonitorsMonitorCollectionItemConfigurationFtpBasicAuthenticationDetailPassword>
Password.
Username This property is required. string
Username for authentication.
Passwords This property is required. []GetMonitorsMonitorCollectionItemConfigurationFtpBasicAuthenticationDetailPassword
Password.
Username This property is required. string
Username for authentication.
passwords This property is required. List<GetMonitorsMonitorCollectionItemConfigurationFtpBasicAuthenticationDetailPassword>
Password.
username This property is required. String
Username for authentication.
passwords This property is required. GetMonitorsMonitorCollectionItemConfigurationFtpBasicAuthenticationDetailPassword[]
Password.
username This property is required. string
Username for authentication.
passwords This property is required. Sequence[apmsynthetics.GetMonitorsMonitorCollectionItemConfigurationFtpBasicAuthenticationDetailPassword]
Password.
username This property is required. str
Username for authentication.
passwords This property is required. List<Property Map>
Password.
username This property is required. String
Username for authentication.

GetMonitorsMonitorCollectionItemConfigurationFtpBasicAuthenticationDetailPassword

Password This property is required. string
Password.
PasswordType This property is required. string
Type of method to pass password.
VaultSecretId This property is required. string
Vault secret OCID.
Password This property is required. string
Password.
PasswordType This property is required. string
Type of method to pass password.
VaultSecretId This property is required. string
Vault secret OCID.
password This property is required. String
Password.
passwordType This property is required. String
Type of method to pass password.
vaultSecretId This property is required. String
Vault secret OCID.
password This property is required. string
Password.
passwordType This property is required. string
Type of method to pass password.
vaultSecretId This property is required. string
Vault secret OCID.
password This property is required. str
Password.
password_type This property is required. str
Type of method to pass password.
vault_secret_id This property is required. str
Vault secret OCID.
password This property is required. String
Password.
passwordType This property is required. String
Type of method to pass password.
vaultSecretId This property is required. String
Vault secret OCID.

GetMonitorsMonitorCollectionItemConfigurationNetworkConfiguration

NumberOfHops This property is required. int
Number of hops.
ProbeMode This property is required. string
Type of probe mode when TCP protocol is selected.
ProbePerHop This property is required. int
Number of probes per hop.
Protocol This property is required. string
Type of protocol.
TransmissionRate This property is required. int
Number of probe packets sent out simultaneously.
NumberOfHops This property is required. int
Number of hops.
ProbeMode This property is required. string
Type of probe mode when TCP protocol is selected.
ProbePerHop This property is required. int
Number of probes per hop.
Protocol This property is required. string
Type of protocol.
TransmissionRate This property is required. int
Number of probe packets sent out simultaneously.
numberOfHops This property is required. Integer
Number of hops.
probeMode This property is required. String
Type of probe mode when TCP protocol is selected.
probePerHop This property is required. Integer
Number of probes per hop.
protocol This property is required. String
Type of protocol.
transmissionRate This property is required. Integer
Number of probe packets sent out simultaneously.
numberOfHops This property is required. number
Number of hops.
probeMode This property is required. string
Type of probe mode when TCP protocol is selected.
probePerHop This property is required. number
Number of probes per hop.
protocol This property is required. string
Type of protocol.
transmissionRate This property is required. number
Number of probe packets sent out simultaneously.
number_of_hops This property is required. int
Number of hops.
probe_mode This property is required. str
Type of probe mode when TCP protocol is selected.
probe_per_hop This property is required. int
Number of probes per hop.
protocol This property is required. str
Type of protocol.
transmission_rate This property is required. int
Number of probe packets sent out simultaneously.
numberOfHops This property is required. Number
Number of hops.
probeMode This property is required. String
Type of probe mode when TCP protocol is selected.
probePerHop This property is required. Number
Number of probes per hop.
protocol This property is required. String
Type of protocol.
transmissionRate This property is required. Number
Number of probe packets sent out simultaneously.

GetMonitorsMonitorCollectionItemConfigurationReqAuthenticationDetail

AuthHeaders This property is required. List<GetMonitorsMonitorCollectionItemConfigurationReqAuthenticationDetailAuthHeader>
List of authentication headers. Example: [{"headerName": "content-type", "headerValue":"json"}]
AuthRequestMethod This property is required. string
Request method.
AuthRequestPostBody This property is required. string
Request post body.
AuthToken This property is required. string
Authentication token.
AuthUrl This property is required. string
URL to get authentication token.
AuthUserName This property is required. string
User name for authentication.
AuthUserPassword This property is required. string
User password for authentication.
OauthScheme This property is required. string
Request HTTP OAuth scheme.
AuthHeaders This property is required. []GetMonitorsMonitorCollectionItemConfigurationReqAuthenticationDetailAuthHeader
List of authentication headers. Example: [{"headerName": "content-type", "headerValue":"json"}]
AuthRequestMethod This property is required. string
Request method.
AuthRequestPostBody This property is required. string
Request post body.
AuthToken This property is required. string
Authentication token.
AuthUrl This property is required. string
URL to get authentication token.
AuthUserName This property is required. string
User name for authentication.
AuthUserPassword This property is required. string
User password for authentication.
OauthScheme This property is required. string
Request HTTP OAuth scheme.
authHeaders This property is required. List<GetMonitorsMonitorCollectionItemConfigurationReqAuthenticationDetailAuthHeader>
List of authentication headers. Example: [{"headerName": "content-type", "headerValue":"json"}]
authRequestMethod This property is required. String
Request method.
authRequestPostBody This property is required. String
Request post body.
authToken This property is required. String
Authentication token.
authUrl This property is required. String
URL to get authentication token.
authUserName This property is required. String
User name for authentication.
authUserPassword This property is required. String
User password for authentication.
oauthScheme This property is required. String
Request HTTP OAuth scheme.
authHeaders This property is required. GetMonitorsMonitorCollectionItemConfigurationReqAuthenticationDetailAuthHeader[]
List of authentication headers. Example: [{"headerName": "content-type", "headerValue":"json"}]
authRequestMethod This property is required. string
Request method.
authRequestPostBody This property is required. string
Request post body.
authToken This property is required. string
Authentication token.
authUrl This property is required. string
URL to get authentication token.
authUserName This property is required. string
User name for authentication.
authUserPassword This property is required. string
User password for authentication.
oauthScheme This property is required. string
Request HTTP OAuth scheme.
auth_headers This property is required. Sequence[apmsynthetics.GetMonitorsMonitorCollectionItemConfigurationReqAuthenticationDetailAuthHeader]
List of authentication headers. Example: [{"headerName": "content-type", "headerValue":"json"}]
auth_request_method This property is required. str
Request method.
auth_request_post_body This property is required. str
Request post body.
auth_token This property is required. str
Authentication token.
auth_url This property is required. str
URL to get authentication token.
auth_user_name This property is required. str
User name for authentication.
auth_user_password This property is required. str
User password for authentication.
oauth_scheme This property is required. str
Request HTTP OAuth scheme.
authHeaders This property is required. List<Property Map>
List of authentication headers. Example: [{"headerName": "content-type", "headerValue":"json"}]
authRequestMethod This property is required. String
Request method.
authRequestPostBody This property is required. String
Request post body.
authToken This property is required. String
Authentication token.
authUrl This property is required. String
URL to get authentication token.
authUserName This property is required. String
User name for authentication.
authUserPassword This property is required. String
User password for authentication.
oauthScheme This property is required. String
Request HTTP OAuth scheme.

GetMonitorsMonitorCollectionItemConfigurationReqAuthenticationDetailAuthHeader

HeaderName This property is required. string
Name of the header.
HeaderValue This property is required. string
Value of the header.
HeaderName This property is required. string
Name of the header.
HeaderValue This property is required. string
Value of the header.
headerName This property is required. String
Name of the header.
headerValue This property is required. String
Value of the header.
headerName This property is required. string
Name of the header.
headerValue This property is required. string
Value of the header.
header_name This property is required. str
Name of the header.
header_value This property is required. str
Value of the header.
headerName This property is required. String
Name of the header.
headerValue This property is required. String
Value of the header.

GetMonitorsMonitorCollectionItemConfigurationRequestHeader

HeaderName This property is required. string
Name of the header.
HeaderValue This property is required. string
Value of the header.
HeaderName This property is required. string
Name of the header.
HeaderValue This property is required. string
Value of the header.
headerName This property is required. String
Name of the header.
headerValue This property is required. String
Value of the header.
headerName This property is required. string
Name of the header.
headerValue This property is required. string
Value of the header.
header_name This property is required. str
Name of the header.
header_value This property is required. str
Value of the header.
headerName This property is required. String
Name of the header.
headerValue This property is required. String
Value of the header.

GetMonitorsMonitorCollectionItemConfigurationRequestQueryParam

ParamName This property is required. string
Name of the parameter.
ParamValue This property is required. string
Value of the parameter.
ParamName This property is required. string
Name of the parameter.
ParamValue This property is required. string
Value of the parameter.
paramName This property is required. String
Name of the parameter.
paramValue This property is required. String
Value of the parameter.
paramName This property is required. string
Name of the parameter.
paramValue This property is required. string
Value of the parameter.
param_name This property is required. str
Name of the parameter.
param_value This property is required. str
Value of the parameter.
paramName This property is required. String
Name of the parameter.
paramValue This property is required. String
Value of the parameter.

GetMonitorsMonitorCollectionItemConfigurationVerifyText

Text This property is required. string
Verification text in the response.
Text This property is required. string
Verification text in the response.
text This property is required. String
Verification text in the response.
text This property is required. string
Verification text in the response.
text This property is required. str
Verification text in the response.
text This property is required. String
Verification text in the response.

GetMonitorsMonitorCollectionItemMaintenanceWindowSchedule

TimeEnded This property is required. string
End time of the maintenance window, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
TimeStarted This property is required. string
Start time of the maintenance window, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
TimeEnded This property is required. string
End time of the maintenance window, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
TimeStarted This property is required. string
Start time of the maintenance window, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
timeEnded This property is required. String
End time of the maintenance window, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
timeStarted This property is required. String
Start time of the maintenance window, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
timeEnded This property is required. string
End time of the maintenance window, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
timeStarted This property is required. string
Start time of the maintenance window, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
time_ended This property is required. str
End time of the maintenance window, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
time_started This property is required. str
Start time of the maintenance window, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
timeEnded This property is required. String
End time of the maintenance window, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
timeStarted This property is required. String
Start time of the maintenance window, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z

GetMonitorsMonitorCollectionItemScriptParameter

IsOverwritten This property is required. bool
If parameter value is default or overwritten.
IsSecret This property is required. bool
Describes if the parameter value is secret and should be kept confidential. isSecret is specified in either CreateScript or UpdateScript API.
MonitorScriptParameters This property is required. List<GetMonitorsMonitorCollectionItemScriptParameterMonitorScriptParameter>
Details of the script parameter that can be used to overwrite the parameter present in the script.
ParamName This property is required. string
Name of the parameter.
ParamValue This property is required. string
Value of the parameter.
IsOverwritten This property is required. bool
If parameter value is default or overwritten.
IsSecret This property is required. bool
Describes if the parameter value is secret and should be kept confidential. isSecret is specified in either CreateScript or UpdateScript API.
MonitorScriptParameters This property is required. []GetMonitorsMonitorCollectionItemScriptParameterMonitorScriptParameter
Details of the script parameter that can be used to overwrite the parameter present in the script.
ParamName This property is required. string
Name of the parameter.
ParamValue This property is required. string
Value of the parameter.
isOverwritten This property is required. Boolean
If parameter value is default or overwritten.
isSecret This property is required. Boolean
Describes if the parameter value is secret and should be kept confidential. isSecret is specified in either CreateScript or UpdateScript API.
monitorScriptParameters This property is required. List<GetMonitorsMonitorCollectionItemScriptParameterMonitorScriptParameter>
Details of the script parameter that can be used to overwrite the parameter present in the script.
paramName This property is required. String
Name of the parameter.
paramValue This property is required. String
Value of the parameter.
isOverwritten This property is required. boolean
If parameter value is default or overwritten.
isSecret This property is required. boolean
Describes if the parameter value is secret and should be kept confidential. isSecret is specified in either CreateScript or UpdateScript API.
monitorScriptParameters This property is required. GetMonitorsMonitorCollectionItemScriptParameterMonitorScriptParameter[]
Details of the script parameter that can be used to overwrite the parameter present in the script.
paramName This property is required. string
Name of the parameter.
paramValue This property is required. string
Value of the parameter.
is_overwritten This property is required. bool
If parameter value is default or overwritten.
is_secret This property is required. bool
Describes if the parameter value is secret and should be kept confidential. isSecret is specified in either CreateScript or UpdateScript API.
monitor_script_parameters This property is required. Sequence[apmsynthetics.GetMonitorsMonitorCollectionItemScriptParameterMonitorScriptParameter]
Details of the script parameter that can be used to overwrite the parameter present in the script.
param_name This property is required. str
Name of the parameter.
param_value This property is required. str
Value of the parameter.
isOverwritten This property is required. Boolean
If parameter value is default or overwritten.
isSecret This property is required. Boolean
Describes if the parameter value is secret and should be kept confidential. isSecret is specified in either CreateScript or UpdateScript API.
monitorScriptParameters This property is required. List<Property Map>
Details of the script parameter that can be used to overwrite the parameter present in the script.
paramName This property is required. String
Name of the parameter.
paramValue This property is required. String
Value of the parameter.

GetMonitorsMonitorCollectionItemScriptParameterMonitorScriptParameter

ParamName This property is required. string
Name of the parameter.
ParamValue This property is required. string
Value of the parameter.
ParamName This property is required. string
Name of the parameter.
ParamValue This property is required. string
Value of the parameter.
paramName This property is required. String
Name of the parameter.
paramValue This property is required. String
Value of the parameter.
paramName This property is required. string
Name of the parameter.
paramValue This property is required. string
Value of the parameter.
param_name This property is required. str
Name of the parameter.
param_value This property is required. str
Value of the parameter.
paramName This property is required. String
Name of the parameter.
paramValue This property is required. String
Value of the parameter.

GetMonitorsMonitorCollectionItemVantagePoint

DisplayName This property is required. string
A filter to return only the resources that match the entire display name.
Name This property is required. string
Name of the vantage point.
WorkerLists This property is required. List<string>
List of workers running the assigned monitor.
DisplayName This property is required. string
A filter to return only the resources that match the entire display name.
Name This property is required. string
Name of the vantage point.
WorkerLists This property is required. []string
List of workers running the assigned monitor.
displayName This property is required. String
A filter to return only the resources that match the entire display name.
name This property is required. String
Name of the vantage point.
workerLists This property is required. List<String>
List of workers running the assigned monitor.
displayName This property is required. string
A filter to return only the resources that match the entire display name.
name This property is required. string
Name of the vantage point.
workerLists This property is required. string[]
List of workers running the assigned monitor.
display_name This property is required. str
A filter to return only the resources that match the entire display name.
name This property is required. str
Name of the vantage point.
worker_lists This property is required. Sequence[str]
List of workers running the assigned monitor.
displayName This property is required. String
A filter to return only the resources that match the entire display name.
name This property is required. String
Name of the vantage point.
workerLists This property is required. List<String>
List of workers running the assigned monitor.

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes
This Pulumi package is based on the oci Terraform Provider.
Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi