openapi: 3.2.0 info: description: Use the APM Availability Monitoring API to query Scripts, Monitors, Dedicated Vantage Points and On-Premise Vantage Points resources. For more information, see [Application Performance Monitoring](https://docs.oracle.com/iaas/application-performance-monitoring/index.html). license: name: Oracle Corporation title: APM Availability Monitoring Apm Synthetic API version: '20200630' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/202b308f03ee919108f01637e7dfa3ef4f65f73c616827e1c347451589608915.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the APM Availability Monitoring API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/202b308f03ee919108f01637e7dfa3ef4f65f73c616827e1c347451589608915.yaml what: the harvested document for APM Availability Monitoring API servers: - url: http://apm-synthetic.{region}.oci.{secondLevelDomain}/20200630 - url: https://apm-synthetic.{region}.oci.{secondLevelDomain}/20200630 tags: - name: apmSynthetic paths: /dedicatedVantagePoints: get: description: 'Returns a list of dedicated vantage points. ' operationId: ListDedicatedVantagePoints parameters: - $ref: '#/components/parameters/ApmDomainIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParamForDedicatedVantagePoint' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/DedicatedVantagePointStatusQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The list of dedicated vantage points was returned. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DedicatedVantagePointCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List dedicated vantage points specified in an APM domain. tags: - apmSynthetic x-related-resource: '#/definitions/DedicatedVantagePointCollection' post: description: 'Registers a new dedicated vantage point. ' operationId: CreateDedicatedVantagePoint parameters: - $ref: '#/components/parameters/ApmDomainIdQueryParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The dedicated vantage point was registered. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DedicatedVantagePoint' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Registers a new dedicated vantage point in the specified APM domain. tags: - apmSynthetic x-related-resource: '#/definitions/DedicatedVantagePoint' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDedicatedVantagePointDetails' description: The configuration details for registering a dedicated vantage point. required: true /dedicatedVantagePoints/{dedicatedVantagePointId}: delete: description: Deregisters the specified dedicated vantage point. operationId: DeleteDedicatedVantagePoint parameters: - $ref: '#/components/parameters/ApmDomainIdQueryParam' - $ref: '#/components/parameters/DedicatedVantagePointIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The dedicated vantage point was deregistered. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deregisters a dedicated vantage point resource by OCID. tags: - apmSynthetic x-related-resource: '#/definitions/DedicatedVantagePoint' get: description: Gets the details of the dedicated vantage point identified by the OCID. operationId: GetDedicatedVantagePoint parameters: - $ref: '#/components/parameters/ApmDomainIdQueryParam' - $ref: '#/components/parameters/DedicatedVantagePointIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The dedicated vantage point details were retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DedicatedVantagePoint' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the details of the dedicated vantage point identified by the OCID. tags: - apmSynthetic put: description: Updates the dedicated vantage point. operationId: UpdateDedicatedVantagePoint parameters: - $ref: '#/components/parameters/ApmDomainIdQueryParam' - $ref: '#/components/parameters/DedicatedVantagePointIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The dedicated vantage point details were updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DedicatedVantagePoint' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the dedicated vantage point identified by the OCID. tags: - apmSynthetic x-related-resource: '#/definitions/DedicatedVantagePoint' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDedicatedVantagePointDetails' description: The information to be updated. required: true /monitors: get: description: 'Returns a list of monitors. ' operationId: ListMonitors parameters: - $ref: '#/components/parameters/ApmDomainIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/ScriptIdQueryParam' - $ref: '#/components/parameters/VantagePointNameQueryParam' - $ref: '#/components/parameters/MonitorTypeQueryParam' - $ref: '#/components/parameters/MonitorStatusQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/IsMaintenanceWindowActiveQueryParam' - $ref: '#/components/parameters/IsMaintenanceWindowScheduleSetQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParamForMonitor' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of the list of monitors was returned. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MonitorCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List monitors specified in an APM domain. tags: - apmSynthetic x-related-resource: '#/definitions/MonitorCollection' post: description: 'Creates a new monitor. ' operationId: CreateMonitor parameters: - $ref: '#/components/parameters/ApmDomainIdQueryParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The monitor was created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Monitor' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new monitor in the specified in an APM domain. tags: - apmSynthetic x-related-resource: '#/definitions/Monitor' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateMonitorDetails' description: The configuration details for creating a monitor. required: true /monitors/{monitorId}: delete: description: Deletes the specified monitor. operationId: DeleteMonitor parameters: - $ref: '#/components/parameters/ApmDomainIdQueryParam' - $ref: '#/components/parameters/MonitorIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The monitor was deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a monitor resource by the OCID. tags: - apmSynthetic x-related-resource: '#/definitions/Monitor' get: description: Gets the configuration of the monitor identified by the OCID. operationId: GetMonitor parameters: - $ref: '#/components/parameters/ApmDomainIdQueryParam' - $ref: '#/components/parameters/MonitorIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The monitor was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Monitor' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get the configuration of the monitor identified by the OCID. tags: - apmSynthetic put: description: Updates the monitor. operationId: UpdateMonitor parameters: - $ref: '#/components/parameters/ApmDomainIdQueryParam' - $ref: '#/components/parameters/MonitorIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The monitor was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Monitor' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the monitor identified by the OCID. tags: - apmSynthetic x-related-resource: '#/definitions/Monitor' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateMonitorDetails' description: The information to be updated. required: true /monitors/{monitorId}/actions/aggregateNetworkData: post: description: 'Gets aggregated network data for given executions. ' operationId: AggregateNetworkData parameters: - $ref: '#/components/parameters/ApmDomainIdQueryParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/MonitorIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The aggregated network data was successfully returned. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AggregatedNetworkDataResult' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets aggregated network data for given executions. tags: - apmSynthetic x-related-resource: '#/definitions/AggregatedNetworkDataResult' requestBody: content: application/json: schema: $ref: '#/components/schemas/AggregateNetworkDataDetails' description: Details of the vantage point and corresponding execution times. required: true /monitors/{monitorId}/results/{executionTime}: get: description: 'Gets the results for a specific execution of a monitor identified by OCID. The results are in a HAR file, Screenshot, Console Log, Network details, Diagnostics or Script Content. ' operationId: GetMonitorResult parameters: - $ref: '#/components/parameters/ApmDomainIdQueryParam' - $ref: '#/components/parameters/MonitorIdPathParam' - $ref: '#/components/parameters/VantagePointQueryParam' - $ref: '#/components/parameters/ResultTypeQueryParam' - $ref: '#/components/parameters/ResultContentTypeQueryParam' - $ref: '#/components/parameters/ExecutionTimePathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The monitor results (HAR file, Screenshot, Console Log, Network details, Diagnostics or Script Content) were returned. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/MonitorResult' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get monitor result(har, screenshot, log, network, diagnostics or script) identified by the execution time of the monitor identified by the OCID. tags: - apmSynthetic /onPremiseVantagePoints: get: description: 'Returns a list of On-premise vantage points. ' operationId: ListOnPremiseVantagePoints parameters: - $ref: '#/components/parameters/ApmDomainIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParamForOnPremiseVantagePoint' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The list of On-premise vantage points was returned. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/OnPremiseVantagePointCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List On-premise vantage points specified in an APM domain. tags: - apmSynthetic x-related-resource: '#/definitions/OnPremiseVantagePointCollection' post: description: 'Registers a new On-premise vantage point. ' operationId: CreateOnPremiseVantagePoint parameters: - $ref: '#/components/parameters/ApmDomainIdQueryParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The On-premise vantage point was registered. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/OnPremiseVantagePoint' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Registers a new On-premise vantage point in the specified APM domain. tags: - apmSynthetic x-related-resource: '#/definitions/OnPremiseVantagePoint' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOnPremiseVantagePointDetails' description: The configuration details for registering an On-premise vantage point. required: true /onPremiseVantagePoints/{onPremiseVantagePointId}: delete: description: Deregisters the specified On-premise vantage point. operationId: DeleteOnPremiseVantagePoint parameters: - $ref: '#/components/parameters/ApmDomainIdQueryParam' - $ref: '#/components/parameters/OnPremiseVantagePointIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The On-premise vantage point was deregistered. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deregisters an On-premise vantage point resource by OCID. tags: - apmSynthetic x-related-resource: '#/definitions/OnPremiseVantagePoint' get: description: Gets the details of the On-premise vantage point identified by the OCID. operationId: GetOnPremiseVantagePoint parameters: - $ref: '#/components/parameters/ApmDomainIdQueryParam' - $ref: '#/components/parameters/OnPremiseVantagePointIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The On-premise vantage point details were retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/OnPremiseVantagePoint' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the details of the On-premise vantage point identified by the OCID. tags: - apmSynthetic put: description: Updates the On-premise vantage point. operationId: UpdateOnPremiseVantagePoint parameters: - $ref: '#/components/parameters/ApmDomainIdQueryParam' - $ref: '#/components/parameters/OnPremiseVantagePointIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The On-premise vantage point details were updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/OnPremiseVantagePoint' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the On-premise vantage point identified by the OCID. tags: - apmSynthetic x-related-resource: '#/definitions/OnPremiseVantagePoint' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateOnPremiseVantagePointDetails' description: The information to be updated. required: true /onPremiseVantagePoints/{onPremiseVantagePointId}/workers/: get: description: 'Returns a list of workers. ' operationId: ListWorkers parameters: - $ref: '#/components/parameters/ApmDomainIdQueryParam' - $ref: '#/components/parameters/OnPremiseVantagePointIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/OnPremiseVantagePointWorkerStatusQueryParam' - $ref: '#/components/parameters/OnPremiseVantagePointWorkerCapabilityQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParamForOnPremiseVantagePointWorker' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The list of workers was returned. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkerCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List workers for specified On-premise vantage point specified in an APM domain. tags: - apmSynthetic x-related-resource: '#/definitions/WorkerCollection' post: description: 'Registers a new worker. ' operationId: CreateWorker parameters: - $ref: '#/components/parameters/ApmDomainIdQueryParam' - $ref: '#/components/parameters/OnPremiseVantagePointIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The worker for specified On-premise vantage point was registered. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Worker' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Registers a new worker for the specified On-premise vantage point in the specified APM domain. tags: - apmSynthetic x-related-resource: '#/definitions/Worker' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateWorkerDetails' description: The configuration details for registering a worker for an On-premise vantage point. required: true /onPremiseVantagePoints/{onPremiseVantagePointId}/workers/{workerId}: delete: description: Deregisters the specified worker. operationId: DeleteWorker parameters: - $ref: '#/components/parameters/ApmDomainIdQueryParam' - $ref: '#/components/parameters/OnPremiseVantagePointIdPathParam' - $ref: '#/components/parameters/WorkerIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The worker was deregistered. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deregisters a worker resource by OCID. tags: - apmSynthetic x-related-resource: '#/definitions/Worker' get: description: Gets the details of the worker identified by the OCID. operationId: GetWorker parameters: - $ref: '#/components/parameters/ApmDomainIdQueryParam' - $ref: '#/components/parameters/OnPremiseVantagePointIdPathParam' - $ref: '#/components/parameters/WorkerIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The worker details were retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Worker' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Gets the details of the worker identified by the OCID. tags: - apmSynthetic x-related-resource: '#/definitions/Worker' put: description: Updates the worker. operationId: UpdateWorker parameters: - $ref: '#/components/parameters/ApmDomainIdQueryParam' - $ref: '#/components/parameters/OnPremiseVantagePointIdPathParam' - $ref: '#/components/parameters/WorkerIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The worker details were updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Worker' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates the worker identified by the OCID. tags: - apmSynthetic x-related-resource: '#/definitions/Worker' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateWorkerDetails' description: The information to be updated. required: true /publicVantagePoints: get: description: 'Returns a list of public vantage points. ' operationId: ListPublicVantagePoints parameters: - $ref: '#/components/parameters/ApmDomainIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of the list of public vantage points was returned. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PublicVantagePointCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List public vantage points specified in an APM domain. tags: - apmSynthetic x-related-resource: '#/definitions/PublicVantagePointCollection' /scripts: get: description: 'Returns a list of scripts. ' operationId: ListScripts parameters: - $ref: '#/components/parameters/ApmDomainIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/ContentTypeQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParamForScript' responses: 200: description: A page of the list of scripts was returned. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ScriptCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List scripts specified in an APM domain. tags: - apmSynthetic x-related-resource: '#/definitions/ScriptCollection' post: description: 'Creates a new script. ' operationId: CreateScript parameters: - $ref: '#/components/parameters/ApmDomainIdQueryParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The script was created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Script' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new script in the given APM domain. tags: - apmSynthetic requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateScriptDetails' description: The configuration details for creating a script. required: true /scripts/{scriptId}: delete: description: Deletes the specified script. operationId: DeleteScript parameters: - $ref: '#/components/parameters/ApmDomainIdQueryParam' - $ref: '#/components/parameters/ScriptIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The script was deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete the script resource identified by OCID. tags: - apmSynthetic x-related-resource: '#/definitions/Script' get: description: Gets the configuration of the script identified by the OCID. operationId: GetScript parameters: - $ref: '#/components/parameters/ApmDomainIdQueryParam' - $ref: '#/components/parameters/ScriptIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The script was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Script' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get the configuration of the script identified by the OCID. tags: - apmSynthetic put: description: Updates the script. operationId: UpdateScript parameters: - $ref: '#/components/parameters/ApmDomainIdQueryParam' - $ref: '#/components/parameters/ScriptIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The script was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Script' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the script identified by the OCID. tags: - apmSynthetic x-related-resource: '#/definitions/Script' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateScriptDetails' description: The information to be updated. required: true components: schemas: CreateScriptDetails: description: '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 Side, JavaScript and TypeScript formats only. ' properties: content: description: 'The content of the script. It may contain custom-defined tags that can be used for setting dynamic parameters. The format to set dynamic parameters is: `param nameparam valueisParamValueSecret(true/false)`. Param value and isParamValueSecret are optional, the default value for isParamValueSecret is false. Examples: With mandatory param name : `param name` With parameter name and value : `param nameparam value` Note that the content is valid if it matches the given content type. For example, if the content type is SIDE, then the content should be in Side script format. If the content type is JS, then the content should be in JavaScript format. If the content type is PLAYWRIGHT_TS, then the content should be in TypeScript format. ' example: '{"id":"f672ea8c-9508-483e-a123-878920eee73b","version":"2.0","name":"Sample Project","url":"https://my.oracle.com","tests":[{"id":"b4522766-e382-40c2-ab01-452cf62e1ced","name":"testNamemyTestfalse","commands":[{"id":"d1bc2093-bb61-4919-a554-38ef2653ac01","comment":"comment","command":"open","target":"/","targets":[["css=td.bodytext","css"]],"value":"xyz"}]}],"suites":[{"id":"a86b2934-7aa3-4838-b389-93c8aea2af04","name":"Default Suite","persistSession":false,"parallel":false,"timeout":300,"tests":["b4522766-e382-40c2-ab01-452cf62e1ced"]}],"urls":["https//my.oracle.com/"],"plugins":["xxx"]}' maxLength: 65536 minLength: 1 type: string contentFileName: default: script.side description: File name of uploaded script content. example: testscript.side maxLength: 1024 minLength: 1 type: string contentType: description: Content type of script. enum: - SIDE - JS - PLAYWRIGHT_TS example: SIDE type: string x-obmcs-top-level-enum: '#/definitions/ContentTypes' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' example: foo-namespace: bar-key: value type: object displayName: description: Unique name that can be edited. The name should not contain any confidential information. example: exampleName maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' example: bar-key: value type: object parameters: description: 'List of script parameters. Example: `[{"paramName": "userid", "paramValue":"testuser", "isSecret": false}]` ' example: - isSecret: false paramName: testName paramValue: openPage items: $ref: '#/components/schemas/ScriptParameter' maxItems: 50 type: array required: - displayName - content - contentType type: object Error: description: Details of an error that occurred. properties: code: description: A short error code that defines the error, meant for programmatic parsing. type: string message: description: A human-readable error string. type: string required: - code - message CreateMonitorDetails: description: Details of the request body used to create a new monitor. properties: availabilityConfiguration: $ref: '#/components/schemas/AvailabilityConfiguration' batchIntervalInSeconds: description: Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN). example: 600 type: integer configuration: $ref: '#/components/schemas/MonitorConfiguration' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' example: foo-namespace: bar-key: value type: object displayName: description: Unique name that can be edited. The name should not contain any confidential information. example: exampleName maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' example: bar-key: value type: object isIPv6: default: false description: If enabled, domain name will resolve to an IPv6 address. example: true type: boolean isRunNow: default: false description: If isRunNow is enabled, then the monitor will run immediately. example: true type: boolean isRunOnce: default: false description: If runOnce is enabled, then the monitor will run once. example: true type: boolean maintenanceWindowSchedule: $ref: '#/components/schemas/MaintenanceWindowSchedule' monitorType: default: SCRIPTED_BROWSER description: Type of monitor. enum: - SCRIPTED_BROWSER - BROWSER - SCRIPTED_REST - REST - NETWORK - DNS - FTP - SQL example: SCRIPTED_BROWSER type: string x-obmcs-top-level-enum: '#/definitions/MonitorTypes' repeatIntervalInSeconds: description: '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. ' example: 600 type: integer schedulingPolicy: description: Scheduling policy to decide the distribution of monitor executions on vantage points. enum: - ALL - ROUND_ROBIN - BATCHED_ROUND_ROBIN type: string x-obmcs-top-level-enum: '#/definitions/SchedulingPolicy' scriptId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) 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. ' example: ocid1.apmsyntheticscript.oc1.phx.aaaaaaaanmvshzvtvvv7uh43f73f37wytshyh46zj2hinnavme6xzbfiw7tq maxLength: 255 minLength: 1 type: string scriptParameters: description: 'List of script parameters in the monitor. This is valid only for SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null. Example: `[{"paramName": "userid", "paramValue":"testuser"}]` ' example: - paramName: testName paramValue: openPageMonitor items: $ref: '#/components/schemas/MonitorScriptParameter' maxItems: 50 type: array status: default: ENABLED description: Enables or disables the monitor. enum: - ENABLED - DISABLED - INVALID example: ENABLED type: string x-obmcs-top-level-enum: '#/definitions/MonitorStatus' target: description: '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. ' example: https://www.oracle.com/index.html maxLength: 4000 type: string x-default-description: 'null' timeoutInSeconds: description: '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. ' example: 180 maximum: 900 type: integer vantagePoints: description: 'A list of public and dedicated vantage points from which to execute the monitor. Use /publicVantagePoints to fetch public vantage points, and /dedicatedVantagePoints to fetch dedicated vantage points. ' example: - us-phoenix items: maximum: 255 minimum: 1 type: string maxItems: 200 minItems: 1 type: array uniqueItems: true required: - displayName - vantagePoints - repeatIntervalInSeconds - monitorType type: object DvpStackDetails: description: Details of a Dedicated Vantage Point (DVP) stack in Resource Manager. discriminator: propertyName: dvpStackType properties: dvpStackType: description: Type of stack. enum: - ORACLE_RM_STACK type: string dvpVersion: description: Version of the dedicated vantage point. maxLength: 120 minLength: 1 type: string required: - dvpVersion - dvpStackType type: object PublicVantagePointCollection: description: The results of a public vantage point search, which contains PublicVantagePointSummary items and other data in an APM domain. properties: items: description: List of PublicVantagePointSummary items. items: $ref: '#/components/schemas/PublicVantagePointSummary' type: array required: - items type: object DedicatedVantagePointSummary: description: Information about dedicated vantage points. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' example: foo-namespace: bar-key: value type: object displayName: description: Unique dedicated vantage point name that cannot be edited. The name should not contain any confidential information. example: exampleName maxLength: 50 minLength: 1 type: string dvpStackDetails: $ref: '#/components/schemas/DvpStackDetails' freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' example: bar-key: value type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the dedicated vantage point. maxLength: 255 minLength: 1 type: string monitorStatusCountMap: $ref: '#/components/schemas/MonitorStatusCountMap' name: description: Unique permanent name of the vantage point. example: DedicatedVP-us-phoenix-1 maxLength: 50 minLength: 1 type: string region: description: Name of the region. example: us-phoenix-1 maxLength: 50 minLength: 1 type: string status: description: Status of the dedicated vantage point. enum: - ENABLED - DISABLED type: string x-obmcs-top-level-enum: '#/definitions/DedicatedVantagePointStatus' timeCreated: description: 'The time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-12T22:47:12.613Z` ' format: date-time type: string timeUpdated: description: 'The time the resource was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-13T22:47:12.613Z` ' format: date-time type: string required: - id - displayName - name - status - dvpStackDetails - region - monitorStatusCountMap type: object OnPremiseVantagePointSummary: description: Information about On-premise vantage point. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' example: foo-namespace: bar-key: value type: object description: description: A short description about the On-premise vantage point. maxLength: 1024 type: string displayName: description: Unique permanent name of the On-premise vantage point. example: OracleOPVP-exampleName maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' example: bar-key: value type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the On-premise vantage point. maxLength: 255 minLength: 1 type: string name: description: Unique On-premise vantage point name that cannot be edited. The name should not contain any confidential information. example: exampleName maxLength: 255 minLength: 1 type: string timeCreated: description: 'The time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-12T22:47:12.613Z` ' format: date-time type: string timeUpdated: description: 'The time the resource was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-13T22:47:12.613Z` ' format: date-time type: string type: description: Type of On-premise vantage point. enum: - ON_PREMISE_DOCKER_VANTAGE_POINT type: string workersSummary: $ref: '#/components/schemas/WorkersSummary' required: - id - displayName - name - type - workersSummary type: object UpdateDedicatedVantagePointDetails: description: Details of the request body used to update a dedicated vantage point. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' example: foo-namespace: bar-key: value type: object dvpStackDetails: $ref: '#/components/schemas/DvpStackDetails' freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' example: bar-key: value type: object region: description: Name of the region. example: us-phoenix-1 maxLength: 50 minLength: 1 type: string status: description: Status of the dedicated vantage point. enum: - ENABLED - DISABLED type: string x-obmcs-top-level-enum: '#/definitions/DedicatedVantagePointStatus' type: object MonitorResult: description: The monitor result for a specific execution. properties: executionTime: description: The specific point of time when the result of an execution is collected. example: 1603790400000 maxLength: 50 minLength: 1 type: string monitorId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the monitor. example: ocid1.apmsyntheticmonitor.oc1.phx.aaaaaaaaztadaitwuj3z2w6txyrqo5khbrkbank5avu7t3jglkbux3aifhva maxLength: 255 minLength: 1 type: string resultContentType: description: 'Type of result content. Example: Zip or Raw file. ' type: string resultDataSet: description: Monitor result data set. items: $ref: '#/components/schemas/MonitorResultData' type: array resultType: description: 'Type of result. Example: har, screenshot, log, network, diagnostics or script. ' type: string vantagePoint: description: The name of the public or dedicated vantage point. example: us-phoenix maxLength: 50 minLength: 1 type: string required: - resultContentType type: object ScriptParameterInfo: description: 'Information about script parameters. isOverwritten specifies that the default parameter present in the script content is overwritten. ' properties: isOverwritten: description: 'If parameter value is default or overwritten. ' example: false type: boolean scriptParameter: $ref: '#/components/schemas/ScriptParameter' required: - scriptParameter - isOverwritten type: object UpdateScriptDetails: description: '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, JavaScript and TypeScript formats only. ' properties: content: description: 'The content of the script. It may contain custom-defined tags that can be used for setting dynamic parameters. The format to set dynamic parameters is: `param nameparam valueisParamValueSecret(true/false)`. Param value and isParamValueSecret are optional, the default value for isParamValueSecret is false. Examples: With mandatory param name : `param name` With parameter name and value : `param nameparam value` Note that the content is valid if it matches the given content type. For example, if the content type is SIDE, then the content should be in Side script format. If the content type is JS, then the content should be in JavaScript format. If the content type is PLAYWRIGHT_TS, then the content should be in TypeScript format. ' example: '{"id":"f672ea8c-9508-483e-a123-878920eee73b","version":"2.0","name":"Sample Project","url":"https://my.oracle.com","tests":[{"id":"b4522766-e382-40c2-ab01-452cf62e1ced","name":"testNamemyTestfalse","commands":[{"id":"d1bc2093-bb61-4919-a554-38ef2653ac01","comment":"comment","command":"open","target":"/","targets":[["css=td.bodytext","css"]],"value":"xyz"}]}],"suites":[{"id":"a86b2934-7aa3-4838-b389-93c8aea2af04","name":"Default Suite","persistSession":false,"parallel":false,"timeout":300,"tests":["b4522766-e382-40c2-ab01-452cf62e1ced"]}],"urls":["https//my.oracle.com/"],"plugins":["xxx"]}' maxLength: 65536 minLength: 1 type: string contentFileName: description: File name of uploaded script content. example: testscript.side maxLength: 1024 minLength: 1 type: string contentType: description: Content type of script. enum: - SIDE - JS - PLAYWRIGHT_TS example: SIDE type: string x-obmcs-top-level-enum: '#/definitions/ContentTypes' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' example: foo-namespace: bar-key: value type: object displayName: description: Unique name that can be edited. The name should not contain any confidential information. example: exampleName maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' example: bar-key: value type: object parameters: description: 'List of script parameters. Example: `[{"paramName": "userid", "paramValue":"testuser", "isSecret": false}]` ' example: - isSecret: false paramName: testName paramValue: openPage items: $ref: '#/components/schemas/ScriptParameter' maxItems: 50 type: array type: object WorkerCollection: description: The results of an On-premise VP worker search, which contains WorkerSummary items and other data in an APM domain. properties: items: description: List of WorkerSummary items. items: $ref: '#/components/schemas/WorkerSummary' type: array required: - items type: object AggregateNetworkDataDetails: description: Details of the vantage point and corresponding execution times. properties: vantagePointExecutionTimes: description: List of VantagePointExecution items. example: - executions: - 1603790400000 - 1603790500000 name: us-phoenix-1 items: $ref: '#/components/schemas/VantagePointExecution' maxItems: 100 type: array required: - vantagePointExecutionTimes type: object CreateOnPremiseVantagePointDetails: description: Details of the request body used to create a new On-premise vantage point. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' example: foo-namespace: bar-key: value type: object description: description: A short description about the On-premise vantage point. maxLength: 1024 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' example: bar-key: value type: object name: description: Unique On-premise vantage point name that cannot be edited. The name should not contain any confidential information. example: exampleName maxLength: 255 minLength: 1 type: string type: default: ON_PREMISE_DOCKER_VANTAGE_POINT description: Type of On-premise vantage point. enum: - ON_PREMISE_DOCKER_VANTAGE_POINT example: ON_PREMISE_DOCKER_VANTAGE_POINT type: string required: - name type: object VantagePointInfo: description: Details of the vantage point. properties: displayName: description: Unique name that can be edited. The name should not contain any confidential information. example: exampleName maxLength: 255 minLength: 1 type: string name: description: Name of the vantage point. example: us_phoenix minLength: 1 type: string workerList: description: List of workers running the assigned monitor. example: - testWorker items: maximum: 255 minimum: 1 type: string maxItems: 200 type: array uniqueItems: true required: - name - displayName type: object MaintenanceWindowSchedule: description: Details required to schedule maintenance window. properties: timeEnded: description: 'End time of the maintenance window, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-12T22:47:12.613Z` ' format: date-time type: string timeStarted: description: 'Start time of the maintenance window, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-12T22:47:12.613Z` ' format: date-time type: string type: object ScriptCollection: description: The results of a script search, which contains both ScriptSummary items and other data in an APM domain. properties: items: description: List of ScriptSummary items. items: $ref: '#/components/schemas/ScriptSummary' type: array required: - items type: object AggregatedNetworkData: description: Details of the aggregated network data. properties: errorDetails: description: String containing error details. type: string links: additionalProperties: $ref: '#/components/schemas/Link' description: Map of link objects. type: object nodesByLevel: description: An array of node arrays where each internal array corresponds to nodes at one level. items: items: $ref: '#/components/schemas/Node' maxItems: 10 type: array maxItems: 255 type: array resultState: description: Status of the aggregated network data result. enum: - SUCCESS - FAILURE - PARTIAL type: string vantagePointNodes: description: List of vantage point nodes. items: $ref: '#/components/schemas/VantagePointNode' maxItems: 100 type: array required: - resultState type: object MonitorConfiguration: description: Details of monitor configuration. discriminator: propertyName: configType properties: configType: description: Type of configuration. enum: - BROWSER_CONFIG - SCRIPTED_BROWSER_CONFIG - REST_CONFIG - SCRIPTED_REST_CONFIG - NETWORK_CONFIG - DNS_SERVER_CONFIG - DNS_TRACE_CONFIG - DNSSEC_CONFIG - FTP_CONFIG - SQL_CONFIG type: string dnsConfiguration: $ref: '#/components/schemas/DnsConfiguration' isFailureRetried: default: true description: If isFailureRetried is enabled, then a failed call will be retried. example: true type: boolean type: object AvailabilityConfiguration: description: Monitor availability configuration details. properties: maxAllowedFailuresPerInterval: description: 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. format: int32 type: integer minAllowedRunsPerInterval: description: 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. format: int32 type: integer type: object Script: description: The information about the script. properties: content: description: 'The content of the script. It may contain custom-defined tags that can be used for setting dynamic parameters. The format to set dynamic parameters is: `param nameparam valueisParamValueSecret(true/false)`. Param value and isParamValueSecret are optional, the default value for isParamValueSecret is false. Examples: With mandatory param name : `param name` With parameter name and value : `param nameparam value` Note that the content is valid if it matches the given content type. For example, if the content type is SIDE, then the content should be in Side script format. If the content type is JS, then the content should be in JavaScript format. If the content type is PLAYWRIGHT_TS, then the content should be in TypeScript format. ' example: '{"id":"f672ea8c-9508-483e-a123-878920eee73b","version":"2.0","name":"Sample Project","url":"https://my.oracle.com","tests":[{"id":"b4522766-e382-40c2-ab01-452cf62e1ced","name":"testNamemyTestfalse","commands":[{"id":"d1bc2093-bb61-4919-a554-38ef2653ac01","comment":"comment","command":"open","target":"/","targets":[["css=td.bodytext","css"]],"value":"xyz"}]}],"suites":[{"id":"a86b2934-7aa3-4838-b389-93c8aea2af04","name":"Default Suite","persistSession":false,"parallel":false,"timeout":300,"tests":["b4522766-e382-40c2-ab01-452cf62e1ced"]}],"urls":["https//my.oracle.com/"],"plugins":["xxx"]}' maxLength: 65536 minLength: 1 type: string contentFileName: description: File name of the uploaded script content. type: string contentSizeInBytes: description: Size of the script content. type: integer contentType: description: Content type of the script. enum: - SIDE - JS - PLAYWRIGHT_TS type: string x-obmcs-top-level-enum: '#/definitions/ContentTypes' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' example: foo-namespace: bar-key: value type: object displayName: description: Unique name that can be edited. The name should not contain any confidential information. example: exampleName maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' example: bar-key: value type: object id: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) 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. ' example: ocid1.apmsyntheticscript.oc1.phx.aaaaaaaanmvshzvtvvv7uh43f73f37wytshyh46zj2hinnavme6xzbfiw7tq maxLength: 255 minLength: 1 type: string monitorStatusCountMap: $ref: '#/components/schemas/MonitorStatusCountMap' parameters: description: 'List of script parameters. Example: `[{"scriptParameter": {"paramName": "userid", "paramValue":"testuser", "isSecret": false}, "isOverwritten": false}]` ' example: - isOverwritten: false isSecret: false paramName: testName paramValue: openPage items: $ref: '#/components/schemas/ScriptParameterInfo' maxItems: 50 type: array timeCreated: description: 'The time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-12T22:47:12.613Z` ' format: date-time type: string timeUpdated: description: 'The time the resource was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-13T22:47:12.613Z` ' format: date-time type: string timeUploaded: description: The time the script was uploaded. format: date-time type: string required: - id - contentType - displayName - monitorStatusCountMap type: object IdentityInfoDetails: description: Domain details of the On-premise VP worker. properties: apmShortId: description: Domain short id of the On-premise VP worker. type: string collectorEndPoint: description: Collector endpoint of the On-premise VP worker. type: string regionName: description: Domain region of the On-premise VP worker. type: string required: - regionName - apmShortId - collectorEndPoint type: object DedicatedVantagePoint: description: The information about a dedicated vantage point. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' example: foo-namespace: bar-key: value type: object displayName: description: Unique dedicated vantage point name that cannot be edited. The name should not contain any confidential information. example: exampleName maxLength: 50 minLength: 1 type: string dvpStackDetails: $ref: '#/components/schemas/DvpStackDetails' freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' example: bar-key: value type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the dedicated vantage point. maxLength: 255 minLength: 1 type: string monitorStatusCountMap: $ref: '#/components/schemas/MonitorStatusCountMap' name: description: Unique permanent name of the dedicated vantage point. This is the same as the displayName. example: DedicatedVP-us-phoenix-1 maxLength: 50 minLength: 1 type: string region: description: Name of the region. example: us-phoenix-1 maxLength: 50 minLength: 1 type: string status: description: Status of the dedicated vantage point. enum: - ENABLED - DISABLED type: string x-obmcs-top-level-enum: '#/definitions/DedicatedVantagePointStatus' timeCreated: description: 'The time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-12T22:47:12.613Z` ' format: date-time type: string timeUpdated: description: 'The time the resource was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-13T22:47:12.613Z` ' format: date-time type: string required: - id - displayName - name - status - dvpStackDetails - region - monitorStatusCountMap type: object ScriptSummary: description: Information about the script. properties: contentType: description: Content type of the script. enum: - SIDE - JS - PLAYWRIGHT_TS type: string x-obmcs-top-level-enum: '#/definitions/ContentTypes' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' example: foo-namespace: bar-key: value type: object displayName: description: Unique name that can be edited. The name should not contain any confidential information. example: exampleName maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' example: bar-key: value type: object id: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) 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. ' example: ocid1.apmsyntheticscript.oc1.phx.aaaaaaaanmvshzvtvvv7uh43f73f37wytshyh46zj2hinnavme6xzbfiw7tq maxLength: 255 minLength: 1 type: string monitorStatusCountMap: $ref: '#/components/schemas/MonitorStatusCountMap' timeCreated: description: 'The time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-12T22:47:12.613Z` ' format: date-time type: string timeUpdated: description: 'The time the resource was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-13T22:47:12.613Z` ' format: date-time type: string required: - id - displayName - monitorStatusCountMap - contentType type: object VantagePointNode: description: Details of the vantage point node. properties: displayName: description: Display name of the vantage point node. type: string geoInfo: description: Geographical information of the vantage point node. type: string id: description: ID of the vantage point node. type: string name: description: Name of the vantage point node. type: string outgoingLinks: description: Outgoing links from the vantage point node. items: type: string maxItems: 100 type: array required: - name type: object WorkersSummary: description: 'Details of the workers in a specific On-premise vantage point. ' properties: available: default: 0 description: Number of available workers in a specific On-premise vantage point. example: 2 type: integer availableCapabilities: description: List of available capabilities in a specific On-premise vantage point. items: $ref: '#/components/schemas/AvailableCapability' maxItems: 100 type: array disabled: default: 0 description: Number of disabled workers in a specific On-premise vantage point. example: 2 type: integer minVersion: description: Minimum version among the workers in a specific On-premise vantage point. maxLength: 120 minLength: 1 type: string total: default: 0 description: Total number of workers in a specific On-premise vantage point. example: 5 type: integer used: default: 0 description: Number of occupied workers in a specific On-premise vantage point. example: 2 type: integer required: - total - available - used - disabled - minVersion - availableCapabilities type: object UpdateMonitorDetails: description: Details of the request body used to update a monitor. properties: availabilityConfiguration: $ref: '#/components/schemas/AvailabilityConfiguration' batchIntervalInSeconds: description: Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN). example: 600 type: integer configuration: $ref: '#/components/schemas/MonitorConfiguration' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' example: foo-namespace: bar-key: value type: object displayName: description: Unique name that can be edited. The name should not contain any confidential information. example: exampleName maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' example: bar-key: value type: object isIPv6: default: false description: If enabled, domain name will resolve to an IPv6 address. example: true type: boolean isRunNow: default: false description: If isRunNow is enabled, then the monitor will run immediately. example: true type: boolean isRunOnce: default: false description: If runOnce is enabled, then the monitor will run once. example: true type: boolean maintenanceWindowSchedule: $ref: '#/components/schemas/MaintenanceWindowSchedule' repeatIntervalInSeconds: description: '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. ' example: 600 type: integer schedulingPolicy: description: Scheduling policy to decide the distribution of monitor executions on vantage points. enum: - ALL - ROUND_ROBIN - BATCHED_ROUND_ROBIN type: string x-obmcs-top-level-enum: '#/definitions/SchedulingPolicy' scriptId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) 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. ' example: ocid1.apmsyntheticscript.oc1.phx.aaaaaaaanmvshzvtvvv7uh43f73f37wytshyh46zj2hinnavme6xzbfiw7tq maxLength: 255 minLength: 1 type: string scriptParameters: description: 'List of script parameters in the monitor. This is valid only for SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null. Example: `[{"paramName": "userid", "paramValue":"testuser"}]` ' example: - paramName: testName paramValue: openPageMonitor items: $ref: '#/components/schemas/MonitorScriptParameter' maxItems: 50 type: array status: default: ENABLED description: Enables or disables the monitor. enum: - ENABLED - DISABLED - INVALID example: ENABLED type: string x-obmcs-top-level-enum: '#/definitions/MonitorStatus' target: description: '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. ' example: https://www.oracle.com/index.html maxLength: 4000 type: string x-default-description: 'null' timeoutInSeconds: description: '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. ' maximum: 900 type: integer vantagePoints: description: 'A list of public and dedicated vantage points from which to execute the monitor. Use /publicVantagePoints to fetch public vantage points, and /dedicatedVantagePoints to fetch dedicated vantage points. ' items: maxLength: 255 minLength: 1 type: string maxItems: 200 minItems: 1 type: array uniqueItems: true type: object MonitorResultData: description: Details of the monitor result data. properties: byteContent: description: 'Data content in byte format. Example: Zip or Screenshot. ' format: byte type: string name: description: Name of the data. example: name.zip maxLength: 255 minLength: 1 type: string stringContent: description: 'Data content in string format. Example: HAR. ' type: string timestamp: description: 'The time when the data was generated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-13T22:47:12.613Z` ' format: date-time type: string type: object Link: description: Details of the link between two nodes. properties: delayInMilliseconds: description: Difference of the packet response time between source and destination nodes, in milliseconds. format: double type: number destination: description: ID of the destination node. type: string forwardingLoss: description: Average packet loss. format: double type: number id: description: ID of the link. type: string maxDelayInMilliseconds: description: Maximum delay in milliseconds. format: double type: number minDelayInMilliseconds: description: Minimum delay in milliseconds. format: double type: number paths: description: List of all path IDs of which this link is part of. example: - path-id1 - path-id2 items: type: string maxItems: 1000 type: array repeatCount: description: Number of times the link is repeated. type: integer source: description: ID of the source node. type: string required: - id type: object GeoSummary: description: Geographic summary of a vantage point. properties: adminDivCode: description: 'The ISO 3166-2 code for this location''s first-level administrative division, either a US state or Canadian province. Only included for locations in the US or Canada. For a list of codes, see Country Codes. ' example: kr type: string cityName: description: Common English-language name for the city. example: seoul type: string countryCode: description: The ISO 3166-1 alpha-2 country code. For a list of codes, see Country Codes. example: kr type: string countryName: description: The common English-language name for the country. example: South Korea type: string latitude: description: Degrees north of the equator. example: 37.5665 format: double type: number longitude: description: Degrees east of the prime meridian. example: 126.978 format: double type: number type: object Node: description: Details of the network node. properties: avgPacketLossPercent: description: Percentage of the average packet loss. format: double type: number avgPacketResponseTimeInMs: description: Average packet response time in milliseconds. format: double type: number consecutiveAnonymousCount: description: Number of consecutive anonymous network nodes. type: integer displayName: description: Display name of the network node. type: string geoInfo: description: Geographical information of the network node. type: string id: description: ID of the network node. type: string ipAddress: description: IP address of the network node. type: string level: description: Level of the network node. type: integer outgoingLinks: description: Outgoing links from the network node. items: type: string maxItems: 100 type: array type: description: Type of network node. enum: - SOURCE - DESTINATION - ANONYMOUS - INTERNAL - DANGLING type: string required: - id type: object DedicatedVantagePointCollection: description: The results of a dedicated vantage point search, which contains DedicatedVantagePointSummary items and other data in an APM domain. properties: items: description: List of DedicatedVantagePointSummary items. items: $ref: '#/components/schemas/DedicatedVantagePointSummary' type: array required: - items type: object OnPremiseVantagePointCollection: description: The results of an On-premise vantage point search, which contains OnPremiseVantagePointSummary items and other data in an APM domain. properties: items: description: List of OnPremiseVantagePointSummary items. items: $ref: '#/components/schemas/OnPremiseVantagePointSummary' type: array required: - items type: object OnPremiseVpWorkerVersionDetails: description: Image version details of the On-premise VP worker. properties: latestVersion: description: Latest image version of the On-premise VP worker. maxLength: 120 minLength: 1 type: string minSupportedVersion: description: Minimum supported image version of the On-premise VP worker. maxLength: 120 minLength: 1 type: string version: description: Current image version of the On-premise VP worker. maxLength: 120 minLength: 1 type: string required: - version - minSupportedVersion - latestVersion type: object MonitorSummary: description: Information about the monitor. properties: batchIntervalInSeconds: description: Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN). example: 600 type: integer configuration: $ref: '#/components/schemas/MonitorConfiguration' createdBy: description: Name of the user that created the monitor. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' example: foo-namespace: bar-key: value type: object displayName: description: Unique name that can be edited. The name should not contain any confidential information. example: exampleName maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' example: bar-key: value type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the monitor. example: ocid1.apmsyntheticmonitor.oc1.phx.aaaaaaaaztadaitwuj3z2w6txyrqo5khbrkbank5avu7t3jglkbux3aifhva maxLength: 255 minLength: 1 type: string isIPv6: default: false description: If enabled, domain name will resolve to an IPv6 address. example: true type: boolean isRunNow: default: false description: If isRunNow is enabled, then the monitor will run immediately. example: true type: boolean isRunOnce: default: false description: If runOnce is enabled, then the monitor will run once. example: true type: boolean lastUpdatedBy: description: Name of the user that recently updated the monitor. maxLength: 255 minLength: 1 type: string maintenanceWindowSchedule: $ref: '#/components/schemas/MaintenanceWindowSchedule' monitorType: description: The type of monitor. enum: - SCRIPTED_BROWSER - BROWSER - SCRIPTED_REST - REST - NETWORK - DNS - FTP - SQL type: string x-obmcs-top-level-enum: '#/definitions/MonitorTypes' repeatIntervalInSeconds: description: '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. ' example: 600 type: integer schedulingPolicy: description: Scheduling policy to decide the distribution of monitor executions on vantage points. enum: - ALL - ROUND_ROBIN - BATCHED_ROUND_ROBIN type: string x-obmcs-top-level-enum: '#/definitions/SchedulingPolicy' scriptId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) 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. ' example: ocid1.apmsyntheticscript.oc1.phx.aaaaaaaanmvshzvtvvv7uh43f73f37wytshyh46zj2hinnavme6xzbfiw7tq maxLength: 255 minLength: 1 type: string scriptName: description: Name of the script. example: testScript maxLength: 255 minLength: 1 type: string status: description: Enables or disables the monitor. enum: - ENABLED - DISABLED - INVALID type: string x-obmcs-top-level-enum: '#/definitions/MonitorStatus' target: description: '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. ' example: https://www.oracle.com/index.html maxLength: 4000 type: string x-default-description: 'null' timeCreated: description: 'The time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-12T22:47:12.613Z` ' format: date-time type: string timeUpdated: description: 'The time the resource was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-13T22:47:12.613Z` ' format: date-time type: string timeoutInSeconds: description: '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. ' type: integer vantagePointCount: description: Number of vantage points where monitor is running. example: 2 type: integer vantagePoints: description: List of public, dedicated and onPremise vantage points where the monitor is running. items: $ref: '#/components/schemas/VantagePointInfo' type: array required: - id - displayName - monitorType - vantagePoints - vantagePointCount - scriptId - scriptName - repeatIntervalInSeconds - timeoutInSeconds - status - isRunOnce - isRunNow - schedulingPolicy - batchIntervalInSeconds type: object CreateDedicatedVantagePointDetails: description: Details of the request body used to create a new dedicated vantage point. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' example: foo-namespace: bar-key: value type: object displayName: description: Unique dedicated vantage point name that cannot be edited. The name should not contain any confidential information. example: exampleName maxLength: 50 minLength: 1 type: string dvpStackDetails: $ref: '#/components/schemas/DvpStackDetails' freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' example: bar-key: value type: object region: description: Name of the region. example: us-phoenix-1 maxLength: 50 minLength: 1 type: string status: default: ENABLED description: Status of the dedicated vantage point. enum: - ENABLED - DISABLED example: ENABLED type: string x-obmcs-top-level-enum: '#/definitions/DedicatedVantagePointStatus' required: - displayName - dvpStackDetails - region type: object DnsConfiguration: description: Information about the DNS settings. properties: isOverrideDns: default: false description: If isOverrideDns is true, then DNS settings will be overridden. example: true type: boolean overrideDnsIp: description: Attribute to override the DNS IP value. This value will be honored only if isOverrideDns is set to true. example: 10.10.10.10 maxLength: 45 minLength: 2 type: string type: object Monitor: description: The information about a monitor. properties: availabilityConfiguration: $ref: '#/components/schemas/AvailabilityConfiguration' batchIntervalInSeconds: description: Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN). example: 600 type: integer configuration: $ref: '#/components/schemas/MonitorConfiguration' contentType: description: Content type of the script. enum: - SIDE - JS - PLAYWRIGHT_TS type: string x-obmcs-top-level-enum: '#/definitions/ContentTypes' createdBy: description: Name of the user that created the monitor. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' example: foo-namespace: bar-key: value type: object displayName: description: Unique name that can be edited. The name should not contain any confidential information. example: exampleName maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' example: bar-key: value type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the monitor. example: ocid1.apmsyntheticmonitor.oc1.phx.aaaaaaaaztadaitwuj3z2w6txyrqo5khbrkbank5avu7t3jglkbux3aifhva maxLength: 255 minLength: 1 type: string isIPv6: default: false description: If enabled, domain name will resolve to an IPv6 address. example: true type: boolean isRunNow: default: false description: If isRunNow is enabled, then the monitor will run immediately. example: true type: boolean isRunOnce: default: false description: If runOnce is enabled, then the monitor will run once. example: true type: boolean lastUpdatedBy: description: Name of the user that recently updated the monitor. maxLength: 255 minLength: 1 type: string maintenanceWindowSchedule: $ref: '#/components/schemas/MaintenanceWindowSchedule' monitorType: description: Type of monitor. enum: - SCRIPTED_BROWSER - BROWSER - SCRIPTED_REST - REST - NETWORK - DNS - FTP - SQL type: string x-obmcs-top-level-enum: '#/definitions/MonitorTypes' repeatIntervalInSeconds: description: '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. ' example: 600 type: integer schedulingPolicy: description: Scheduling policy to decide the distribution of monitor executions on vantage points. enum: - ALL - ROUND_ROBIN - BATCHED_ROUND_ROBIN type: string x-obmcs-top-level-enum: '#/definitions/SchedulingPolicy' scriptId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) 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. ' example: ocid1.apmsyntheticscript.oc1.phx.aaaaaaaanmvshzvtvvv7uh43f73f37wytshyh46zj2hinnavme6xzbfiw7tq maxLength: 255 minLength: 1 type: string scriptName: description: Name of the script. example: testScript maxLength: 255 minLength: 1 type: string scriptParameters: description: 'List of script parameters. Example: `[{"monitorScriptParameter": {"paramName": "userid", "paramValue":"testuser"}, "isSecret": false, "isOverwritten": false}]` ' example: - isOverwritten: false isSecret: false paramName: testName paramValue: openPageMonitor items: $ref: '#/components/schemas/MonitorScriptParameterInfo' maxItems: 50 type: array status: description: Enables or disables the monitor. enum: - ENABLED - DISABLED - INVALID type: string x-obmcs-top-level-enum: '#/definitions/MonitorStatus' target: description: '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. ' example: https://www.oracle.com/index.html maxLength: 4000 type: string x-default-description: 'null' timeCreated: description: 'The time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-12T22:47:12.613Z` ' format: date-time type: string timeUpdated: description: 'The time the resource was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-13T22:47:12.613Z` ' format: date-time type: string timeoutInSeconds: description: '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. ' maximum: 900 type: integer vantagePointCount: description: Number of vantage points where monitor is running. example: 2 type: integer vantagePoints: description: List of public, dedicated and onPremise vantage points where the monitor is running. items: $ref: '#/components/schemas/VantagePointInfo' type: array required: - id - displayName - monitorType - vantagePoints - vantagePointCount - scriptId - scriptName - repeatIntervalInSeconds - timeoutInSeconds - status - isRunOnce - isRunNow - schedulingPolicy - batchIntervalInSeconds type: object AvailableCapability: description: Available capability in a specific On-premise vantage point. properties: capability: description: Capability of an On-premise vantage point worker. type: string count: description: Count of available capability in a specific On-premise vantage point. example: 2 type: integer required: - capability - count type: object Worker: description: The information about an On-premise VP worker. properties: configurationDetails: description: Configuration details of the On-premise VP worker. type: object definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' example: foo-namespace: bar-key: value type: object displayName: description: Unique On-premise VP worker name that cannot be edited. The name should not contain any confidential information. example: workerName maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' example: bar-key: value type: object geoInfo: description: Geographical information of the On-premise VP worker. maxLength: 4096 minLength: 1 type: string id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the On-premise VP worker. maxLength: 255 minLength: 1 type: string identityInfo: $ref: '#/components/schemas/IdentityInfoDetails' monitorList: description: Monitors list assigned to the On-premise VP worker. items: $ref: '#/components/schemas/WorkerMonitorList' type: array name: description: Unique permanent name of the On-premise VP worker. This is the same as the displayName. example: workerName maxLength: 255 minLength: 1 type: string opvpId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the On-premise vantage point. maxLength: 255 minLength: 1 type: string opvpName: description: On-premise vantage point name. maxLength: 255 minLength: 1 type: string priority: default: 10 description: Priority of the On-premise VP worker to schedule monitors. maximum: 10 minimum: 1 type: integer runtimeId: description: The runtime assigned id of the On-premise VP worker. maxLength: 255 minLength: 1 type: string status: description: Enables or disables the On-premise VP worker. enum: - ENABLED - DISABLED type: string x-obmcs-top-level-enum: '#/definitions/OnPremiseVantagePointWorkerStatus' timeCreated: description: 'The time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-12T22:47:12.613Z` ' format: date-time type: string timeLastSyncUp: description: 'The time the resource was last synced, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-12T22:47:12.613Z` ' format: date-time type: string timeUpdated: description: 'The time the resource was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-13T22:47:12.613Z` ' format: date-time type: string versionDetails: $ref: '#/components/schemas/OnPremiseVpWorkerVersionDetails' workerType: description: Type of the On-premise VP worker. enum: - DOCKER type: string x-obmcs-top-level-enum: '#/definitions/OnPremiseVantagePointWorkerType' required: - id - runtimeId - displayName - name - opvpId - opvpName - versionDetails - workerType - status - priority type: object ScriptParameter: description: '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 script content. ' properties: isSecret: default: false description: If the parameter value is secret and should be kept confidential, then set isSecret to true. example: true type: boolean paramName: description: Name of the parameter. example: testName maxLength: 64 minLength: 1 type: string paramValue: description: Value of the parameter. example: openPage maxLength: 2048 type: string x-default-description: 'null' required: - paramName type: object WorkerSummary: description: Information about On-premise VP worker. properties: configurationDetails: description: Configuration details of the On-premise VP worker. type: object definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' example: foo-namespace: bar-key: value type: object displayName: description: Unique On-premise VP worker name that cannot be edited. The name should not contain any confidential information. example: workerName maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' example: bar-key: value type: object geoInfo: description: Geographical information of the On-premise VP worker. maxLength: 4096 minLength: 1 type: string id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the On-premise VP worker. maxLength: 255 minLength: 1 type: string monitorList: description: Monitors list assigned to the On-premise VP worker. items: $ref: '#/components/schemas/WorkerMonitorList' type: array name: description: Unique permanent name of the On-premise VP worker. This is the same as the displayName. example: workerName maxLength: 255 minLength: 1 type: string priority: default: 10 description: Priority of the On-premise VP worker to schedule monitors. maximum: 10 minimum: 1 type: integer status: description: Enables or disables the On-premise VP worker. enum: - ENABLED - DISABLED type: string x-obmcs-top-level-enum: '#/definitions/OnPremiseVantagePointWorkerStatus' timeCreated: description: 'The time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-12T22:47:12.613Z` ' format: date-time type: string timeLastSyncup: description: 'The time the resource was last synced, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-12T22:47:12.613Z` ' format: date-time type: string timeUpdated: description: 'The time the resource was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-13T22:47:12.613Z` ' format: date-time type: string versionDetails: $ref: '#/components/schemas/OnPremiseVpWorkerVersionDetails' workerType: description: Type of the On-premise VP worker. enum: - DOCKER type: string x-obmcs-top-level-enum: '#/definitions/OnPremiseVantagePointWorkerType' required: - id - displayName - name - versionDetails - workerType - status - priority type: object WorkerMonitorList: description: Details of the monitor assigned to an On-premise vantage point worker. properties: displayName: description: Unique name that can be edited. The name should not contain any confidential information. example: exampleName maxLength: 255 minLength: 1 type: string id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the monitor. example: ocid1.apmsyntheticmonitor.oc1.phx.aaaaaaaaztadaitwuj3z2w6txyrqo5khbrkbank5avu7t3jglkbux3aifhva maxLength: 255 minLength: 1 type: string isRunNow: default: false description: If isRunNow is enabled, then the monitor will run immediately. example: true type: boolean monitorType: description: Type of monitor. enum: - SCRIPTED_BROWSER - BROWSER - SCRIPTED_REST - REST - NETWORK - DNS - FTP - SQL type: string x-obmcs-top-level-enum: '#/definitions/MonitorTypes' timeAssigned: description: 'The time the resource was last assigned to an On-premise vantage point worker, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-12T22:47:12.613Z` ' format: date-time type: string required: - id - displayName - monitorType type: object MonitorScriptParameter: description: 'Details of the script parameter that can be used to overwrite the parameter present in the script. ' properties: paramName: description: Name of the parameter. example: testName maxLength: 64 minLength: 1 type: string paramValue: description: Value of the parameter. example: openPageMonitor maxLength: 2048 minLength: 1 type: string required: - paramName - paramValue type: object OnPremiseVantagePoint: description: The information about an On-premise vantage point. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' example: foo-namespace: bar-key: value type: object description: description: A short description about the On-premise vantage point. maxLength: 1024 type: string displayName: description: Unique permanent name of the On-premise vantage point. example: OracleOPVP-exampleName maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' example: bar-key: value type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the On-premise vantage point. maxLength: 255 minLength: 1 type: string name: description: Unique On-premise vantage point name that cannot be edited. The name should not contain any confidential information. example: exampleName maxLength: 255 minLength: 1 type: string timeCreated: description: 'The time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-12T22:47:12.613Z` ' format: date-time type: string timeUpdated: description: 'The time the resource was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-13T22:47:12.613Z` ' format: date-time type: string type: description: Type of On-premise vantage point. enum: - ON_PREMISE_DOCKER_VANTAGE_POINT type: string workersSummary: $ref: '#/components/schemas/WorkersSummary' required: - id - displayName - name - type - workersSummary type: object MonitorCollection: description: The results of a monitor search, which contains both MonitorSummary items and other data in an APM domain. properties: items: description: List of MonitorSummary items. items: $ref: '#/components/schemas/MonitorSummary' type: array required: - items type: object CreateWorkerDetails: description: Details of the request body used to create a new worker for an On-premise vantage point. properties: configurationDetails: description: Configuration details of the On-premise VP worker. type: object definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' example: foo-namespace: bar-key: value type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' example: bar-key: value type: object name: description: Unique On-premise VP worker name that cannot be edited. The name should not contain any confidential information. example: workerName maxLength: 255 minLength: 1 type: string priority: default: 10 description: Priority of the On-premise VP worker to schedule monitors. maximum: 10 minimum: 1 type: integer resourcePrincipalTokenPublicKey: description: public key for resource Principal Token based validation to be used in further calls. maxLength: 4096 minLength: 1 type: string status: default: ENABLED description: Enables or disables the On-premise VP worker. enum: - ENABLED - DISABLED example: ENABLED type: string x-obmcs-top-level-enum: '#/definitions/OnPremiseVantagePointWorkerStatus' version: description: Image version of the On-premise VP worker. maxLength: 120 minLength: 1 type: string workerType: default: DOCKER description: Type of the On-premise VP worker. enum: - DOCKER example: DOCKER type: string x-obmcs-top-level-enum: '#/definitions/OnPremiseVantagePointWorkerType' required: - name - version - resourcePrincipalTokenPublicKey type: object UpdateOnPremiseVantagePointDetails: description: Details of the request body used to update an On-premise vantage point. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' example: foo-namespace: bar-key: value type: object description: description: A short description about the On-premise vantage point. maxLength: 1024 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' example: bar-key: value type: object type: object UpdateWorkerDetails: description: Details of the request body used to update an On-premise VP worker. properties: configurationDetails: description: Configuration details of the On-premise VP worker. type: object definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' example: foo-namespace: bar-key: value type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' example: bar-key: value type: object priority: default: 10 description: Priority of the On-premise VP worker to schedule monitors. maximum: 10 minimum: 1 type: integer status: default: ENABLED description: Enables or disables the On-premise VP worker. enum: - ENABLED - DISABLED example: ENABLED type: string x-obmcs-top-level-enum: '#/definitions/OnPremiseVantagePointWorkerStatus' type: object MonitorStatusCountMap: description: 'Details of the monitor count per state. Example: `{ "total" : 5, "enabled" : 3 , "disabled" : 2, "invalid" : 0 }` ' properties: disabled: description: Number of disabled monitors using the script. example: 3 type: integer enabled: description: Number of enabled monitors using the script. example: 3 type: integer invalid: description: Number of invalid monitors using the script. example: 0 type: integer total: description: Total number of monitors using the script. example: 5 type: integer required: - total - enabled - disabled - invalid type: object MonitorScriptParameterInfo: description: 'Details of the script parameters in the monitor. isOverwritten specifies that the script parameters are overwritten in the monitor. If the user overwrites the parameter value in the monitor, then the overwritten values will be used to run the monitor. ' properties: isOverwritten: description: 'If parameter value is default or overwritten. ' example: false type: boolean isSecret: description: 'Describes if the parameter value is secret and should be kept confidential. isSecret is specified in either CreateScript or UpdateScript API. ' example: true type: boolean monitorScriptParameter: $ref: '#/components/schemas/MonitorScriptParameter' required: - monitorScriptParameter - isSecret - isOverwritten type: object VantagePointExecution: description: Details of a vantage point execution. example: executions: - 1603790400000 - 1603790500000 name: us-phoenix-1 properties: executions: description: List of execution times in milliseconds. example: - 1603790400000 - 1603790500000 items: format: int64 type: integer maxItems: 100 type: array x-default-description: 'null' name: description: Name of the vantage point. example: us-phoenix-1 maxLength: 50 type: string x-default-description: 'null' type: object PublicVantagePointSummary: description: Information about public vantage points. properties: displayName: description: Unique name that can be edited. The name should not contain any confidential information. example: exampleName maxLength: 255 minLength: 1 type: string geo: $ref: '#/components/schemas/GeoSummary' name: description: Unique permanent name of the vantage point. example: ap-seol maxLength: 50 minLength: 1 type: string required: - name - displayName type: object AggregatedNetworkDataResult: description: The aggregated network results. properties: aggregatedNetworkData: $ref: '#/components/schemas/AggregatedNetworkData' required: - aggregatedNetworkData type: object parameters: VantagePointNameQueryParam: description: 'The name of the public or dedicated vantage point. ' in: query name: vantagePoint x-default-description: 'null' schema: type: string maxLength: 50 minLength: 1 NameQueryParam: description: A filter to return only the resources that match the entire name. in: query name: name x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 WorkerIdPathParam: description: The OCID of the On-premise vantage point worker. in: path name: workerId required: true schema: type: string maxLength: 255 ResultTypeQueryParam: description: 'The result type: har, screenshot, log, network, diagnostics or script. ' in: query name: resultType required: true x-default-description: 'null' schema: type: string maxLength: 50 minLength: 1 OnPremiseVantagePointWorkerStatusQueryParam: description: A filter to return only On-premise VP workers that match the status given. in: query name: status x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/OnPremiseVantagePointWorkerStatus' schema: type: string enum: - ENABLED - DISABLED ApmDomainIdQueryParam: description: 'The APM domain ID the request is intended for. ' in: query name: apmDomainId required: true schema: type: string IfMatchHeader: description: '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. ' in: header name: if-match required: false schema: type: string SortOrderQueryParam: description: 'The sort order to use, either ascending (`ASC`) or descending (`DESC`). Default sort order is ascending. ' in: query name: sortOrder x-obmcs-top-level-enum: '#/definitions/SortOrders' schema: type: string enum: - ASC - DESC default: ASC ExecutionTimePathParam: description: 'The time the object was posted. ' in: path name: executionTime required: true schema: type: string IsMaintenanceWindowActiveQueryParam: description: A filter to return the monitors whose maintenance window is currently active. in: query name: isMaintenanceWindowActive x-default-description: 'null' schema: type: boolean RequestIdHeader: description: 'Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id schema: type: string ScriptIdPathParam: description: The OCID of the script. in: path name: scriptId required: true schema: type: string maxLength: 255 SortByQueryParam: description: '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. ' in: query name: sortBy schema: type: string enum: - name - displayName default: displayName MonitorIdPathParam: description: The OCID of the monitor. in: path name: monitorId required: true schema: type: string maxLength: 255 SortByQueryParamForDedicatedVantagePoint: description: '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. ' in: query name: sortBy schema: type: string enum: - displayName - name - timeCreated - timeUpdated - status default: displayName maxLength: 255 SortByQueryParamForOnPremiseVantagePoint: description: '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. ' in: query name: sortBy schema: type: string enum: - displayName - name - timeCreated - timeUpdated default: displayName maxLength: 255 MonitorStatusQueryParam: description: A filter to return only monitors that match the status given. in: query name: status x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/MonitorStatus' schema: type: string enum: - ENABLED - DISABLED - INVALID DisplayNameQueryParam: description: A filter to return only the resources that match the entire display name. in: query name: displayName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 ScriptIdQueryParam: description: A filter to return only monitors using scriptId. in: query name: scriptId x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 DedicatedVantagePointIdPathParam: description: The OCID of the dedicated vantage point. in: path name: dedicatedVantagePointId required: true schema: type: string maxLength: 255 PaginationTokenQueryParam: description: '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](/iaas/Content/API/Concepts/usingapi.htm#nine). Example: `50` ' in: query name: page schema: type: string maxLength: 1024 SortByQueryParamForScript: description: '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. ' in: query name: sortBy schema: type: string enum: - displayName - timeCreated - timeUpdated - contentType default: displayName RetryTokenHeader: description: '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. ' in: header name: opc-retry-token required: false schema: type: string maxLength: 64 minLength: 1 IsMaintenanceWindowScheduleSetQueryParam: description: A filter to return the monitors whose maintenance window is set. in: query name: isMaintenanceWindowSet x-default-description: 'null' schema: type: boolean ResultContentTypeQueryParam: description: 'The result content type: zip or raw. ' in: query name: resultContentType required: true x-default-description: 'null' schema: type: string maxLength: 50 minLength: 1 ContentTypeQueryParam: description: A filter to return only resources that match the content type given. in: query name: contentType x-default-description: 'null' schema: type: string maxLength: 64 minLength: 1 MonitorTypeQueryParam: description: '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. ' in: query name: monitorType x-default-description: 'null' schema: type: string maxLength: 64 minLength: 1 PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 100 maximum: 1000 minimum: 1 OnPremiseVantagePointWorkerCapabilityQueryParam: description: A filter to return only On-premise VP workers that match the capability given. in: query name: capability x-default-description: 'null' schema: type: string maxLength: 512 VantagePointQueryParam: description: 'The vantagePoint name. ' in: query name: vantagePoint required: true x-default-description: 'null' schema: type: string maxLength: 50 minLength: 1 DedicatedVantagePointStatusQueryParam: description: A filter to return only the dedicated vantage points that match a given status. in: query name: status x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/DedicatedVantagePointStatus' schema: type: string enum: - ENABLED - DISABLED SortByQueryParamForOnPremiseVantagePointWorker: description: '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. ' in: query name: sortBy schema: type: string enum: - displayName - name - status - priority - timeCreated - timeUpdated - timeLastSyncup default: displayName maxLength: 255 SortByQueryParamForMonitor: description: '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. ' in: query name: sortBy schema: type: string enum: - displayName - timeCreated - timeUpdated - status - monitorType - maintenanceWindowTimeStarted default: displayName maxLength: 255 OnPremiseVantagePointIdPathParam: description: The OCID of the On-premise vantage point. in: path name: onPremiseVantagePointId required: true schema: type: string maxLength: 255 responses: default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-downstream-splat-expressions: - downstream.getOr404('APM-DIS','GetApmDomainInfoCompartmentId',request.parameter.apmDomainId) x-headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string x-nbac: - '##NBAC_MODE##' x-properties: authHeaders: description: 'List of authentication headers. Example: `[{"headerName": "content-type", "headerValue":"json"}]` ' example: - headerName: Authorization headerValue: Basic cmNoYW5kb2t2NA4frgFFdWWtyq items: $ref: '#/components/schemas/Header' maxItems: 20 type: array batchIntervalInSeconds: description: Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN). example: 600 type: integer content: description: 'The content of the script. It may contain custom-defined tags that can be used for setting dynamic parameters. The format to set dynamic parameters is: `param nameparam valueisParamValueSecret(true/false)`. Param value and isParamValueSecret are optional, the default value for isParamValueSecret is false. Examples: With mandatory param name : `param name` With parameter name and value : `param nameparam value` Note that the content is valid if it matches the given content type. For example, if the content type is SIDE, then the content should be in Side script format. If the content type is JS, then the content should be in JavaScript format. If the content type is PLAYWRIGHT_TS, then the content should be in TypeScript format. ' example: '{"id":"f672ea8c-9508-483e-a123-878920eee73b","version":"2.0","name":"Sample Project","url":"https://my.oracle.com","tests":[{"id":"b4522766-e382-40c2-ab01-452cf62e1ced","name":"testNamemyTestfalse","commands":[{"id":"d1bc2093-bb61-4919-a554-38ef2653ac01","comment":"comment","command":"open","target":"/","targets":[["css=td.bodytext","css"]],"value":"xyz"}]}],"suites":[{"id":"a86b2934-7aa3-4838-b389-93c8aea2af04","name":"Default Suite","persistSession":false,"parallel":false,"timeout":300,"tests":["b4522766-e382-40c2-ab01-452cf62e1ced"]}],"urls":["https//my.oracle.com/"],"plugins":["xxx"]}' maxLength: 65536 minLength: 1 type: string createdBy: description: Name of the user that created the monitor. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' example: foo-namespace: bar-key: value type: object displayName: description: Unique name that can be edited. The name should not contain any confidential information. example: exampleName maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' example: bar-key: value type: object isDefaultSnapshotEnabled: default: true description: If disabled, auto snapshots are not collected. example: true type: boolean isIPv6: default: false description: If enabled, domain name will resolve to an IPv6 address. example: true type: boolean isRunNow: default: false description: If isRunNow is enabled, then the monitor will run immediately. example: true type: boolean isRunOnce: default: false description: If runOnce is enabled, then the monitor will run once. example: true type: boolean lastUpdatedBy: description: Name of the user that recently updated the monitor. maxLength: 255 minLength: 1 type: string monitorId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the monitor. example: ocid1.apmsyntheticmonitor.oc1.phx.aaaaaaaaztadaitwuj3z2w6txyrqo5khbrkbank5avu7t3jglkbux3aifhva maxLength: 255 minLength: 1 type: string monitorScriptParameterInfoList: description: 'List of script parameters. Example: `[{"monitorScriptParameter": {"paramName": "userid", "paramValue":"testuser"}, "isSecret": false, "isOverwritten": false}]` ' example: - isOverwritten: false isSecret: false paramName: testName paramValue: openPageMonitor items: $ref: '#/components/schemas/MonitorScriptParameterInfo' maxItems: 50 type: array monitorScriptParameters: description: 'List of script parameters in the monitor. This is valid only for SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null. Example: `[{"paramName": "userid", "paramValue":"testuser"}]` ' example: - paramName: testName paramValue: openPageMonitor items: $ref: '#/components/schemas/MonitorScriptParameter' maxItems: 50 type: array region: description: Name of the region. example: us-phoenix-1 maxLength: 50 minLength: 1 type: string repeatIntervalInSeconds: description: '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. ' example: 600 type: integer requestHeaders: description: 'List of request headers. Example: `[{"headerName": "content-type", "headerValue":"json"}]` ' example: - headerName: content-type headerValue: json items: $ref: '#/components/schemas/Header' maxItems: 20 type: array requestQueryParams: description: 'List of request query params. Example: `[{"paramName": "sortOrder", "paramValue": "asc"}]` ' example: - paramName: sortOrder paramValue: asc items: $ref: '#/components/schemas/RequestQueryParam' maxItems: 20 type: array scriptId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) 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. ' example: ocid1.apmsyntheticscript.oc1.phx.aaaaaaaanmvshzvtvvv7uh43f73f37wytshyh46zj2hinnavme6xzbfiw7tq maxLength: 255 minLength: 1 type: string scriptName: description: Name of the script. example: testScript maxLength: 255 minLength: 1 type: string scriptParameterInfoList: description: 'List of script parameters. Example: `[{"scriptParameter": {"paramName": "userid", "paramValue":"testuser", "isSecret": false}, "isOverwritten": false}]` ' example: - isOverwritten: false isSecret: false paramName: testName paramValue: openPage items: $ref: '#/components/schemas/ScriptParameterInfo' maxItems: 50 type: array scriptParameters: description: 'List of script parameters. Example: `[{"paramName": "userid", "paramValue":"testuser", "isSecret": false}]` ' example: - isSecret: false paramName: testName paramValue: openPage items: $ref: '#/components/schemas/ScriptParameter' maxItems: 50 type: array target: description: '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. ' example: https://www.oracle.com/index.html maxLength: 4000 type: string x-default-description: 'null' timeAssigned: description: 'The time the resource was last assigned to an On-premise vantage point worker, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-12T22:47:12.613Z` ' format: date-time type: string timeCreated: description: 'The time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-12T22:47:12.613Z` ' format: date-time type: string timeLastSyncup: description: 'The time the resource was last synced, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-12T22:47:12.613Z` ' format: date-time type: string timeUpdated: description: 'The time the resource was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2020-02-13T22:47:12.613Z` ' format: date-time type: string vantagePointCount: description: Number of vantage points where monitor is running. example: 2 type: integer verifyResponseContent: description: 'Verify response content against regular expression based string. If response content does not match the verifyResponseContent value, then it will be considered a failure. ' example: ^searchText* maxLength: 1024 type: string x-default-description: 'null' x-obmcs-client-circuit-breaker-enabled: true x-obmcs-client-retries-enabled: true x-oracle-package: com.oracle.apm.service.synapi