ApmSyntheticClient¶

class oci.apm_synthetics.ApmSyntheticClient(config, **kwargs)¶

Use the Application Performance Monitoring Synthetic Monitoring API to query synthetic scripts and monitors. For more information, see [Application Performance Monitoring](https://docs.oracle.com/iaas/application-performance-monitoring/index.html).

Methods

`__init__`(config, **kwargs)	Creates a new service client
`aggregate_network_data`(apm_domain_id, …)	Gets aggregated network data for given executions.
`create_dedicated_vantage_point`(…)	Registers a new dedicated vantage point.
`create_monitor`(apm_domain_id, …)	Creates a new monitor.
`create_on_premise_vantage_point`(…)	Registers a new On-premise vantage point.
`create_script`(apm_domain_id, …)	Creates a new script.
`create_worker`(apm_domain_id, …)	Registers a new worker.
`delete_dedicated_vantage_point`(…)	Deregisters the specified dedicated vantage point.
`delete_monitor`(apm_domain_id, monitor_id, …)	Deletes the specified monitor.
`delete_on_premise_vantage_point`(…)	Deregisters the specified On-premise vantage point.
`delete_script`(apm_domain_id, script_id, **kwargs)	Deletes the specified script.
`delete_worker`(apm_domain_id, …)	Deregisters the specified worker.
`get_dedicated_vantage_point`(apm_domain_id, …)	Gets the details of the dedicated vantage point identified by the OCID.
`get_monitor`(apm_domain_id, monitor_id, **kwargs)	Gets the configuration of the monitor identified by the OCID.
`get_monitor_result`(apm_domain_id, …)	Gets the results for a specific execution of a monitor identified by OCID.
`get_on_premise_vantage_point`(apm_domain_id, …)	Gets the details of the On-premise vantage point identified by the OCID.
`get_script`(apm_domain_id, script_id, **kwargs)	Gets the configuration of the script identified by the OCID.
`get_worker`(apm_domain_id, …)	Gets the details of the worker identified by the OCID.
`list_dedicated_vantage_points`(apm_domain_id, …)	Returns a list of dedicated vantage points.
`list_monitors`(apm_domain_id, **kwargs)	Returns a list of monitors.
`list_on_premise_vantage_points`(…)	Returns a list of On-premise vantage points.
`list_public_vantage_points`(apm_domain_id, …)	Returns a list of public vantage points.
`list_scripts`(apm_domain_id, **kwargs)	Returns a list of scripts.
`list_workers`(apm_domain_id, …)	Returns a list of workers.
`update_dedicated_vantage_point`(…)	Updates the dedicated vantage point.
`update_monitor`(apm_domain_id, monitor_id, …)	Updates the monitor.
`update_on_premise_vantage_point`(…)	Updates the On-premise vantage point.
`update_script`(apm_domain_id, script_id, …)	Updates the script.
`update_worker`(apm_domain_id, …)	Updates the worker.

__init__(config, **kwargs)¶

Creates a new service client

Parameters:

config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
signer (AbstractBaseSigner) –
(optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument
retry_strategy (obj) –
(optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.
circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.

aggregate_network_data(apm_domain_id, monitor_id, aggregate_network_data_details, **kwargs)¶

Gets aggregated network data for given executions.

Parameters:	apm_domain_id (str) – (required) The APM domain ID the request is intended for. monitor_id (str) – (required) The OCID of the monitor. aggregate_network_data_details (oci.apm_synthetics.models.AggregateNetworkDataDetails) – (required) Details of the vantage point and corresponding execution times. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `AggregatedNetworkDataResult`
Return type:	`Response`
Example:

Click here to see an example of how to use aggregate_network_data API.

create_dedicated_vantage_point(apm_domain_id, create_dedicated_vantage_point_details, **kwargs)¶

Registers a new dedicated vantage point.

Parameters:	apm_domain_id (str) – (required) The APM domain ID the request is intended for. create_dedicated_vantage_point_details (oci.apm_synthetics.models.CreateDedicatedVantagePointDetails) – (required) The configuration details for registering a dedicated vantage point. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DedicatedVantagePoint`
Return type:	`Response`
Example:

Click here to see an example of how to use create_dedicated_vantage_point API.

create_monitor(apm_domain_id, create_monitor_details, **kwargs)¶

Creates a new monitor.

Parameters:	apm_domain_id (str) – (required) The APM domain ID the request is intended for. create_monitor_details (oci.apm_synthetics.models.CreateMonitorDetails) – (required) The configuration details for creating a monitor. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Monitor`
Return type:	`Response`
Example:

Click here to see an example of how to use create_monitor API.

create_on_premise_vantage_point(apm_domain_id, create_on_premise_vantage_point_details, **kwargs)¶

Registers a new On-premise vantage point.

Parameters:	apm_domain_id (str) – (required) The APM domain ID the request is intended for. create_on_premise_vantage_point_details (oci.apm_synthetics.models.CreateOnPremiseVantagePointDetails) – (required) The configuration details for registering an On-premise vantage point. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OnPremiseVantagePoint`
Return type:	`Response`
Example:

Click here to see an example of how to use create_on_premise_vantage_point API.

create_script(apm_domain_id, create_script_details, **kwargs)¶

Creates a new script.

Parameters:	apm_domain_id (str) – (required) The APM domain ID the request is intended for. create_script_details (oci.apm_synthetics.models.CreateScriptDetails) – (required) The configuration details for creating a script. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Script`
Return type:	`Response`
Example:

Click here to see an example of how to use create_script API.

create_worker(apm_domain_id, on_premise_vantage_point_id, create_worker_details, **kwargs)¶

Registers a new worker.

Parameters:	apm_domain_id (str) – (required) The APM domain ID the request is intended for. on_premise_vantage_point_id (str) – (required) The OCID of the On-premise vantage point. create_worker_details (oci.apm_synthetics.models.CreateWorkerDetails) – (required) The configuration details for registering a worker for an On-premise vantage point. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Worker`
Return type:	`Response`
Example:

Click here to see an example of how to use create_worker API.

delete_dedicated_vantage_point(apm_domain_id, dedicated_vantage_point_id, **kwargs)¶

Deregisters the specified dedicated vantage point.

Parameters:	apm_domain_id (str) – (required) The APM domain ID the request is intended for. dedicated_vantage_point_id (str) – (required) The OCID of the dedicated vantage point. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_dedicated_vantage_point API.

delete_monitor(apm_domain_id, monitor_id, **kwargs)¶

Deletes the specified monitor.

Parameters:	apm_domain_id (str) – (required) The APM domain ID the request is intended for. monitor_id (str) – (required) The OCID of the monitor. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_monitor API.

delete_on_premise_vantage_point(apm_domain_id, on_premise_vantage_point_id, **kwargs)¶

Deregisters the specified On-premise vantage point.

Parameters:	apm_domain_id (str) – (required) The APM domain ID the request is intended for. on_premise_vantage_point_id (str) – (required) The OCID of the On-premise vantage point. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_on_premise_vantage_point API.

delete_script(apm_domain_id, script_id, **kwargs)¶

Deletes the specified script.

Parameters:	apm_domain_id (str) – (required) The APM domain ID the request is intended for. script_id (str) – (required) The OCID of the script. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_script API.

delete_worker(apm_domain_id, on_premise_vantage_point_id, worker_id, **kwargs)¶

Deregisters the specified worker.

Parameters:	apm_domain_id (str) – (required) The APM domain ID the request is intended for. on_premise_vantage_point_id (str) – (required) The OCID of the On-premise vantage point. worker_id (str) – (required) The OCID of the On-premise vantage point worker. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_worker API.

get_dedicated_vantage_point(apm_domain_id, dedicated_vantage_point_id, **kwargs)¶

Gets the details of the dedicated vantage point identified by the OCID.

Parameters:	apm_domain_id (str) – (required) The APM domain ID the request is intended for. dedicated_vantage_point_id (str) – (required) The OCID of the dedicated vantage point. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DedicatedVantagePoint`
Return type:	`Response`
Example:

Click here to see an example of how to use get_dedicated_vantage_point API.

get_monitor(apm_domain_id, monitor_id, **kwargs)¶

Gets the configuration of the monitor identified by the OCID.

Parameters:	apm_domain_id (str) – (required) The APM domain ID the request is intended for. monitor_id (str) – (required) The OCID of the monitor. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Monitor`
Return type:	`Response`
Example:

Click here to see an example of how to use get_monitor API.

get_monitor_result(apm_domain_id, monitor_id, vantage_point, result_type, result_content_type, execution_time, **kwargs)¶

Gets the results for a specific execution of a monitor identified by OCID. The results are in a HAR file, Screenshot, Console Log or Network details.

Parameters:	apm_domain_id (str) – (required) The APM domain ID the request is intended for. monitor_id (str) – (required) The OCID of the monitor. vantage_point (str) – (required) The vantagePoint name. result_type (str) – (required) The result type: har, screenshot, log, or network. result_content_type (str) – (required) The result content type: zip or raw. execution_time (str) – (required) The time the object was posted. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `MonitorResult`
Return type:	`Response`
Example:

Click here to see an example of how to use get_monitor_result API.

get_on_premise_vantage_point(apm_domain_id, on_premise_vantage_point_id, **kwargs)¶

Gets the details of the On-premise vantage point identified by the OCID.

Parameters:	apm_domain_id (str) – (required) The APM domain ID the request is intended for. on_premise_vantage_point_id (str) – (required) The OCID of the On-premise vantage point. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OnPremiseVantagePoint`
Return type:	`Response`
Example:

Click here to see an example of how to use get_on_premise_vantage_point API.

get_script(apm_domain_id, script_id, **kwargs)¶

Gets the configuration of the script identified by the OCID.

Parameters:	apm_domain_id (str) – (required) The APM domain ID the request is intended for. script_id (str) – (required) The OCID of the script. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Script`
Return type:	`Response`
Example:

Click here to see an example of how to use get_script API.

get_worker(apm_domain_id, on_premise_vantage_point_id, worker_id, **kwargs)¶

Gets the details of the worker identified by the OCID.

Parameters:	apm_domain_id (str) – (required) The APM domain ID the request is intended for. on_premise_vantage_point_id (str) – (required) The OCID of the On-premise vantage point. worker_id (str) – (required) The OCID of the On-premise vantage point worker. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Worker`
Return type:	`Response`
Example:

Click here to see an example of how to use get_worker API.

list_dedicated_vantage_points(apm_domain_id, **kwargs)¶

Returns a list of dedicated vantage points.

Parameters:	apm_domain_id (str) – (required) The APM domain ID the request is intended for. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The maximum number of results per page, or items to return in a paginated “List” call. For information on how pagination works, see List Pagination. Example: 50 sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Default sort order is ascending. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order of displayName is ascending. Default order of timeCreated and timeUpdated is descending. The displayName sort by is case-sensitive. Allowed values are: “displayName”, “name”, “timeCreated”, “timeUpdated”, “status” display_name (str) – (optional) A filter to return only the resources that match the entire display name. name (str) – (optional) A filter to return only the resources that match the entire name. status (str) – (optional) A filter to return only the dedicated vantage points that match a given status. Allowed values are: “ENABLED”, “DISABLED” opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DedicatedVantagePointCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_dedicated_vantage_points API.

list_monitors(apm_domain_id, **kwargs)¶

Returns a list of monitors.

Parameters:	apm_domain_id (str) – (required) The APM domain ID the request is intended for. display_name (str) – (optional) A filter to return only the resources that match the entire display name. script_id (str) – (optional) A filter to return only monitors using scriptId. vantage_point (str) – (optional) The name of the public or dedicated vantage point. monitor_type (str) – (optional) A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST, REST and NETWORK. status (str) – (optional) A filter to return only monitors that match the status given. Allowed values are: “ENABLED”, “DISABLED”, “INVALID” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The maximum number of results per page, or items to return in a paginated “List” call. For information on how pagination works, see List Pagination. Example: 50 is_maintenance_window_active (bool) – (optional) A filter to return the monitors whose maintenance window is currently active. is_maintenance_window_set (bool) – (optional) A filter to return the monitors whose maintenance window is set. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Default sort order is ascending. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order of displayName is ascending. Default order of timeCreated and timeUpdated is descending. The displayName sort by is case insensitive. Allowed values are: “displayName”, “timeCreated”, “timeUpdated”, “status”, “monitorType”, “maintenanceWindowTimeStarted” opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `MonitorCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_monitors API.

list_on_premise_vantage_points(apm_domain_id, **kwargs)¶

Returns a list of On-premise vantage points.

Parameters:	apm_domain_id (str) – (required) The APM domain ID the request is intended for. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The maximum number of results per page, or items to return in a paginated “List” call. For information on how pagination works, see List Pagination. Example: 50 sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Default sort order is ascending. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order of displayName is ascending. Default order of timeCreated and timeUpdated is descending. The displayName sort by is case-sensitive. Allowed values are: “displayName”, “name”, “timeCreated”, “timeUpdated” display_name (str) – (optional) A filter to return only the resources that match the entire display name. name (str) – (optional) A filter to return only the resources that match the entire name. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OnPremiseVantagePointCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_on_premise_vantage_points API.

list_public_vantage_points(apm_domain_id, **kwargs)¶

Returns a list of public vantage points.

Parameters:	apm_domain_id (str) – (required) The APM domain ID the request is intended for. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The maximum number of results per page, or items to return in a paginated “List” call. For information on how pagination works, see List Pagination. Example: 50 sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Default sort order is ascending. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. You can provide one sort by (sortBy). Default order for displayName or name is ascending. The displayName or name sort by is case insensitive. Allowed values are: “name”, “displayName” display_name (str) – (optional) A filter to return only the resources that match the entire display name. name (str) – (optional) A filter to return only the resources that match the entire name. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `PublicVantagePointCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_public_vantage_points API.

list_scripts(apm_domain_id, **kwargs)¶

Returns a list of scripts.

Parameters:	apm_domain_id (str) – (required) The APM domain ID the request is intended for. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. display_name (str) – (optional) A filter to return only the resources that match the entire display name. content_type (str) – (optional) A filter to return only resources that match the content type given. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The maximum number of results per page, or items to return in a paginated “List” call. For information on how pagination works, see List Pagination. Example: 50 sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Default sort order is ascending. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order of displayName and contentType is ascending. Default order of timeCreated and timeUpdated is descending. The displayName sort by is case insensitive. Allowed values are: “displayName”, “timeCreated”, “timeUpdated”, “contentType” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `ScriptCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_scripts API.

list_workers(apm_domain_id, on_premise_vantage_point_id, **kwargs)¶

Returns a list of workers.

Parameters:	apm_domain_id (str) – (required) The APM domain ID the request is intended for. on_premise_vantage_point_id (str) – (required) The OCID of the On-premise vantage point. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) The maximum number of results per page, or items to return in a paginated “List” call. For information on how pagination works, see List Pagination. Example: 50 status (str) – (optional) A filter to return only On-premise VP workers that match the status given. Allowed values are: “ENABLED”, “DISABLED” capability (str) – (optional) A filter to return only On-premise VP workers that match the capability given. sort_order (str) – (optional) The sort order to use, either ascending (ASC) or descending (DESC). Default sort order is ascending. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order of displayName is ascending. Default order of timeCreated, timeUpdated and timeLastSyncup is descending. The displayName sort by is case-sensitive. Allowed values are: “displayName”, “name”, “status”, “priority”, “timeCreated”, “timeUpdated”, “timeLastSyncup” display_name (str) – (optional) A filter to return only the resources that match the entire display name. name (str) – (optional) A filter to return only the resources that match the entire name. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `WorkerCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_workers API.

update_dedicated_vantage_point(apm_domain_id, dedicated_vantage_point_id, update_dedicated_vantage_point_details, **kwargs)¶

Updates the dedicated vantage point.

Parameters:	apm_domain_id (str) – (required) The APM domain ID the request is intended for. dedicated_vantage_point_id (str) – (required) The OCID of the dedicated vantage point. update_dedicated_vantage_point_details (oci.apm_synthetics.models.UpdateDedicatedVantagePointDetails) – (required) The information to be updated. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `DedicatedVantagePoint`
Return type:	`Response`
Example:

Click here to see an example of how to use update_dedicated_vantage_point API.

update_monitor(apm_domain_id, monitor_id, update_monitor_details, **kwargs)¶

Updates the monitor.

Parameters:	apm_domain_id (str) – (required) The APM domain ID the request is intended for. monitor_id (str) – (required) The OCID of the monitor. update_monitor_details (oci.apm_synthetics.models.UpdateMonitorDetails) – (required) The information to be updated. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Monitor`
Return type:	`Response`
Example:

Click here to see an example of how to use update_monitor API.

update_on_premise_vantage_point(apm_domain_id, on_premise_vantage_point_id, update_on_premise_vantage_point_details, **kwargs)¶

Updates the On-premise vantage point.

Parameters:	apm_domain_id (str) – (required) The APM domain ID the request is intended for. on_premise_vantage_point_id (str) – (required) The OCID of the On-premise vantage point. update_on_premise_vantage_point_details (oci.apm_synthetics.models.UpdateOnPremiseVantagePointDetails) – (required) The information to be updated. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OnPremiseVantagePoint`
Return type:	`Response`
Example:

Click here to see an example of how to use update_on_premise_vantage_point API.

update_script(apm_domain_id, script_id, update_script_details, **kwargs)¶

Updates the script.

Parameters:	apm_domain_id (str) – (required) The APM domain ID the request is intended for. script_id (str) – (required) The OCID of the script. update_script_details (oci.apm_synthetics.models.UpdateScriptDetails) – (required) The information to be updated. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Script`
Return type:	`Response`
Example:

Click here to see an example of how to use update_script API.

update_worker(apm_domain_id, on_premise_vantage_point_id, worker_id, update_worker_details, **kwargs)¶

Updates the worker.

Parameters:	apm_domain_id (str) – (required) The APM domain ID the request is intended for. on_premise_vantage_point_id (str) – (required) The OCID of the On-premise vantage point. worker_id (str) – (required) The OCID of the On-premise vantage point worker. update_worker_details (oci.apm_synthetics.models.UpdateWorkerDetails) – (required) The information to be updated. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `Worker`
Return type:	`Response`
Example:

Click here to see an example of how to use update_worker API.