Oracle Apm Synthetic API is one of 378 APIs that Oracle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes
28 operations
across 13 paths,
and defines 54 schemas.
It is described by OpenAPI 3.2.0, at version 20200630.
Requests are made against 2 base URLs: http://apm-synthetic.{region}.oci.{secondLevelDomain}/20200630, https://apm-synthetic.{region}.oci.{secondLevelDomain}/20200630.
The identity and technical contract details declared by the specification.
CreateScriptDetails
object
Details of the request body used to create a new script. Only Side, JavaScript and Playwright TypeScript content types are supported and content should be in S…
7 properties
3 required
Error
object
Details of an error that occurred.
2 properties
2 required
CreateMonitorDetails
object
Details of the request body used to create a new monitor.
19 properties
4 required
DvpStackDetails
object
Details of a Dedicated Vantage Point (DVP) stack in Resource Manager.
2 properties
2 required
PublicVantagePointCollection
object
The results of a public vantage point search, which contains PublicVantagePointSummary items and other data in an APM domain.
1 property
1 required
DedicatedVantagePointSummary
object
Information about dedicated vantage points.
11 properties
7 required
OnPremiseVantagePointSummary
object
Information about On-premise vantage point.
10 properties
5 required
UpdateDedicatedVantagePointDetails
object
Details of the request body used to update a dedicated vantage point.
5 properties
MonitorResult
object
The monitor result for a specific execution.
6 properties
1 required
ScriptParameterInfo
object
Information about script parameters. isOverwritten specifies that the default parameter present in the script content is overwritten.
2 properties
2 required
UpdateScriptDetails
object
Details of the request body used to update a script. Only Side, JavaScript and Playwright TypeScript content types are supported and content should be in Side,…
7 properties
WorkerCollection
object
The results of an On-premise VP worker search, which contains WorkerSummary items and other data in an APM domain.
1 property
1 required
AggregateNetworkDataDetails
object
Details of the vantage point and corresponding execution times.
1 property
1 required
CreateOnPremiseVantagePointDetails
object
Details of the request body used to create a new On-premise vantage point.
5 properties
1 required
VantagePointInfo
object
Details of the vantage point.
3 properties
2 required
MaintenanceWindowSchedule
object
Details required to schedule maintenance window.
2 properties
ScriptCollection
object
The results of a script search, which contains both ScriptSummary items and other data in an APM domain.
1 property
1 required
AggregatedNetworkData
object
Details of the aggregated network data.
5 properties
1 required
MonitorConfiguration
object
Details of monitor configuration.
3 properties
AvailabilityConfiguration
object
Monitor availability configuration details.
2 properties
Script
object
The information about the script.
13 properties
4 required
IdentityInfoDetails
object
Domain details of the On-premise VP worker.
3 properties
3 required
DedicatedVantagePoint
object
The information about a dedicated vantage point.
11 properties
7 required
ScriptSummary
object
Information about the script.
8 properties
4 required
VantagePointNode
object
Details of the vantage point node.
5 properties
1 required
WorkersSummary
object
Details of the workers in a specific On-premise vantage point.
6 properties
6 required
UpdateMonitorDetails
object
Details of the request body used to update a monitor.
18 properties
MonitorResultData
object
Details of the monitor result data.
4 properties
Link
object
Details of the link between two nodes.
9 properties
1 required
GeoSummary
object
Geographic summary of a vantage point.
6 properties
Node
object
Details of the network node.
10 properties
1 required
DedicatedVantagePointCollection
object
The results of a dedicated vantage point search, which contains DedicatedVantagePointSummary items and other data in an APM domain.
1 property
1 required
OnPremiseVantagePointCollection
object
The results of an On-premise vantage point search, which contains OnPremiseVantagePointSummary items and other data in an APM domain.
1 property
1 required
OnPremiseVpWorkerVersionDetails
object
Image version details of the On-premise VP worker.
3 properties
3 required
MonitorSummary
object
Information about the monitor.
24 properties
14 required
CreateDedicatedVantagePointDetails
object
Details of the request body used to create a new dedicated vantage point.
6 properties
3 required
DnsConfiguration
object
Information about the DNS settings.
2 properties
Monitor
object
The information about a monitor.
27 properties
14 required
AvailableCapability
object
Available capability in a specific On-premise vantage point.
2 properties
2 required
Worker
object
The information about an On-premise VP worker.
19 properties
10 required
ScriptParameter
object
Details of the script parameters, paramName must be from the script content and these details can be used to overwrite the default parameter present in the scr…
3 properties
1 required
WorkerSummary
object
Information about On-premise VP worker.
15 properties
7 required
WorkerMonitorList
object
Details of the monitor assigned to an On-premise vantage point worker.
5 properties
3 required
MonitorScriptParameter
object
Details of the script parameter that can be used to overwrite the parameter present in the script.
2 properties
2 required
OnPremiseVantagePoint
object
The information about an On-premise vantage point.
10 properties
5 required
MonitorCollection
object
The results of a monitor search, which contains both MonitorSummary items and other data in an APM domain.
1 property
1 required
CreateWorkerDetails
object
Details of the request body used to create a new worker for an On-premise vantage point.
9 properties
3 required
UpdateOnPremiseVantagePointDetails
object
Details of the request body used to update an On-premise vantage point.
3 properties
UpdateWorkerDetails
object
Details of the request body used to update an On-premise VP worker.
5 properties
MonitorStatusCountMap
object
Details of the monitor count per state. Example: { "total" : 5, "enabled" : 3 , "disabled" : 2, "invalid" : 0 }
4 properties
4 required
MonitorScriptParameterInfo
object
Details of the script parameters in the monitor. isOverwritten specifies that the script parameters are overwritten in the monitor. If the user overwrites the…
3 properties
3 required
VantagePointExecution
object
Details of a vantage point execution.
2 properties
PublicVantagePointSummary
object
Information about public vantage points.
3 properties
2 required
AggregatedNetworkDataResult
object
The aggregated network results.
1 property
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Oracle publishes across the network.
