openapi: 3.2.0 info: description: 'Use the Health Checks API to manage endpoint probes and monitors. For more information, see [the Health Checks documentation](/iaas/Content/HealthChecks/home.htm). ' license: name: Oracle Corporation title: Health Checks API version: '20180501' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/7bd7df629d66a3b89f83c170e1f4378b5baca11c3cb832176fabf4a99e48ed91.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Health Checks 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/7bd7df629d66a3b89f83c170e1f4378b5baca11c3cb832176fabf4a99e48ed91.yaml what: the harvested document for Health Checks API servers: - url: /20180501 tags: - name: healthChecks paths: /httpMonitors: parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' get: description: 'Gets a list of HTTP monitors. For more information, see [Listing HTTP Monitors](/iaas/Content/HealthChecks/Tasks/list-http-monitor.htm). ' operationId: ListHttpMonitors parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/MonitorSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/HomeRegionQueryParam' responses: 200: description: 'The list of HTTP monitors was retrieved. ' 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 x-example: application/json: - compartmentId: ocid1.compartment.oc1..aaaaaaacsxgoz7flzmry5dr6scf7xru6lwqpoygqld74npvn5rdj2cv3iiq displayName: Example Monitor homeRegion: us-ashburn-1 id: ocid1.httpmonitor.OC2...abuxgljr6l4nepxjkmbtnibwqpu5z24xdvmr7okzoi47wicoflrxh32rwd7a intervalInSeconds: 30 isEnabled: true protocol: HTTPS resultsUrl: https://healthchecks.us-ashburn-1.oraclecloud.com/20180501/httpProbeResults/ocid1.httpmonitor.OC2...abuxgljr6l4nepxjkmbtnibwqpu5z24xdvmr7okzoi47wicoflrxh32rwd7a timeCreated: 2019-09-03 15:09:02+00:00 content: application/json: schema: description: An array of HTTP monitor summary objects. items: $ref: '#/components/schemas/HttpMonitorSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Gets HTTP monitors. tags: - healthChecks x-example: 'GET /20180501/httpMonitors?compartmentId=ocid1.tenancy.oc1...HTTP/1.1 Host: healthchecks.us-phoenix-1.oraclecloud.com <authorization and other headers> ' post: description: 'Creates an HTTP monitor. Vantage points will be automatically selected if not specified, and probes will be initiated from each vantage point to each of the targets at the frequency specified by `intervalInSeconds`. For more information, see [Creating an HTTP Monitor](/iaas/Content/HealthChecks/Tasks/create-http-monitor.htm). ' operationId: CreateHttpMonitor parameters: - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 200: description: The HTTP monitor was created. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string location: description: The URL of the newly created monitor. schema: type: string format: uri-reference 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/HttpMonitor' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Creates an HTTP monitor. tags: - healthChecks x-example: "POST /20180501/httpMonitors/ HTTP/1.1\nHost: healthchecks.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.tenancy.oc1....\",\n \"targets\": [\"192.0.2.0\"],\n \"protocol\": \"HTTP\",\n \"displayName\": \"test\",\n \"intervalInSeconds\": 300\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateHttpMonitorDetails' description: The configuration details for creating an HTTP monitor. required: true /httpMonitors/{monitorId}: parameters: - $ref: '#/components/parameters/MonitorIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' delete: description: 'Deletes the HTTP monitor and its configuration. All future probes of this monitor are stopped. Results associated with the monitor are not deleted. For more information, see [Deleting an HTTP Monitor](/iaas/Content/HealthChecks/Tasks/delete-http-monitor.htm). ' operationId: DeleteHttpMonitor parameters: - $ref: '#/components/parameters/IfMatchHeaderParam' responses: 204: description: The monitor has been 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 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Deletes the HTTP monitor. tags: - healthChecks x-example: 'DELETE /20180501/httpMonitors/ocid1.httpmonitor.oc1...HTTP/1.1 Host: healthchecks.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/HttpMonitor' get: description: 'Gets the configuration for the specified monitor. For more information, see [Getting an HTTP Monitor''s Details](/iaas/Content/HealthChecks/Tasks/get-http-monitor.htm). ' operationId: GetHttpMonitor parameters: - $ref: '#/components/parameters/IfNoneMatchHeaderParam' responses: 200: description: 'The configuration of the HTTP 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/HttpMonitor' 304: $ref: '#/components/responses/304' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Gets the HTTP monitor configuration. tags: - healthChecks x-example: 'GET /20180501/httpMonitors/ocid1.httpmonitor.oc1...HTTP/1.1 Host: healthchecks.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: 'Updates the configuration of the specified HTTP monitor. Only the fields specified in the request body will be updated; all other configuration properties will remain unchanged. For more information, see [Updating an HTTP Monitor](/iaas/Content/HealthChecks/Tasks/update-http-monitor.htm). ' operationId: UpdateHttpMonitor parameters: - $ref: '#/components/parameters/IfMatchHeaderParam' responses: 200: description: The HTTP 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/HttpMonitor' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Updates the HTTP monitor configuration. tags: - healthChecks x-example: "PUT /20180501/httpMonitors/ocid1.httpmonitor.oc1...HTTP/1.1\nHost: healthchecks.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"protocol\": \"HTTPS\",\n \"port\": 443\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateHttpMonitorDetails' description: The configuration details to update for the HTTP monitor. required: true /httpMonitors/{monitorId}/actions/changeCompartment: post: description: 'Moves a monitor into a different compartment. When provided, `If-Match` is checked against ETag values of the resource. For more information, see [Moving an HTTP Monitor](/iaas/Content/HealthChecks/Tasks/change-compartment-http-monitor.htm). ' operationId: ChangeHttpMonitorCompartment parameters: - $ref: '#/components/parameters/IfMatchHeaderParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' - $ref: '#/components/parameters/MonitorIdPathParam' responses: 204: description: The monitor was moved successfully. 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 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' summary: Moves a monitor into a different compartment. tags: - healthChecks x-example: "POST /20180501/httpMonitors/ocid1.httpmonitor.oc1../actions/changeCompartment HTTP/1.1\nHost: healthchecks.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.tenancy.oc1..\"\n}\n" x-related-resource: '#/definitions/HttpMonitor' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeHttpMonitorCompartmentDetails' description: The details needed to move the monitor. required: true /httpProbeResults: parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' post: description: 'Creates an on-demand HTTP probe. The location response header contains the URL for fetching the probe results. For more information, see [Creating an HTTP On-Demand Probe](/iaas/Content/HealthChecks/Tasks/create-http-probe.htm). *Note:* On-demand probe configurations are not saved. ' operationId: CreateOnDemandHttpProbe responses: 200: description: 'The on-demand HTTP probe was created. ' headers: location: description: The URL for fetching probe results. schema: type: string format: uri-reference 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/HttpProbe' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Creates an on-demand HTTP probe. tags: - healthChecks x-example: 'POST /20180501/httpProbeResults HTTP/1.1 Host: healthchecks.us-phoenix-1.oraclecloud.com <authorization and other headers> { "compartmentId": "ocid1.tenancy.oc1...", "targets": ["192.0.2.0"], "protocol": "HTTP" } ' x-related-resource: '#/definitions/HttpProbe' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOnDemandHttpProbeDetails' description: The configuration of the HTTP probe. required: true /httpProbeResults/{probeConfigurationId}: parameters: - $ref: '#/components/parameters/ProbeConfigurationIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' get: description: 'Gets the HTTP probe results for the specified probe or monitor, where the `probeConfigurationId` is the OCID of either a monitor or an on-demand probe. For more information, see [Listing Results for an HTTP On-Demand Probe](/iaas/Content/HealthChecks/Tasks/list-http-probe-result.htm). ' operationId: ListHttpProbeResults parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/StartTimeGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/StartTimeLessThanOrEqualToQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/TargetQueryParam' responses: 200: description: 'The results of the specified probe or monitor were retrieved. ' 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 x-example: application/json: - connectEnd: 1517323711649 connectStart: 1517323711535 connection: address: 93.184.216.34 connectDuration: 114 port: 443 secureConnectDuration: 99 dns: addresses: - 93.184.216.34 - 2606:2800:220:1:248:1893:25c8:1946 domainLookupDuration: 29 domainLookupEnd: 1517323711534 domainLookupStart: 1517323711505 duration: 171 encodedBodySize: 1270 fetchStart: 1517323711505 isHealthy: true isTimedOut: false key: 651b9f3a46041cace0530204060ae27e probeConfigurationId: ocid1.httpmonitor.OC2...abuxgljr6l4nepxjkmbtnibwqpu5z24xdvmr7okzoi47wicoflrxh32rwd7a protocol: HTTPS requestStart: 1517323711649 responseEnd: 1517323711676 responseStart: 1517323711673 secureConnectionStart: 1517323711550 startTime: 1517323711505 statusCode: 200 target: www.example.com vantagePointName: oci-ashburn-ad2 content: application/json: schema: description: 'An array of HTTP probe results. Each element contains the results of a single probe from one vantage point to one target. ' items: $ref: '#/components/schemas/HttpProbeResultSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Gets the HTTP probe results for the specified monitor or on-demand probe. tags: - healthChecks x-example: 'GET /20180501/httpProbeResults/ocid1.httpprobe.oc1...HTTP/1.1 Host: healthchecks.us-phoenix-1.oraclecloud.com <authorization and other headers> ' /pingMonitors: parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' get: description: 'Gets a list of configured ping monitors. For more information, see [Listing Ping Monitors](/iaas/Content/HealthChecks/Tasks/list-ping-monitor.htm). Results are paginated based on `page` and `limit`. The `opc-next-page` header provides a URL for fetching the next page. ' operationId: ListPingMonitors parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/MonitorSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/HomeRegionQueryParam' responses: 200: description: 'The list of ping monitors was retrieved. ' 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 x-example: application/json: - compartmentId: ocid1.compartment.oc1..aaaaaaacsxgoz7flzmry5dr6scf7xru6lwqpoygqld74npvn5rdj2cv3iiq displayName: Example Monitor homeRegion: us-ashburn-1 id: ocid1.pingmonitor.OC2...abuxgljr6l4nepxjkmbtnibwqpu5z24xdvmr7okzoi47wicoflrxh32rwd7b intervalInSeconds: 30 isEnabled: true protocol: ICMP resultsUrl: https://healthchecks.us-ashburn-1.oraclecloud.com/20180501/pingProbeResults/ocid1.pingmonitor.OC2...abuxgljr6l4nepxjkmbtnibwqpu5z24xdvmr7okzoi47wicoflrxh32rwd7b timeCreated: 2019-09-03 15:09:02+00:00 content: application/json: schema: items: $ref: '#/components/schemas/PingMonitorSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Returns Ping monitors. tags: - healthChecks x-example: 'GET /20180501/pingMonitors?compartmentId=ocid1.tenancy.oc1.. HTTP/1.1 Host: healthchecks.us-phoenix-1.oraclecloud.com <authorization and other headers> ' post: description: 'Creates a ping monitor. Vantage points will be automatically selected if not specified, and probes will be initiated from each vantage point to each of the targets at the frequency specified by `intervalInSeconds`. For more information, see [Creating a Ping Monitor](/iaas/Content/HealthChecks/Tasks/create-ping-monitor.htm). ' operationId: CreatePingMonitor parameters: - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' responses: 200: description: 'The ping monitor was created. ' headers: etag: description: An entity tag that uniquely identifies a version of the resource. schema: type: string location: description: The URL of the newly created monitor. schema: type: string format: uri-reference 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/PingMonitor' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Creates a Ping monitor. tags: - healthChecks x-example: "POST /20180501/pingMonitors HTTP/1.1\nHost: healthchecks.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.tenancy.oc1...\",\n \"targets\": [\"192.0.2.0\"],\n \"protocol\": \"TCP\",\n \"displayName\": \"testPing\",\n \"intervalInSeconds\": 300\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePingMonitorDetails' description: The configuration details for creating a ping monitor. required: true /pingMonitors/{monitorId}: parameters: - $ref: '#/components/parameters/MonitorIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' delete: description: 'Deletes the ping monitor and its configuration. All future probes of this monitor are stopped. Results associated with the monitor are not deleted. For more information, see [Deleting a Ping Monitor](/iaas/Content/HealthChecks/Tasks/delete-ping-monitor.htm). ' operationId: DeletePingMonitor parameters: - $ref: '#/components/parameters/IfMatchHeaderParam' responses: 204: description: 'Success response ' 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 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Deletes the Ping monitor configuration. tags: - healthChecks x-example: 'DELETE /20180501/pingMonitors/ocid1.pingmonitor.oc1...HTTP/1.1 Host: healthchecks.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/PingMonitor' get: description: 'Gets the configuration for the specified ping monitor. For more information, see [Getting a Ping Monitor''s Details](/iaas/Content/HealthChecks/Tasks/get-ping-monitor.htm). ' operationId: GetPingMonitor parameters: - $ref: '#/components/parameters/IfNoneMatchHeaderParam' responses: 200: description: 'The configuration of the ping monitor was retrieved. ' headers: etag: description: An entity tag that uniquely identifies a version of the resource. 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/PingMonitor' 304: $ref: '#/components/responses/304' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Returns the Ping monitor configuration. tags: - healthChecks x-example: 'GET /20180501/pingMonitors/ocid1.pingmonitor.oc1...HTTP/1.1 Host: healthchecks.us-phoenix-1.oraclecloud.com <authorization and other headers> ' put: description: 'Updates the configuration of the specified ping monitor. Only the fields specified in the request body will be updated; all other configuration properties will remain unchanged. For more information, see [Updating a Ping Monitor](/iaas/Content/HealthChecks/Tasks/update-ping-monitor.htm). ' operationId: UpdatePingMonitor parameters: - $ref: '#/components/parameters/IfMatchHeaderParam' responses: 200: description: 'The ping monitor was updated. ' headers: etag: description: An entity tag that uniquely identifies a version of the resource. 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/PingMonitor' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Updates the Ping monitor configuration. tags: - healthChecks x-example: "PUT /20180501/pingMonitors/ocid1.pingmonitor.oc1...HTTP/1.1\nHost: healthchecks.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"protocol\": \"ICMP\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePingMonitorDetails' description: Details for updating a Ping monitor. required: true /pingMonitors/{monitorId}/actions/changeCompartment: post: description: 'Moves a monitor into a different compartment. When provided, `If-Match` is checked against ETag values of the resource. For more information, see [Moving a Ping Monitor](/iaas/Content/HealthChecks/Tasks/change-compartment-ping-monitor.htm). ' operationId: ChangePingMonitorCompartment parameters: - $ref: '#/components/parameters/IfMatchHeaderParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' - $ref: '#/components/parameters/OpcRetryTokenHeaderParam' - $ref: '#/components/parameters/MonitorIdPathParam' responses: 204: description: The monitor was moved successfully. 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 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' summary: Moves a monitor into a different compartment. tags: - healthChecks x-example: "POST /20180501/pingMonitors/ocid1.pingmonitor.oc1../actions/changeCompartment HTTP/1.1\nHost: healthchecks.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.tenancy.oc1..\"\n}\n" x-related-resource: '#/definitions/PingMonitor' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangePingMonitorCompartmentDetails' description: The details needed to move the monitor. required: true /pingProbeResults: parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' post: description: 'Creates an on-demand ping probe. The location response header contains the URL for fetching probe results. For more information, see [Creating a Ping On-Demand Probe](/iaas/Content/HealthChecks/Tasks/create-ping-probe.htm). *Note:* The on-demand probe configuration is not saved. ' operationId: CreateOnDemandPingProbe responses: 200: description: 'The on-demand pring probe was created. ' headers: location: description: The URL for fetching probe results. schema: type: string format: uri-reference 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/PingProbe' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Creates an on-demand Ping probe. tags: - healthChecks x-example: "POST /20180501/pingProbeResults HTTP/1.1\nHost: healthchecks.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\": \"ocid1.tenancy.oc1...\",\n \"targets\": [\"192.0.2.0\"],\n \"protocol\": \"ICMP\"\n}\n" x-related-resource: '#/definitions/PingProbe' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOnDemandPingProbeDetails' description: Configuration details for creating an on-demand ping probe. required: true /pingProbeResults/{probeConfigurationId}: parameters: - $ref: '#/components/parameters/ProbeConfigurationIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' get: description: 'Returns the results for the specified probe, where the `probeConfigurationId` is the OCID of either a monitor or an on-demand probe. For more information, see [Listing Results for a Ping On-Demand Probe](/iaas/Content/HealthChecks/Tasks/list-ping-probe-result.htm). Results are paginated based on `page` and `limit`. The `opc-next-page` header provides a URL for fetching the next page. Use `sortOrder` to set the order of the results. If `sortOrder` is unspecified, results are sorted in ascending order by `startTime`. ' operationId: ListPingProbeResults parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/StartTimeGreaterThanOrEqualToQueryParam' - $ref: '#/components/parameters/StartTimeLessThanOrEqualToQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/TargetQueryParam' responses: 200: description: 'The probe results were retrieved. ' 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 there may be additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#List_Pagination). ' 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 x-example: application/json: - connection: address: 93.184.216.34 dns: addresses: - 93.184.216.34 - 2606:2800:220:1:248:1893:25c8:1946 domainLookupDuration: 29 domainLookupEnd: 1517323711534 domainLookupStart: 1517323711505 icmpCode: 0 isHealthy: true isTimedOut: false key: 651b9f3a46041cace0530204060ae27f latencyInMs: 13.6 probeConfigurationId: ocid1.pingmonitor.OC2...abuxgljr6l4nepxjkmbtnibwqpu5z24xdvmr7okzoi47wicoflrxh32rwd7b protocol: ICMP startTime: 1517323711505 target: www.example.com vantagePointName: oci-ashburn-ad2 content: application/json: schema: description: 'An array of ping probe results. Each element contains the results of a single probe from one vantage point to one target. ' items: $ref: '#/components/schemas/PingProbeResultSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Returns the Ping probe results for the specified monitor or on-demand probe. tags: - healthChecks x-example: 'GET /20180501/pingProbeResults/ocid1.pingprobe.oc1...HTTP/1.1 Host: healthchecks.us-phoenix-1.oraclecloud.com <authorization and other headers> ' /vantagePoints: parameters: - $ref: '#/components/parameters/OpcRequestIdHeaderParam' get: description: 'Gets information about all vantage points available to the user. For more information, see [Listing Vantage Points](/iaas/Content/HealthChecks/Tasks/list-vantage-point.htm). ' operationId: ListHealthChecksVantagePoints parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/VantagePointSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' responses: 200: description: 'The list of available vantage points and their details were retrieved. ' 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 there may be additional items still to get. Include this value as the `page` parameter for the subsequent GET request. For information about pagination, see [List Pagination](/Content/API/Concepts/usingapi.htm#List_Pagination). ' 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 x-example: application/json: - displayName: Oracle OCI - Ashburn AD3 geo: adminDivCode: VA cityName: Ashburn countryCode: US countryName: United States geoKey: '4744870' latitude: 39.04372 longitude: -77.48749 name: oci-ashburn-ad3 providerName: Oracle routing: - asLabel: Oracle Corporation asn: 31898 prefix: 140.238.0.0/16 weight: 100 - displayName: Oracle OCI - Ashburn AD1 geo: adminDivCode: VA cityName: Ashburn countryCode: US countryName: United States geoKey: '4744870' latitude: 39.04372 longitude: -77.48749 name: oci-ashburn-ad1 providerName: Oracle routing: - asLabel: Oracle Corporation asn: 31898 prefix: 140.238.0.0/16 weight: 100 content: application/json: schema: description: An array of vantage points. items: $ref: '#/components/schemas/HealthChecksVantagePointSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: 'Returns information about available vantage points. ' tags: - healthChecks x-example: 'GET /20180501/vantagePoints HTTP/1.1 Host: healthchecks.us-phoenix-1.oraclecloud.com <authorization and other headers> ' components: schemas: CreateHttpMonitorDetails: description: The request body used to create an HTTP monitor. properties: compartmentId: description: The OCID of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: A user-friendly and mutable name suitable for display in a user interface. type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object headers: additionalProperties: type: string description: 'A dictionary of HTTP request headers. *Note:* Monitors and probes do not support the use of the `Authorization` HTTP header. ' type: object intervalInSeconds: description: 'The monitor interval in seconds. Valid values: 10, 30, and 60. ' type: integer isEnabled: default: true description: 'Enables or disables the monitor. Set to ''true'' to launch monitoring. ' type: boolean method: default: HEAD enum: - GET - HEAD type: string x-obmcs-top-level-enum: '#/definitions/HttpProbeMethod' path: default: / description: The optional URL path to probe, including query parameters. type: string x-example: /index.html port: description: 'The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol. ' type: integer protocol: enum: - HTTP - HTTPS type: string x-obmcs-top-level-enum: '#/definitions/HttpProbeProtocol' targets: description: A list of targets (hostnames or IP addresses) of the probe. items: type: string minItems: 1 type: array timeoutInSeconds: description: 'The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to `intervalInSeconds` for monitors. ' type: integer vantagePointNames: description: A list of names of vantage points from which to execute the probe. items: type: string type: array required: - compartmentId - targets - protocol - intervalInSeconds - displayName type: object x-example: compartmentId: ocid1.compartment.oc1..aaaaaaacsxgoz7flzmry5dr6scf7xru6lwqpoygqld74npvn5rdj2cv3iiq displayName: Example Monitor intervalInSeconds: 30 protocol: HTTPS targets: - www.example.com - www.oracle.com timeoutInSeconds: 30 vantagePointNames: - oci-ashburn-ad2 - aws-ashburn-az1 - ibm-seattle-1 UpdatePingMonitorDetails: description: The request body used to update a ping monitor. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: A user-friendly and mutable name suitable for display in a user interface. type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object intervalInSeconds: description: 'The monitor interval in seconds. Valid values: 10, 30, and 60. ' type: integer isEnabled: description: 'Enables or disables the monitor. Set to ''true'' to launch monitoring. ' type: boolean port: description: 'The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol. ' type: integer protocol: enum: - ICMP - TCP type: string x-obmcs-top-level-enum: '#/definitions/PingProbeProtocol' targets: description: A list of targets (hostnames or IP addresses) of the probe. items: type: string minItems: 1 type: array timeoutInSeconds: description: 'The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to `intervalInSeconds` for monitors. ' type: integer vantagePointNames: description: A list of names of vantage points from which to execute the probe. items: type: string type: array type: object x-example: displayName: Example Monitor intervalInSeconds: 10 protocol: TCP targets: - www.example.com timeoutInSeconds: 10 vantagePointNames: - oci-ashburn-ad2 - aws-ashburn-az1 - ibm-seattle-1 Geolocation: description: Geographic information about 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](https://www.iso.org/obp/ui/#search). ' readOnly: true type: string cityName: description: 'Common English-language name for the city. ' readOnly: true type: string countryCode: description: 'The ISO 3166-1 alpha-2 country code. For a list of codes, see [Country Codes](https://www.iso.org/obp/ui/#search). ' readOnly: true type: string countryName: description: 'The common English-language name for the country. ' readOnly: true type: string geoKey: description: An opaque identifier for the geographic location of the vantage point. readOnly: true type: string latitude: description: 'Degrees north of the Equator. ' format: float readOnly: true type: number longitude: description: 'Degrees east of the prime meridian. ' format: float readOnly: true type: number type: object DNS: description: The DNS resolution results. properties: addresses: description: The addresses returned by DNS resolution. items: format: ip-address type: string readOnly: true type: array domainLookupDuration: description: 'Total DNS resolution duration, in milliseconds. Calculated using `domainLookupEnd` minus `domainLookupStart`. ' format: double readOnly: true type: number type: object UpdateHttpMonitorDetails: description: The request body used to update an HTTP monitor. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: A user-friendly and mutable name suitable for display in a user interface. type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object headers: additionalProperties: type: string description: 'A dictionary of HTTP request headers. *Note:* Monitors and probes do not support the use of the `Authorization` HTTP header. ' type: object intervalInSeconds: description: 'The monitor interval in seconds. Valid values: 10, 30, and 60. ' type: integer isEnabled: description: 'Enables or disables the monitor. Set to ''true'' to launch monitoring. ' type: boolean method: enum: - GET - HEAD type: string x-obmcs-top-level-enum: '#/definitions/HttpProbeMethod' path: description: The optional URL path to probe, including query parameters. type: string x-example: /index.html port: description: 'The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol. ' type: integer protocol: enum: - HTTP - HTTPS type: string x-obmcs-top-level-enum: '#/definitions/HttpProbeProtocol' targets: description: A list of targets (hostnames or IP addresses) of the probe. items: type: string minItems: 1 type: array timeoutInSeconds: description: 'The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to `intervalInSeconds` for monitors. ' type: integer vantagePointNames: description: A list of names of vantage points from which to execute the probe. items: type: string type: array type: object x-example: displayName: Example Monitor intervalInSeconds: 10 protocol: HTTPS targets: - www.example.com - www.oracle.com timeoutInSeconds: 10 vantagePointNames: - oci-ashburn-ad2 - aws-ashburn-az1 - ibm-seattle-1 HealthChecksVantagePointSummary: description: Information about a vantage point. properties: displayName: description: 'The display name for the vantage point. Display names are determined by the best information available and may change over time. ' readOnly: true type: string geo: $ref: '#/components/schemas/Geolocation' name: description: The unique, permanent name for the vantage point. readOnly: true type: string providerName: description: 'The organization on whose infrastructure this vantage point resides. Provider names are not unique, as Oracle Cloud Infrastructure maintains many vantage points in each major provider. ' readOnly: true type: string routing: description: 'An array of objects that describe how traffic to this vantage point is routed, including which prefixes and ASNs connect it to the internet. The addresses are sorted from the most-specific to least-specific prefix (the smallest network to largest network). When a prefix has multiple origin ASNs (MOAS routing), they are sorted by weight (highest to lowest). Weight is determined by the total percentage of peers observing the prefix originating from an ASN. Only present if `fields` includes `routing`. The field will be null if the address''s routing information is unknown. ' items: $ref: '#/components/schemas/Routing' readOnly: true type: array type: object ChangePingMonitorCompartmentDetails: description: The request body used to move a monitor into a compartment. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object x-example: compartmentId: ocid1.compartment.oc1..aaaaaaacsxgoz7flzmry5dr6scf7xru6lwqpoygqld74npvn5rdj2cv3iiq PingMonitorSummary: description: 'This model contains all of the mutable and immutable summary properties for an HTTP monitor. ' example: displayName: Example Monitor id: ocid1.pingmonitor.OC2...abuxgljr6l4nepxjkmbtnibwqpu5z24xdvmr7okzoi47wicoflrxh32rwd7b intervalInSeconds: 30 isEnabled: true protocol: ICMP resultsUrl: https://healthchecks.us-ashburn-1.oraclecloud.com/20180501/pingProbeResults/ocid1.pingmonitor.OC2...abuxgljr6l4nepxjkmbtnibwqpu5z24xdvmr7okzoi47wicoflrxh32rwd7b properties: compartmentId: description: The OCID of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: A user-friendly and mutable name suitable for display in a user interface. type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object homeRegion: description: 'The region where updates must be made and where results must be fetched from. ' maxLength: 255 minLength: 1 type: string x-example: us-ashburn-1 id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string intervalInSeconds: description: 'The monitor interval in seconds. Valid values: 10, 30, and 60. ' type: integer isEnabled: default: true description: 'Enables or disables the monitor. Set to ''true'' to launch monitoring. ' type: boolean protocol: enum: - ICMP - TCP type: string x-obmcs-top-level-enum: '#/definitions/PingProbeProtocol' resultsUrl: description: A URL for fetching the probe results. format: url type: string timeCreated: description: 'The RFC 3339-formatted creation date and time of the probe. ' format: date-time type: string type: object PingMonitor: description: 'A summary containing all of the mutable and immutable properties for a ping monitor. ' properties: compartmentId: description: The OCID of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: A user-friendly and mutable name suitable for display in a user interface. type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object homeRegion: description: 'The region where updates must be made and where results must be fetched from. ' maxLength: 255 minLength: 1 type: string x-example: us-ashburn-1 id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string intervalInSeconds: description: 'The monitor interval in seconds. Valid values: 10, 30, and 60. ' type: integer isEnabled: default: true description: 'Enables or disables the monitor. Set to ''true'' to launch monitoring. ' type: boolean port: description: 'The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol. ' type: integer protocol: enum: - ICMP - TCP type: string x-obmcs-top-level-enum: '#/definitions/PingProbeProtocol' resultsUrl: description: A URL for fetching the probe results. format: url type: string targets: description: A list of targets (hostnames or IP addresses) of the probe. items: type: string minItems: 1 type: array timeCreated: description: 'The RFC 3339-formatted creation date and time of the probe. ' format: date-time type: string timeoutInSeconds: description: 'The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to `intervalInSeconds` for monitors. ' type: integer vantagePointNames: description: A list of names of vantage points from which to execute the probe. items: type: string type: array type: object x-example: compartmentId: ocid1.compartment.oc1..aaaaaaacsxgoz7flzmry5dr6scf7xru6lwqpoygqld74npvn5rdj2cv3iiq displayName: Example Monitor homeRegion: us-ashburn-1 id: ocid1.pingmonitor.OC2...abuxgljr6l4nepxjkmbtnibwqpu5z24xdvmr7okzoi47wicoflrxh32rwd7b intervalInSeconds: 30 isEnabled: true protocol: TCP resultsUrl: https://healthchecks.us-ashburn-1.oraclecloud.com/20180501/pingProbeResults/ocid1.pingmonitor.OC2...abuxgljr6l4nepxjkmbtnibwqpu5z24xdvmr7okzoi47wicoflrxh32rwd7b targets: - www.example.com timeCreated: 2019-09-03 15:09:02+00:00 timeoutInSeconds: 30 vantagePointNames: - oci-ashburn-ad2 - aws-ashburn-az1 - ibm-seattle-1 Connection: description: The network connection results. properties: address: description: The connection IP address. format: ip-address readOnly: true type: string port: description: The port. readOnly: true type: integer type: object HttpProbeResultSummary: description: 'The results returned by running an HTTP probe. All times and durations are returned in milliseconds. All times are relative to the POSIX epoch (1970-01-01T00:00Z). Time properties conform to W3C Resource Timing. For more information, see [PerformanceResourceTiming](https://w3c.github.io/resource-timing/#sec-resource-timing) interface. ' properties: connectEnd: description: 'The time immediately after the vantage point finishes establishing the connection to the server to retrieve the resource. ' format: double readOnly: true type: number connectStart: description: 'The time immediately before the vantage point starts establishing the connection to the server to retrieve the resource. ' format: double readOnly: true type: number connection: $ref: '#/components/schemas/TcpConnection' dns: $ref: '#/components/schemas/DNS' domainLookupEnd: description: 'The time immediately before the vantage point finishes the domain name lookup for the resource. ' format: double readOnly: true type: number domainLookupStart: description: 'The time immediately before the vantage point starts the domain name lookup for the resource. ' format: double readOnly: true type: number duration: description: 'The total duration from start of request until response is fully consumed or the connection is closed. ' format: double readOnly: true type: number encodedBodySize: description: 'The size, in octets, of the payload body prior to removing any applied content-codings. ' readOnly: true type: integer errorCategory: default: NONE description: 'The category of error if an error occurs executing the probe. The `errorMessage` field provides a message with the error details. * NONE - No error * DNS - DNS errors * TRANSPORT - Transport-related errors, for example a "TLS certificate expired" error. * NETWORK - Network-related errors, for example a "network unreachable" error. * SYSTEM - Internal system errors. ' enum: - NONE - DNS - TRANSPORT - NETWORK - SYSTEM readOnly: true type: string errorMessage: description: The error information indicating why a probe execution failed. readOnly: true type: string x-example: Unable to resolve host fetchStart: description: 'The time immediately before the vantage point starts to fetch the resource. ' format: double readOnly: true type: number isHealthy: description: 'True if the probe result is determined to be healthy based on probe type-specific criteria. For HTTP probes, a probe result is considered healthy if the HTTP response code is greater than or equal to 200 and less than 300. ' readOnly: true type: boolean isTimedOut: description: 'True if the probe did not complete before the configured `timeoutInSeconds` value. ' type: boolean key: description: 'A value identifying this specific probe result. The key is only unique within the results of its probe configuration. The key may be reused after 90 days. ' type: string x-example: 651b9f3a46041cace0530204060ae27e probeConfigurationId: description: 'The OCID of the monitor or on-demand probe responsible for creating this result. ' maxLength: 255 minLength: 1 type: string protocol: enum: - HTTP - HTTPS type: string x-obmcs-top-level-enum: '#/definitions/HttpProbeProtocol' requestStart: description: 'The time immediately before the vantage point starts requesting the resource from the server. ' format: double readOnly: true type: number responseEnd: description: 'The time immediately after the vantage point receives the last byte of the response or immediately before the transport connection is closed, whichever comes first. ' format: double readOnly: true type: number responseStart: description: 'The time immediately after the vantage point''s HTTP parser receives the first byte of the response. ' format: double readOnly: true type: number secureConnectionStart: description: 'The time immediately before the vantage point starts the handshake process to secure the current connection. ' format: double readOnly: true type: number startTime: description: 'The date and time the probe was executed, expressed in milliseconds since the POSIX epoch. This field is defined by the PerformanceResourceTiming interface of the W3C Resource Timing specification. For more information, see [Resource Timing](https://w3c.github.io/resource-timing/#sec-resource-timing). ' format: double type: number statusCode: description: The HTTP response status code. readOnly: true type: integer target: description: The target hostname or IP address of the probe. type: string vantagePointName: description: The name of the vantage point that executed the probe. type: string type: object HttpMonitor: description: 'This model contains all of the mutable and immutable properties for an HTTP monitor. ' properties: compartmentId: description: The OCID of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: A user-friendly and mutable name suitable for display in a user interface. type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object headers: additionalProperties: type: string description: 'A dictionary of HTTP request headers. *Note:* Monitors and probes do not support the use of the `Authorization` HTTP header. ' type: object homeRegion: description: 'The region where updates must be made and where results must be fetched from. ' maxLength: 255 minLength: 1 type: string x-example: us-ashburn-1 id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string intervalInSeconds: description: 'The monitor interval in seconds. Valid values: 10, 30, and 60. ' type: integer isEnabled: default: true description: 'Enables or disables the monitor. Set to ''true'' to launch monitoring. ' type: boolean method: default: HEAD enum: - GET - HEAD type: string x-obmcs-top-level-enum: '#/definitions/HttpProbeMethod' path: default: / description: The optional URL path to probe, including query parameters. type: string x-example: /index.html port: description: 'The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol. ' type: integer protocol: enum: - HTTP - HTTPS type: string x-obmcs-top-level-enum: '#/definitions/HttpProbeProtocol' resultsUrl: description: A URL for fetching the probe results. format: url type: string targets: description: A list of targets (hostnames or IP addresses) of the probe. items: type: string minItems: 1 type: array timeCreated: description: 'The RFC 3339-formatted creation date and time of the probe. ' format: date-time type: string timeoutInSeconds: description: 'The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to `intervalInSeconds` for monitors. ' type: integer vantagePointNames: description: A list of names of vantage points from which to execute the probe. items: type: string type: array type: object x-example: compartmentId: ocid1.compartment.oc1..aaaaaaacsxgoz7flzmry5dr6scf7xru6lwqpoygqld74npvn5rdj2cv3iiq displayName: Example Monitor homeRegion: us-ashburn-1 id: ocid1.httpmonitor.OC2...abuxgljr6l4nepxjkmbtnibwqpu5z24xdvmr7okzoi47wicoflrxh32rwd7a intervalInSeconds: 30 isEnabled: true protocol: HTTPS resultsUrl: https://healthchecks.us-ashburn-1.oraclecloud.com/20180501/httpProbeResults/ocid1.httpmonitor.OC2...abuxgljr6l4nepxjkmbtnibwqpu5z24xdvmr7okzoi47wicoflrxh32rwd7a targets: - www.example.com - www.oracle.com timeCreated: 2019-09-03 15:09:02+00:00 timeoutInSeconds: 30 vantagePointNames: - oci-ashburn-ad2 - aws-ashburn-az1 - ibm-seattle-1 CreateOnDemandPingProbeDetails: description: The request body used to create an on-demand ping probe. properties: compartmentId: description: The OCID of the compartment. maxLength: 255 minLength: 1 type: string port: description: 'The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol. ' type: integer protocol: enum: - ICMP - TCP type: string x-obmcs-top-level-enum: '#/definitions/PingProbeProtocol' targets: description: A list of targets (hostnames or IP addresses) of the probe. items: type: string minItems: 1 type: array timeoutInSeconds: description: 'The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to `intervalInSeconds` for monitors. ' type: integer vantagePointNames: description: A list of names of vantage points from which to execute the probe. items: type: string type: array required: - compartmentId - targets - protocol type: object x-example: compartmentId: ocid1.compartment.oc1..aaaaaaacsxgoz7flzmry5dr6scf7xru6lwqpoygqld74npvn5rdj2cv3iiq protocol: ICMP targets: - www.example.com timeoutInSeconds: 30 vantagePointNames: - oci-ashburn-ad2 - aws-ashburn-az1 - ibm-seattle-1 PingProbe: description: 'This model contains all of the mutable and immutable properties for a ping probe. ' properties: compartmentId: description: The OCID of the compartment. maxLength: 255 minLength: 1 type: string homeRegion: description: 'The region where updates must be made and where results must be fetched from. ' maxLength: 255 minLength: 1 type: string x-example: us-ashburn-1 id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string port: description: 'The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol. ' type: integer protocol: enum: - ICMP - TCP type: string x-obmcs-top-level-enum: '#/definitions/PingProbeProtocol' resultsUrl: description: A URL for fetching the probe results. format: url type: string targets: description: A list of targets (hostnames or IP addresses) of the probe. items: type: string minItems: 1 type: array timeCreated: description: 'The RFC 3339-formatted creation date and time of the probe. ' format: date-time type: string timeoutInSeconds: description: 'The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to `intervalInSeconds` for monitors. ' type: integer vantagePointNames: description: A list of names of vantage points from which to execute the probe. items: type: string type: array type: object x-example: compartmentId: ocid1.compartment.oc1..aaaaaaacsxgoz7flzmry5dr6scf7xru6lwqpoygqld74npvn5rdj2cv3iiq homeRegion: us-ashburn-1 id: ocid1.pingprobe.OC2...abuxgljr6l4nepxjkmbtnibwqpu6y34xdvmr7okzoi47wicoflrxh32rwd9z protocol: ICMP resultsUrl: https://healthchecks.us-ashburn-1.oraclecloud.com/20180501/pingProbeResults/ocid1.pingprobe.OC2...abuxgljr6l4nepxjkmbtnibwqpu6y34xdvmr7okzoi47wicoflrxh32rwd9z targets: - www.example.com timeCreated: 2019-09-03 15:09:02+00:00 timeoutInSeconds: 30 vantagePointNames: - oci-ashburn-ad2 - aws-ashburn-az1 - ibm-seattle-1 Routing: description: The routing information for a vantage point. properties: asLabel: description: 'The registry label for `asn`, usually the name of the organization that owns the ASN. May be omitted or null. ' readOnly: true type: string asn: description: 'The Autonomous System Number (ASN) identifying the organization responsible for routing packets to `prefix`. ' readOnly: true type: integer prefix: description: 'An IP prefix (CIDR syntax) that is less specific than `address`, through which `address` is routed. ' readOnly: true type: string weight: description: 'An integer between 0 and 100 used to select between multiple origin ASNs when routing to `prefix`. Most prefixes have exactly one origin ASN, in which case `weight` will be 100. ' readOnly: true type: integer type: object HttpProbe: description: 'A summary that contains all of the mutable and immutable properties for an HTTP probe. ' properties: compartmentId: description: The OCID of the compartment. maxLength: 255 minLength: 1 type: string headers: additionalProperties: type: string description: 'A dictionary of HTTP request headers. *Note:* Monitors and probes do not support the use of the `Authorization` HTTP header. ' type: object homeRegion: description: 'The region where updates must be made and where results must be fetched from. ' maxLength: 255 minLength: 1 type: string x-example: us-ashburn-1 id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string method: default: HEAD enum: - GET - HEAD type: string x-obmcs-top-level-enum: '#/definitions/HttpProbeMethod' path: default: / description: The optional URL path to probe, including query parameters. type: string x-example: /index.html port: description: 'The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol. ' type: integer protocol: enum: - HTTP - HTTPS type: string x-obmcs-top-level-enum: '#/definitions/HttpProbeProtocol' resultsUrl: description: A URL for fetching the probe results. format: url type: string targets: description: A list of targets (hostnames or IP addresses) of the probe. items: type: string minItems: 1 type: array timeCreated: description: 'The RFC 3339-formatted creation date and time of the probe. ' format: date-time type: string timeoutInSeconds: description: 'The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to `intervalInSeconds` for monitors. ' type: integer vantagePointNames: description: A list of names of vantage points from which to execute the probe. items: type: string type: array type: object x-example: compartmentId: ocid1.compartment.oc1..aaaaaaacsxgoz7flzmry5dr6scf7xru6lwqpoygqld74npvn5rdj2cv3iiq homeRegion: us-ashburn-1 id: ocid1.httpprobe.OC2...abuxgljr6l4nepxjkmbtnibwqpu6y34xdvmr7okzoi47wicoflrxh32rwd8z protocol: HTTPS resultsUrl: https://healthchecks.us-ashburn-1.oraclecloud.com/20180501/httpProbeResults/ocid1.httpprobe.OC2...abuxgljr6l4nepxjkmbtnibwqpu6y34xdvmr7okzoi47wicoflrxh32rwd8z targets: - www.example.com - www.oracle.com timeCreated: 2019-09-03 15:09:02+00:00 timeoutInSeconds: 30 vantagePointNames: - oci-ashburn-ad2 - aws-ashburn-az1 - ibm-seattle-1 CreatePingMonitorDetails: description: The request body used to create a Ping monitor. properties: compartmentId: description: The OCID of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: A user-friendly and mutable name suitable for display in a user interface. type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object intervalInSeconds: description: 'The monitor interval in seconds. Valid values: 10, 30, and 60. ' type: integer isEnabled: default: true description: 'Enables or disables the monitor. Set to ''true'' to launch monitoring. ' type: boolean port: description: 'The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol. ' type: integer protocol: enum: - ICMP - TCP type: string x-obmcs-top-level-enum: '#/definitions/PingProbeProtocol' targets: description: A list of targets (hostnames or IP addresses) of the probe. items: type: string minItems: 1 type: array timeoutInSeconds: description: 'The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to `intervalInSeconds` for monitors. ' type: integer vantagePointNames: description: A list of names of vantage points from which to execute the probe. items: type: string type: array required: - compartmentId - targets - protocol - intervalInSeconds - displayName type: object x-example: compartmentId: ocid1.compartment.oc1..aaaaaaacsxgoz7flzmry5dr6scf7xru6lwqpoygqld74npvn5rdj2cv3iiq displayName: Example Monitor intervalInSeconds: 30 protocol: ICMP targets: - www.example.com timeoutInSeconds: 30 vantagePointNames: - oci-ashburn-ad2 - aws-ashburn-az1 - ibm-seattle-1 ChangeHttpMonitorCompartmentDetails: description: The request body used to move a monitor into a compartment. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object x-example: compartmentId: ocid1.compartment.oc1..aaaaaaacsxgoz7flzmry5dr6scf7xru6lwqpoygqld74npvn5rdj2cv3iiq TcpConnection: description: TCP connection results. All durations are in milliseconds. properties: address: description: The connection IP address. format: ip-address readOnly: true type: string connectDuration: description: Total connect duration, calculated using `connectEnd` minus `connectStart`. format: double readOnly: true type: number port: description: The port. readOnly: true type: integer secureConnectDuration: description: 'The duration to secure the connection. This value will be zero for insecure connections. Calculated using `connectEnd` minus `secureConnectionStart`. ' format: double readOnly: true type: number type: object PingProbeResultSummary: description: 'The results returned by running a ping probe. All times and durations are returned in milliseconds. All times are relative to the POSIX epoch (1970-01-01T00:00Z). ' properties: connection: $ref: '#/components/schemas/Connection' dns: $ref: '#/components/schemas/DNS' domainLookupEnd: description: 'The time immediately before the vantage point finishes the domain name lookup for the resource. ' format: double readOnly: true type: number domainLookupStart: description: 'The time immediately before the vantage point starts the domain name lookup for the resource. ' format: double readOnly: true type: number errorCategory: default: NONE description: 'The category of error if an error occurs executing the probe. The `errorMessage` field provides a message with the error details. * NONE - No error * DNS - DNS errors * TRANSPORT - Transport-related errors, for example a "TLS certificate expired" error. * NETWORK - Network-related errors, for example a "network unreachable" error. * SYSTEM - Internal system errors. ' enum: - NONE - DNS - TRANSPORT - NETWORK - SYSTEM readOnly: true type: string errorMessage: description: The error information indicating why a probe execution failed. readOnly: true type: string x-example: Unable to resolve host icmpCode: description: 'The ICMP code of the response message. This field is not used when the protocol is set to TCP. For more information on ICMP codes, see [Internet Control Message Protocol (ICMP) Parameters](https://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml). ' readOnly: true type: integer isHealthy: description: 'True if the probe result is determined to be healthy based on probe type-specific criteria. For HTTP probes, a probe result is considered healthy if the HTTP response code is greater than or equal to 200 and less than 300. ' readOnly: true type: boolean isTimedOut: description: 'True if the probe did not complete before the configured `timeoutInSeconds` value. ' type: boolean key: description: 'A value identifying this specific probe result. The key is only unique within the results of its probe configuration. The key may be reused after 90 days. ' type: string x-example: 651b9f3a46041cace0530204060ae27e latencyInMs: description: 'The latency of the probe execution, in milliseconds. ' format: double readOnly: true type: number probeConfigurationId: description: 'The OCID of the monitor or on-demand probe responsible for creating this result. ' maxLength: 255 minLength: 1 type: string protocol: enum: - ICMP - TCP type: string x-obmcs-top-level-enum: '#/definitions/PingProbeProtocol' startTime: description: 'The date and time the probe was executed, expressed in milliseconds since the POSIX epoch. This field is defined by the PerformanceResourceTiming interface of the W3C Resource Timing specification. For more information, see [Resource Timing](https://w3c.github.io/resource-timing/#sec-resource-timing). ' format: double type: number target: description: The target hostname or IP address of the probe. type: string vantagePointName: description: The name of the vantage point that executed the probe. type: string type: object HttpMonitorSummary: description: 'A summary containing all of the mutable and immutable properties for an HTTP monitor. ' properties: compartmentId: description: The OCID of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: A user-friendly and mutable name suitable for display in a user interface. type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object homeRegion: description: 'The region where updates must be made and where results must be fetched from. ' maxLength: 255 minLength: 1 type: string x-example: us-ashburn-1 id: description: The OCID of the resource. maxLength: 255 minLength: 1 type: string intervalInSeconds: description: 'The monitor interval in seconds. Valid values: 10, 30, and 60. ' type: integer isEnabled: default: true description: 'Enables or disables the monitor. Set to ''true'' to launch monitoring. ' type: boolean protocol: enum: - HTTP - HTTPS type: string x-obmcs-top-level-enum: '#/definitions/HttpProbeProtocol' resultsUrl: description: A URL for fetching the probe results. format: url type: string timeCreated: description: 'The RFC 3339-formatted creation date and time of the probe. ' format: date-time type: string type: object x-example: compartmentId: ocid1.compartment.oc1..aaaaaaacsxgoz7flzmry5dr6scf7xru6lwqpoygqld74npvn5rdj2cv3iiq displayName: Example Monitor homeRegion: us-ashburn-1 id: ocid1.httpmonitor.OC2...abuxgljr6l4nepxjkmbtnibwqpu5z24xdvmr7okzoi47wicoflrxh32rwd7a intervalInSeconds: 30 isEnabled: true protocol: HTTPS resultsUrl: https://healthchecks.us-ashburn-1.oraclecloud.com/20180501/httpProbeResults/ocid1.httpmonitor.OC2...abuxgljr6l4nepxjkmbtnibwqpu5z24xdvmr7okzoi47wicoflrxh32rwd7a timeCreated: 2019-09-03 15:09:02+00:00 CreateOnDemandHttpProbeDetails: description: The request body used to create an on-demand HTTP probe. properties: compartmentId: description: The OCID of the compartment. maxLength: 255 minLength: 1 type: string headers: additionalProperties: type: string description: 'A dictionary of HTTP request headers. *Note:* Monitors and probes do not support the use of the `Authorization` HTTP header. ' type: object method: default: HEAD enum: - GET - HEAD type: string x-obmcs-top-level-enum: '#/definitions/HttpProbeMethod' path: default: / description: The optional URL path to probe, including query parameters. type: string x-example: /index.html port: description: 'The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol. ' type: integer protocol: enum: - HTTP - HTTPS type: string x-obmcs-top-level-enum: '#/definitions/HttpProbeProtocol' targets: description: A list of targets (hostnames or IP addresses) of the probe. items: type: string minItems: 1 type: array timeoutInSeconds: description: 'The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to `intervalInSeconds` for monitors. ' type: integer vantagePointNames: description: A list of names of vantage points from which to execute the probe. items: type: string type: array required: - compartmentId - targets - protocol type: object x-example: compartmentId: ocid1.compartment.oc1..aaaaaaacsxgoz7flzmry5dr6scf7xru6lwqpoygqld74npvn5rdj2cv3iiq protocol: HTTPS targets: - www.example.com - www.oracle.com timeoutInSeconds: 30 vantagePointNames: - oci-ashburn-ad2 - aws-ashburn-az1 - ibm-seattle-1 parameters: PaginationTokenQueryParam: description: 'The value of the `opc-next-page` response header from the previous "List" call. ' in: query name: page required: false schema: type: string maxLength: 512 minLength: 1 NameQueryParam: description: Filters results that exactly match the `name` field. in: query name: name required: false x-default-description: 'null' schema: type: string MonitorIdPathParam: description: The OCID of a monitor. in: path name: monitorId required: true schema: type: string CompartmentIdQueryParam: description: Filters results by compartment. in: query name: compartmentId required: true schema: type: string ProbeConfigurationIdPathParam: description: The OCID of a monitor or on-demand probe. in: path name: probeConfigurationId required: true schema: type: string OpcRetryTokenHeaderParam: description: 'A token that uniquely identifies a request that can be retried in case of a timeout or server error without risk of executing the same action again. Retry tokens expire after 24 hours. *Note:* Retry tokens can be invalidated before the 24 hour time limit due to conflicting operations, such as a resource being deleted or purged from the system. ' in: header name: opc-retry-token schema: type: string maxLength: 64 minLength: 1 StartTimeLessThanOrEqualToQueryParam: description: Returns results with a `startTime` equal to or less than the specified value. in: query name: startTimeLessThanOrEqualTo required: false schema: type: number format: double IfNoneMatchHeaderParam: description: 'The `If-None-Match` header field makes the request method conditional on the absence of any current representation of the target resource, when the field-value is `*`, or having a selected representation with an entity-tag that does not match any of those listed in the field-value. ' in: header name: if-none-match schema: type: string PaginationLimitQueryParam: description: 'The maximum number of items to return in a paginated "List" call. ' in: query name: limit required: false schema: type: integer default: 100 maximum: 1000 minimum: 1 IfMatchHeaderParam: 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 schema: type: string VantagePointSortByQueryParam: description: The field to sort by when listing vantage points. in: query name: sortBy required: false schema: type: string enum: - name - displayName default: name HomeRegionQueryParam: description: Filters results that match the `homeRegion`. in: query name: homeRegion required: false x-default-description: 'null' schema: type: string SortOrderQueryParam: description: Controls the sort order of results. in: query name: sortOrder required: false schema: type: string enum: - ASC - DESC default: ASC TargetQueryParam: description: Filters results that match the `target`. in: query name: target required: false x-default-description: 'null' schema: type: string MonitorSortByQueryParam: description: The field to sort by when listing monitors. in: query name: sortBy required: false schema: type: string enum: - id - displayName - timeCreated default: id OpcRequestIdHeaderParam: description: 'Unique Oracle-assigned 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 DisplayNameQueryParam: description: Filters results that exactly match the `displayName` field. in: query name: displayName required: false x-default-description: 'null' schema: type: string StartTimeGreaterThanOrEqualToQueryParam: description: Returns results with a `startTime` equal to or greater than the specified value. in: query name: startTimeGreaterThanOrEqualTo required: false schema: type: number format: double x-oracle-package: com.oracle.pic.healthchecks