{
    "swagger":"2.0",
    "info":{
        "title":"REST API for Health Check in Oracle Access Manager",
        "description":"Server health is returned by this service",
        "version":"2025.02.19",
        "x-summary":"Server health is returned by this service"
    },
    "basePath":"/iam/access",
    "schemes":[
        "https"
    ],
    "paths":{
        "/api/v1/healthcheck":{
            "get":{
                "summary":"Perform method GET on resource",
                "description":"Health check on the server is performed. The health check is performed on a default list of tests if a testListid\n query parameter is not provided.",
                "produces":[
                    "application/xml",
                    "application/json",
                    "text/xml"
                ],
                "parameters":[
                    {
                        "name":"report",
                        "in":"query",
                        "description":"determines the details of the report.",
                        "required":false,
                        "type":"string"
                    },
                    {
                        "name":"testlistid",
                        "in":"query",
                        "description":"id of test list that should be run. Optional parameter. Default test list will be run if not provided.",
                        "required":false,
                        "type":"string"
                    }
                ],
                "responses":{
                    "default":{
                        "description":"on success produces http://serverhost:serverport/iam/access/schema/hc_response-v1.xsd"
                    }
                },
                "tags":[
                    "Health Monitoring"
                ],
                "x-internal-id":"api-v1-healthcheck-get",
                "x-filename-id":"api-v1-healthcheck-get"
            }
        },
        "/api/v1/health/application.xml":{
            "get":{
                "summary":"Perform method GET on resource",
                "description":"Web Application Definition Document is generated. It describes the REST services provided. The wadl document is not subject to transformations and can be retrieved in xml.",
                "produces":[
                    "text/xml"
                ],
                "responses":{
                    "default":{
                        "description":"on success returns https://github.com/jersey/jersey/blob/master/core-server/etc/wadl.xsd"
                    }
                },
                "tags":[
                    "Health Monitoring"
                ],
                "x-internal-id":"api-v1-health-application.xml-get",
                "x-filename-id":"api-v1-health-application-xml-get"
            }
        },
        "/api/v1/health/script/evaluate":{
            "get":{
                "summary":"Perform method GET on resource",
                "description":"Page supporting script evaluation is returned. The page format is HTML.",
                "produces":[
                    "text/html"
                ],
                "responses":{
                    "default":{
                        "description":"on success returns html that enables script evaluation."
                    }
                },
                "tags":[
                    "Health Scripts"
                ],
                "x-internal-id":"api-v1-health-script-evaluate-get",
                "x-filename-id":"api-v1-health-script-evaluate-get"
            }
        },
        "/api/v1/health/dmsinfo":{
            "get":{
                "summary":"Perform method GET on resource",
                "description":"Dms information can be introspected by performing the following operations. Operation to be performed is expected \n to be specified in the operation parameter.\n Available operations: <dl><dt>types</dt><dd> Lists all available types</dd>\n               <dt>type </dt><dd>Lists noun information for type provided in parameter <i>type</i></dd>\n               <dt>sensors </dt><dd>Lists sensor information for type provided in parameter <i>type</i></dd>\n               <dt>reset </dt><dd>resets sensors for type provided in parameter <i>type</i></dd>\n               <dt>help </dt><dd>Produces a help message describing available operations</dd>\n               <dt>nouns </dt><dd>displays nouns and generic information .The list can be filtered by providing parameter \n                <i>prefix</i> that would be the noun path prefix, or noun type specified by <i>type</i></dd>\n               <dt>objects </dt><dd>displays objects and generic information .The list can be filtered by providing parameter \n                <i>prefix</i> that would be the noun path prefix</dd></dl>",
                "produces":[
                    "text/html"
                ],
                "parameters":[
                    {
                        "name":"prefix",
                        "in":"query",
                        "description":"Noun path prefix",
                        "required":false,
                        "type":"string"
                    },
                    {
                        "name":"type",
                        "in":"query",
                        "description":"dms sensor type that needs to be queried on.",
                        "required":false,
                        "type":"string"
                    },
                    {
                        "name":"operation",
                        "in":"query",
                        "description":"operation to be performed. Should contain the name of the operation.",
                        "required":false,
                        "type":"string"
                    },
                    {
                        "name":"sensor",
                        "in":"query",
                        "description":"parameter identifies the output list as list of sensors for provided type.",
                        "required":false,
                        "type":"string"
                    }
                ],
                "responses":{
                    "default":{
                        "description":"success",
                        "schema":{
                            "format":"text/html"
                        }
                    }
                },
                "tags":[
                    "DMS Information"
                ],
                "x-internal-id":"api-v1-health-dmsinfo-get",
                "x-filename-id":"api-v1-health-dmsinfo-get"
            }
        },
        "/api/v1/health/dms/application.json":{
            "get":{
                "summary":"Perform method GET on resource",
                "description":"Web Application Definition Document is generated based on swagger 2.0. It describes the REST services provided.",
                "produces":[
                    "application/json"
                ],
                "responses":{
                    "default":{
                        "description":"on success generates instance of https://github.com/jersey/jersey/blob/master/core-server/etc/wadl.xsd"
                    }
                },
                "tags":[
                    "DMS Information"
                ],
                "x-internal-id":"api-v1-health-dms-application.json-get",
                "x-filename-id":"api-v1-health-dms-application-json-get"
            }
        }
    },
    "tags":[
        {
            "name":"DMS Information",
            "description":"DMS information support for health monitoring scripts"
        },
        {
            "name":"Health Monitoring",
            "description":"Server health is monitored"
        },
        {
            "name":"Health Scripts",
            "description":"Support for developing scripts for server health monitoring"
        }
    ]
}