{ "opencollection": "1.0.0", "info": { "name": "Health Checks API", "version": "20180501" }, "items": [ { "info": { "name": "healthChecks", "type": "folder" }, "items": [ { "info": { "name": "Gets HTTP monitors.", "type": "http" }, "http": { "method": "GET", "url": "/20180501/httpMonitors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call.\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header\nfrom the previous \"List\" call.\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "Filters results by compartment." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by when listing monitors." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Controls the sort order of results." }, { "name": "displayName", "value": "", "type": "query", "description": "Filters results that exactly match the `displayName` field." }, { "name": "homeRegion", "value": "", "type": "query", "description": "Filters results that match the `homeRegion`." } ] }, "docs": "Gets a list of HTTP monitors.\nFor more information, see\n[Listing HTTP Monitors](/iaas/Content/HealthChecks/Tasks/list-http-monitor.htm).\n" }, { "info": { "name": "Creates an HTTP monitor.", "type": "http" }, "http": { "method": "POST", "url": "/20180501/httpMonitors", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an HTTP monitor. Vantage points will be automatically selected if not specified,\nand probes will be initiated from each vantage point to each of the targets at the frequency\nspecified by `intervalInSeconds`.\nFor more information, see\n[Creating an HTTP Monitor](/iaas/Content/HealthChecks/Tasks/create-http-monitor.htm).\n" }, { "info": { "name": "Gets the HTTP monitor configuration.", "type": "http" }, "http": { "method": "GET", "url": "/20180501/httpMonitors/:monitorId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-none-match", "value": "" } ], "params": [ { "name": "monitorId", "value": "", "type": "path", "description": "The OCID of a monitor." } ] }, "docs": "Gets the configuration for the specified monitor.\nFor more information, see\n[Getting an HTTP Monitor's Details](/iaas/Content/HealthChecks/Tasks/get-http-monitor.htm).\n" }, { "info": { "name": "Updates the HTTP monitor configuration.", "type": "http" }, "http": { "method": "PUT", "url": "/20180501/httpMonitors/:monitorId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "monitorId", "value": "", "type": "path", "description": "The OCID of a monitor." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the configuration of the specified HTTP monitor. Only the fields\nspecified in the request body will be updated; all other configuration\nproperties will remain unchanged.\nFor more information, see\n[Updating an HTTP Monitor](/iaas/Content/HealthChecks/Tasks/update-http-monitor.htm).\n" }, { "info": { "name": "Deletes the HTTP monitor.", "type": "http" }, "http": { "method": "DELETE", "url": "/20180501/httpMonitors/:monitorId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "monitorId", "value": "", "type": "path", "description": "The OCID of a monitor." } ] }, "docs": "Deletes the HTTP monitor and its configuration. All future probes of this\nmonitor are stopped. Results associated with the monitor are not deleted.\nFor more information, see\n[Deleting an HTTP Monitor](/iaas/Content/HealthChecks/Tasks/delete-http-monitor.htm).\n" }, { "info": { "name": "Moves a monitor into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "/20180501/httpMonitors/:monitorId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "monitorId", "value": "", "type": "path", "description": "The OCID of a monitor." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a monitor into a different compartment. When provided, `If-Match` is checked\nagainst ETag values of the resource.\nFor more information, see\n[Moving an HTTP Monitor](/iaas/Content/HealthChecks/Tasks/change-compartment-http-monitor.htm).\n" }, { "info": { "name": "Creates an on-demand HTTP probe.", "type": "http" }, "http": { "method": "POST", "url": "/20180501/httpProbeResults", "headers": [ { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an on-demand HTTP probe. The location response header contains the URL for\nfetching the probe results.\nFor more information, see\n[Creating an HTTP On-Demand Probe](/iaas/Content/HealthChecks/Tasks/create-http-probe.htm).\n\n*Note:* On-demand probe configurations are not saved.\n" }, { "info": { "name": "Gets the HTTP probe results for the specified monitor or on-demand probe.", "type": "http" }, "http": { "method": "GET", "url": "/20180501/httpProbeResults/:probeConfigurationId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "probeConfigurationId", "value": "", "type": "path", "description": "The OCID of a monitor or on-demand probe." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call.\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header\nfrom the previous \"List\" call.\n" }, { "name": "startTimeGreaterThanOrEqualTo", "value": "", "type": "query", "description": "Returns results with a `startTime` equal to or greater than the specified value." }, { "name": "startTimeLessThanOrEqualTo", "value": "", "type": "query", "description": "Returns results with a `startTime` equal to or less than the specified value." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Controls the sort order of results." }, { "name": "target", "value": "", "type": "query", "description": "Filters results that match the `target`." } ] }, "docs": "Gets the HTTP probe results for the specified probe or monitor, where\nthe `probeConfigurationId` is the OCID of either a monitor or an\non-demand probe.\nFor more information, see\n[Listing Results for an HTTP On-Demand Probe](/iaas/Content/HealthChecks/Tasks/list-http-probe-result.htm).\n" }, { "info": { "name": "Returns Ping monitors.", "type": "http" }, "http": { "method": "GET", "url": "/20180501/pingMonitors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call.\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header\nfrom the previous \"List\" call.\n" }, { "name": "compartmentId", "value": "", "type": "query", "description": "Filters results by compartment." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by when listing monitors." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Controls the sort order of results." }, { "name": "displayName", "value": "", "type": "query", "description": "Filters results that exactly match the `displayName` field." }, { "name": "homeRegion", "value": "", "type": "query", "description": "Filters results that match the `homeRegion`." } ] }, "docs": "Gets a list of configured ping monitors.\nFor more information, see\n[Listing Ping Monitors](/iaas/Content/HealthChecks/Tasks/list-ping-monitor.htm).\n\nResults are paginated based on `page` and `limit`. The `opc-next-page` header provides\na URL for fetching the next page.\n" }, { "info": { "name": "Creates a Ping monitor.", "type": "http" }, "http": { "method": "POST", "url": "/20180501/pingMonitors", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a ping monitor. Vantage points will be automatically selected if not specified,\nand probes will be initiated from each vantage point to each of the targets at the frequency\nspecified by `intervalInSeconds`.\nFor more information, see\n[Creating a Ping Monitor](/iaas/Content/HealthChecks/Tasks/create-ping-monitor.htm).\n" }, { "info": { "name": "Returns the Ping monitor configuration.", "type": "http" }, "http": { "method": "GET", "url": "/20180501/pingMonitors/:monitorId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-none-match", "value": "" } ], "params": [ { "name": "monitorId", "value": "", "type": "path", "description": "The OCID of a monitor." } ] }, "docs": "Gets the configuration for the specified ping monitor.\nFor more information, see\n[Getting a Ping Monitor's Details](/iaas/Content/HealthChecks/Tasks/get-ping-monitor.htm).\n" }, { "info": { "name": "Updates the Ping monitor configuration.", "type": "http" }, "http": { "method": "PUT", "url": "/20180501/pingMonitors/:monitorId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "monitorId", "value": "", "type": "path", "description": "The OCID of a monitor." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the configuration of the specified ping monitor. Only the fields\nspecified in the request body will be updated; all other configuration properties\nwill remain unchanged.\nFor more information, see\n[Updating a Ping Monitor](/iaas/Content/HealthChecks/Tasks/update-ping-monitor.htm).\n" }, { "info": { "name": "Deletes the Ping monitor configuration.", "type": "http" }, "http": { "method": "DELETE", "url": "/20180501/pingMonitors/:monitorId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "monitorId", "value": "", "type": "path", "description": "The OCID of a monitor." } ] }, "docs": "Deletes the ping monitor and its configuration. All future probes of this\nmonitor are stopped. Results associated with the monitor are not deleted.\nFor more information, see\n[Deleting a Ping Monitor](/iaas/Content/HealthChecks/Tasks/delete-ping-monitor.htm).\n" }, { "info": { "name": "Moves a monitor into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "/20180501/pingMonitors/:monitorId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "monitorId", "value": "", "type": "path", "description": "The OCID of a monitor." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a monitor into a different compartment. When provided, `If-Match` is checked\nagainst ETag values of the resource.\nFor more information, see\n[Moving a Ping Monitor](/iaas/Content/HealthChecks/Tasks/change-compartment-ping-monitor.htm).\n" }, { "info": { "name": "Creates an on-demand Ping probe.", "type": "http" }, "http": { "method": "POST", "url": "/20180501/pingProbeResults", "headers": [ { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an on-demand ping probe. The location response header contains the URL for\nfetching probe results.\nFor more information, see\n[Creating a Ping On-Demand Probe](/iaas/Content/HealthChecks/Tasks/create-ping-probe.htm).\n\n*Note:* The on-demand probe configuration is not saved.\n" }, { "info": { "name": "Returns the Ping probe results for the specified monitor or on-demand probe.", "type": "http" }, "http": { "method": "GET", "url": "/20180501/pingProbeResults/:probeConfigurationId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "probeConfigurationId", "value": "", "type": "path", "description": "The OCID of a monitor or on-demand probe." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call.\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header\nfrom the previous \"List\" call.\n" }, { "name": "startTimeGreaterThanOrEqualTo", "value": "", "type": "query", "description": "Returns results with a `startTime` equal to or greater than the specified value." }, { "name": "startTimeLessThanOrEqualTo", "value": "", "type": "query", "description": "Returns results with a `startTime` equal to or less than the specified value." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Controls the sort order of results." }, { "name": "target", "value": "", "type": "query", "description": "Filters results that match the `target`." } ] }, "docs": "Returns the results for the specified probe, where the `probeConfigurationId`\nis the OCID of either a monitor or an on-demand probe.\nFor more information, see\n[Listing Results for a Ping On-Demand Probe](/iaas/Content/HealthChecks/Tasks/list-ping-probe-result.htm).\n\nResults are paginated based on `page` and `limit`. The `opc-next-page` header provides\na URL for fetching the next page. Use `sortOrder` to set the order of the\nresults. If `sortOrder` is unspecified, results are sorted in ascendi" }, { "info": { "name": "Returns information about available vantage points.\n", "type": "http" }, "http": { "method": "GET", "url": "/20180501/vantagePoints", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call.\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header\nfrom the previous \"List\" call.\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by when listing vantage points." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Controls the sort order of results." }, { "name": "name", "value": "", "type": "query", "description": "Filters results that exactly match the `name` field." }, { "name": "displayName", "value": "", "type": "query", "description": "Filters results that exactly match the `displayName` field." } ] }, "docs": "Gets information about all vantage points available to the user.\nFor more information, see\n[Listing Vantage Points](/iaas/Content/HealthChecks/Tasks/list-vantage-point.htm).\n" } ] } ], "bundled": true }