Details for Health Checks

Review advanced details for writing policies to control access to the Health Checks service.

Resource-Types

Aggregate Resource-Type

health-check-family

The health-check-family aggregate resource-type covers these individual resource-types:

  • health-check-monitor
  • health-check-results
  • on-demand-probe
  • vantage-points

Individual Resource-Types

health-check-monitor

health-check-results

on-demand-probe

vantage-points

Supported Variables

Health Checks supports all the general variables (see General Variables for All Requests), plus the variables listed here. Values in the list can be any valid test type, such as HTTP, HTTPS, and ICMP.

Variable Variable Type Comments
target.health-check-monitor.test-type String  
target.on-demand-probe.test-type String  
target.health-check-results.test-type String  

Details for Verb + Resource-Type Combinations

The following tables show the permissions and API operations covered by each verb. The level of access is cumulative as you go from inspect > read > use > manage. A plus sign (+) in a table cell indicates incremental access compared to the cell directly above it, whereas "no extra" indicates no incremental access.

For example, the use verb for the health-check-monitor resource-type covers no extra permissions or API operations compared to the read verb.

health-check-monitor
Verbs Permissions APIs Fully Covered APIs Partially Covered
inspect

HEALTH_CHECK_MONITOR_INSPECT

ListHttpMonitors

ListPingMonitors

none
read

INSPECT +

HEALTH_CHECK_MONITOR_READ

GetHttpMonitor

GetPingMonitor

none
use

READ +

no extra

none none
manage

USE +

HEALTH_CHECK_MONITOR_MANAGE

HEALTH_CHECK_MONITOR_MOVE

CreateHttpMonitor

DeleteHttpMonitor

UpdateHttpMonitor

CreatePingMonitor

DeletePingMonitor

UpdatePingMonitor

ChangeHttpMonitorCompartment

ChangePingMonitorCompartment

none
health-check-results
Verbs Permissions APIs Fully Covered APIs Partially Covered
inspect none none none
read

INSPECT +

HEALTH_CHECK_RESULTS_READ

ListHttpProbeResults

ListPingProbeResults

none
use

READ +

no extra

none none
manage

USE +

no extra

none none
vantage-points
Verbs Permissions APIs Fully Covered APIs Partially Covered
inspect VANTAGE_POINTS_INSPECT ListHealthChecksVantagePoints none
read

INSPECT +

no extra

none none
use

READ +

no extra

none none
manage

USE +

no extra

none none
on-demand-probe
Verbs Permissions APIs Fully Covered APIs Partially Covered
inspect none none none
read

INSPECT +

no extra

none none
use

READ +

no extra

none none
manage

USE +

ON_DEMAND_PROBE_MANAGE

CreateOnDemandHttpProbe

CreateOnDemandPingProbe

none

Permissions Required for Each API Operation

The following table lists the API operations in a logical order, grouped by resource type.

For information about permissions, see Permissions.

API Operation Permissions Required to Use the Operation
ListHealthChecksVantagePoints VANTAGE_POINTS_INSPECT
ChangeHttpMonitorCompartment HEALTH_CHECK_MONITOR_MOVE
CreateHttpMonitor HEALTH_CHECK_MONITOR_MANAGE
DeleteHttpMonitor HEALTH_CHECK_MONITOR_MANAGE
GetHttpMonitor HEALTH_CHECK_MONITOR_READ
UpdateHttpMonitor HEALTH_CHECK_MONITOR_MANAGE
ListHttpMonitors HEALTH_CHECK_MONITOR_INSPECT
CreateOnDemandHttpProbe ON_DEMAND_PROBE_MANAGE
ListHttpProbeResults HEALTH_CHECK_RESULTS_READ
ChangePingMonitorCompartment HEALTH_CHECK_MONITOR_MOVE
CreatePingMonitor HEALTH_CHECK_MONITOR_MANAGE
DeletePingMonitor HEALTH_CHECK_MONITOR_MANAGE
GetPingMonitor HEALTH_CHECK_MONITOR_READ
UpdatePingMonitor HEALTH_CHECK_MONITOR_MANAGE
ListPingMonitors HEALTH_CHECK_MONITOR_INSPECT
CreateOnDemandPingProbe ON_DEMAND_PROBE_MANAGE
ListPingProbeResults HEALTH_CHECK_RESULTS_READ