Oracle

Oracle Health Checks API

The healthChecks API from Oracle — 11 operation(s) for healthchecks.

GitHub OpenAPI

Documentation

📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/access-governance-cp/20220518/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/adm/20220421/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/advisor/20200606/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ai-data-platform/20240831/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/analytics/20190331/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/announcements/0.0.1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/api-gateway/20190501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-config/20210201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-control-plane/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-synthetic-monitoring/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-trace-explorer/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/audit/20190901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/autoscaling/20181001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/bastion/20210331/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/batch/20251031/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/bigdata/20190531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/blockchain/20191010/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/budgets/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/certificates/20210224/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/certificatesmgmt/20210224/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/cloud-guard/20200131/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/clusterplacementgroups/20230801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/compute-cloud-at-customer/20221208/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/container-instances/20210415/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/container-registry/20180419/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/containerengine/20180222/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/cost-anomaly/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dashboard/20210731/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-catalog/20190325/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-flow/20200129/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-integration/20200430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-safe/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-science/20190101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-management/20201101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-migration/20230518/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-multicloud-integrations/20240501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-tools/20201005/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-tools-runtime/20230222/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datacc/20251101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datalabeling-dp/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datalabeling/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/delegate-access-control/20230801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/devops/20210630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/digital-assistant/20190506/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/disaster-recovery/20220125/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dms/20211101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dns/20180115/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/document-understanding/20221109/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/edsfu/20220528/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/emaildelivery/20170907/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/emaildeliverysubmission/20220926/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/events/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/filestorage/20171215/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/fleet-management/20250228/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/functions/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/functionsdocgenpbf/1.0/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/fusion-applications/20211201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-agents-client/20240531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-agents/20240531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-inference/20231130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-nl2sql/20260325/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai/20231130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generic/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/globally-distributed-database/20250101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/goldengate/20200407/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/healthchecks/20180501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/iaas/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity-domains/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity-dp/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/incidentmanagement/20181231/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/instanceagent/20180530/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/integration/20190131/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/iot/20250531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/itas/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms-java-download/20230601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms/20210610/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms-utils/20250521/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/kafka/20240901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/key/release/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/language/20221001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/licensemanager/20220430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/limits-increase/20251101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/limits/20181025/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/loadbalancer/20170115/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logan-api-spec/20200601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-dataplane/20200831/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-management/20200531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-search/20190909/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/lustre/20250228/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/managed-access/20220126/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/management-agent/20200202/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/managementdashboard/20200901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/marketplace/20181001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/mngdmac/20250320/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/monitoring/20180401/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/multicloud-omhub-cp/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/mysql/20190415/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/NetMonitor/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/network-firewall/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/network-firewall/20230501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/networkloadbalancer/20200501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/nosql-database/20190828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/objectstorage/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/OCB/20220509/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occ/20230515/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occds/20240430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occm/20231107/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ocicache/20220315/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ocm/20220919/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/opa/20210621/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/opensearch/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/operations-insights/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/operatoraccesscontrol/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/oracle-api-access-control/20241130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/organizations/20230401/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/organizations/20200801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/osmh/20220901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/postgresql/20220915/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/psasvc/20240301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/publisher/20241201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/queue/20210201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/recovery-service/20210216/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/registry/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-analytics/20241031/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-discovery-monitoring-control-api/20210330/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-scheduler/20240430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resourcemanager/20180917/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/rover/20201210/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/s3objectstorage/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/scanning/20210215/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/search/20180409/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secretmgmt/20180608/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secretretrieval/20190301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secure-desktops/20220618/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/security-attribute/20240815/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/self/20260129/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/service-catalog/20210527/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/serviceconnectors/20200909/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/smp/20210914/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/speech/20220101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/stack-monitoring/20210330/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/streaming/20180418/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/threat-intel/20220901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/usage/20200107/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/usage-proxy/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vision/20220125/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/visual-builder/20210601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/visual-builder-studio/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vmware/20200501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vmware/20230701/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waa/20211230/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waas/20181116/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waf/20210930/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/wlms/20241101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/workrequests/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/zero-trust-packet-routing/20240301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/zero-trust-packet-routing-tools/20240301/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-healthchecks-api-openapi.yml

OpenAPI Specification

oracle-healthchecks-api-openapi.yml Raw ↑ 
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

        <var>&lt;authorization and other headers&gt;</var>

        '
    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<var>&lt;authorization and other headers&gt;</var>\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

        <var>&lt;authorization and other headers&gt;</var>

        '
      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

        <var>&lt;authorization and other headers&gt;</var>

        '
    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<var>&lt;authorization and other headers&gt;</var>\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<var>&lt;authorization and other headers&gt;</var>\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

        <var>&lt;authorization and other headers&gt;</var>

        {

        "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

        <var>&lt;authorization and other headers&gt;</var>

        '
  /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

        <var>&lt;authorization and other headers&gt;</var>

        '
    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<var>&lt;authorization and other headers&gt;</var>\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

        <var>&lt;authorization and other headers&gt;</var>

        '
      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

        <var>&lt;authorization and other headers&gt;</var>

        '
    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<var>&lt;authorization and other headers&gt;</var>\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<var>&lt;authorization and other headers&gt;

# --- truncated at 32 KB (103 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-healthchecks-api-openapi.yml