Jump to

• Request
• Response

Get Heath Check

get

/api/v1/aia/sg/call-summary/summaries/healthcheck

Check the health of the system.

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful Response

Body ()

Root Schema : ResourceHealthChecks

Type: object

Title: ResourceHealthChecks

Show Source

• resources_health(required): array Resources Health
  Title: Resources Health

  The list of resources and corresponding health status of those resources.

{
    "properties":{
        "resources_health":{
            "items":{
                "properties":{
                    "resource":{
                        "type":"string",
                        "title":"Resource",
                        "description":"The name of the resource that the application connects to."
                    },
                    "status":{
                        "type":"string",
                        "title":"Status",
                        "description":"The health of the resource"
                    },
                    "enum":[
                        "BAD",
                        "OK",
                        "UNKNOWN"
                    ],
                    "time_sec":{
                        "type":"number",
                        "title":"Time Sec",
                        "description":"The time expressed in seconds for the healthStatus endpoint to run a full health check and return a response."
                    }
                },
                "type":"object",
                "required":[
                    "resource",
                    "status",
                    "time_sec"
                ],
                "title":"ResourceHealth"
            },
            "type":"array",
            "title":"Resources Health",
            "description":"The list of resources and corresponding health status of those resources."
        }
    },
    "type":"object",
    "required":[
        "resources_health"
    ],
    "title":"ResourceHealthChecks"
}

Nested Schema : Resources Health

Type: array

Title: Resources Health

The list of resources and corresponding health status of those resources.

Show Source

• Array of: object ResourceHealth
  Title: ResourceHealth

{
    "items":{
        "properties":{
            "resource":{
                "type":"string",
                "title":"Resource",
                "description":"The name of the resource that the application connects to."
            },
            "status":{
                "type":"string",
                "title":"Status",
                "description":"The health of the resource"
            },
            "enum":[
                "BAD",
                "OK",
                "UNKNOWN"
            ],
            "time_sec":{
                "type":"number",
                "title":"Time Sec",
                "description":"The time expressed in seconds for the healthStatus endpoint to run a full health check and return a response."
            }
        },
        "type":"object",
        "required":[
            "resource",
            "status",
            "time_sec"
        ],
        "title":"ResourceHealth"
    },
    "type":"array",
    "title":"Resources Health",
    "description":"The list of resources and corresponding health status of those resources."
}

Nested Schema : ResourceHealth

Type: object

Title: ResourceHealth

Show Source

• resource(required): string
  Title: Resource

  The name of the resource that the application connects to.
• status(required): string
  Title: Status

  The health of the resource
• time_sec(required): number
  Title: Time Sec

  The time expressed in seconds for the healthStatus endpoint to run a full health check and return a response.

{
    "properties":{
        "resource":{
            "type":"string",
            "title":"Resource",
            "description":"The name of the resource that the application connects to."
        },
        "status":{
            "type":"string",
            "title":"Status",
            "description":"The health of the resource"
        },
        "enum":[
            "BAD",
            "OK",
            "UNKNOWN"
        ],
        "time_sec":{
            "type":"number",
            "title":"Time Sec",
            "description":"The time expressed in seconds for the healthStatus endpoint to run a full health check and return a response."
        }
    },
    "type":"object",
    "required":[
        "resource",
        "status",
        "time_sec"
    ],
    "title":"ResourceHealth"
}

Back to Top