Previous Next JavaScript must be enabled to correctly display this content

## Get health of PASJava/PASService/CycleService

get

/PASService/rest/services/v1/health

Get health of PASJava/PASService/CycleService

### 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 operation
Body ()
Root Schema : schema
Type: `object`
Show Source

- liveness: object liveness
- readiness: object readiness
- status: string
  Allowed Values: `[ "UP", "DOWN" ]`
- timestamp: string (date-time)

    {
        "type":"object",
        "properties":{
            "status":{
                "type":"string",
                "enum":[
                    "UP",
                    "DOWN"
                ]
            },
            "timestamp":{
                "type":"string",
                "format":"date-time"
            },
            "liveness":{
                "type":"object",
                "properties":{
                    "status":{
                        "type":"string",
                        "enum":[
                            "UP",
                            "DOWN"
                        ]
                    },
                    "timestamp":{
                        "type":"string",
                        "format":"date-time"
                    },
                    "checks":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "status":{
                                    "type":"string",
                                    "enum":[
                                        "UP",
                                        "DOWN"
                                    ]
                                },
                                "server":{
                                    "type":"string"
                                },
                                "hostname":{
                                    "type":"string"
                                }
                            }
                        }
                    }
                }
            },
            "readiness":{
                "type":"object",
                "properties":{
                    "status":{
                        "type":"string",
                        "enum":[
                            "UP",
                            "DOWN"
                        ]
                    },
                    "timestamp":{
                        "type":"string",
                        "format":"date-time"
                    },
                    "checks":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "status":{
                                    "type":"string",
                                    "enum":[
                                        "UP",
                                        "DOWN"
                                    ]
                                },
                                "name":{
                                    "type":"string"
                                },
                                "message":{
                                    "type":"string"
                                },
                                "latencyMs":{
                                    "type":"integer",
                                    "format":"int32"
                                }
                            }
                        }
                    }
                }
            }
        }
    }

Nested Schema : liveness
Type: `object`
Show Source

- checks: array checks
- status: string
  Allowed Values: `[ "UP", "DOWN" ]`
- timestamp: string (date-time)

    {
        "type":"object",
        "properties":{
            "status":{
                "type":"string",
                "enum":[
                    "UP",
                    "DOWN"
                ]
            },
            "timestamp":{
                "type":"string",
                "format":"date-time"
            },
            "checks":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "status":{
                            "type":"string",
                            "enum":[
                                "UP",
                                "DOWN"
                            ]
                        },
                        "server":{
                            "type":"string"
                        },
                        "hostname":{
                            "type":"string"
                        }
                    }
                }
            }
        }
    }

Nested Schema : readiness
Type: `object`
Show Source

- checks: array checks
- status: string
  Allowed Values: `[ "UP", "DOWN" ]`
- timestamp: string (date-time)

    {
        "type":"object",
        "properties":{
            "status":{
                "type":"string",
                "enum":[
                    "UP",
                    "DOWN"
                ]
            },
            "timestamp":{
                "type":"string",
                "format":"date-time"
            },
            "checks":{
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "status":{
                            "type":"string",
                            "enum":[
                                "UP",
                                "DOWN"
                            ]
                        },
                        "name":{
                            "type":"string"
                        },
                        "message":{
                            "type":"string"
                        },
                        "latencyMs":{
                            "type":"integer",
                            "format":"int32"
                        }
                    }
                }
            }
        }
    }

Nested Schema : checks
Type: `array`
Show Source

- Array of: object items

    {
        "type":"array",
        "items":{
            "type":"object",
            "properties":{
                "status":{
                    "type":"string",
                    "enum":[
                        "UP",
                        "DOWN"
                    ]
                },
                "server":{
                    "type":"string"
                },
                "hostname":{
                    "type":"string"
                }
            }
        }
    }

Nested Schema : items
Type: `object`
Show Source

- hostname: string
- server: string
- status: string
  Allowed Values: `[ "UP", "DOWN" ]`

    {
        "type":"object",
        "properties":{
            "status":{
                "type":"string",
                "enum":[
                    "UP",
                    "DOWN"
                ]
            },
            "server":{
                "type":"string"
            },
            "hostname":{
                "type":"string"
            }
        }
    }

Nested Schema : checks
Type: `array`
Show Source

- Array of: object items

    {
        "type":"array",
        "items":{
            "type":"object",
            "properties":{
                "status":{
                    "type":"string",
                    "enum":[
                        "UP",
                        "DOWN"
                    ]
                },
                "name":{
                    "type":"string"
                },
                "message":{
                    "type":"string"
                },
                "latencyMs":{
                    "type":"integer",
                    "format":"int32"
                }
            }
        }
    }

Nested Schema : items
Type: `object`
Show Source

- latencyMs: integer (int32)
- message: string
- name: string
- status: string
  Allowed Values: `[ "UP", "DOWN" ]`

    {
        "type":"object",
        "properties":{
            "status":{
                "type":"string",
                "enum":[
                    "UP",
                    "DOWN"
                ]
            },
            "name":{
                "type":"string"
            },
            "message":{
                "type":"string"
            },
            "latencyMs":{
                "type":"integer",
                "format":"int32"
            }
        }
    }

#### 503 Response

Service Unavailable
Back to Top

### Examples

Returns a JSON with all HEALTH checks for all services that accepts HTTP/HTTPS requests for PASJava/PASService/CycleService.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

    curl \
        -X GET \
        -H "Content-Type: application/json" \
        -u 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
        -L "http://server:port/PASService/rest/services/v1/health" \

Example Response Body

The following shows an example of the response body in JSON format for PASJava/PASService/CycleService:

    The following shows an example of the response body in JSON format for PASJava:

    {
      "status": "UP",
      "liveness": {
        "status": "UP",
      "timestamp": "2025-05-07T12:00:00Z",
      "checks": [
        {
          "server": "Server Name1",
          "status": "UP",
          "host": "linux server name"
        }
      ]
      },
      "readiness": {
      "status": "DOWN",
      "timestamp": "2025-05-07T12:00:00Z",
      "checks": [
        {
          "name": "Database",
          "status": "UP",
          "message": "Database is available"
        },
        {
          "name": "AsFile",
          "status": "UP",
          "message": "AsFile is UP for requests",
          "latencyMs": 12
        },
        {
          "name": "ExposedComputation",
          "status": "UP",
          "message": "ExposedComputation is UP for requests",
          "latencyMs": 25
        },
        {
          "name": "ValuePolicy",
          "status": "DOWN",
          "message": "ValuePolicy service is unavailable",
          "latencyMs": 3
        },
        {
          "name": "ProcessPolicy",
          "status": "DOWN",
          "message": "ProcessPolicy service is unavailable",
          "latencyMs": 3
        },
        {
        "name": "Cache",
        "status": "READY",
        "timestamp": "2025-05-07T12:00:00Z",
        "message": "Cache service is ready for requests",
        "latencyMs": 12
        },
        {
          "name": "UserService",
          "status": "UP",
          "message": "UserService is UP for requests",
          "latencyMs": 12
        },
        {
          "name": "UILogin",
          "status": "UP",
          "message": "UILogin service is UP for requests",
          "latencyMs": 12
        }
      ]
      }

    The following shows an example of the response body in JSON format for PASService:

    {
      "status": "UP",
      "liveness": {
          "status": "UP",
      "timestamp": "2025-05-07T12:00:00Z",
      "checks": [
        {
          "server": "Server Name1",
          "status": "UP",
          "host": "linux server name"
        }
      ]
      },
      "readiness": {
      "status": "DOWN",
      "timestamp": "2025-05-07T12:00:00Z",
      "checks": [
        {
          "name": "Database",
          "status": "UP",
          "message": "Database is available"
        },
      {
        "name": "Calendars",
        "status": "UP",
        "message": "Calendars service is UP for requests.",
        "latencyMs": 12
      },
      {
        "name": "Clients",
        "status": "UP",
        "message": "Clients service is UP for requests",
        "latencyMs": 25
      },
      {
        "name": "Cases",
        "status": "DOWN",
        "message": "Cases service is unavailable",
        "latencyMs": 3
      },
      {
        "name": "Codes",
        "status": "UP",
         "message": "Codes service is UP for requests.",
        "latencyMs": 12
      },
      {
        "name": "Companies",
       "status": "UP",
         "message": "Companies service is UP for requests",
        "latencyMs": 25
      },
      {
        "name": "Domains",
        "status": "UP",
        "message": "Domains service is UP for requests",
        "latencyMs": 3
      },
      {
        "name": "ExposedComputation",
        "status": "DOWN",
        "message": "ExposedComputation service is unavailable",
        "latencyMs": 3
      },
      {
        "name": "FileRecieved",
        "status": "UP",
        "message": "FileReceived service is UP for requests",
        "latencyMs": 12
      },
      {
        "name": "EncryptionService",
        "status": "UP",
        "message": "EncryptionService service is UP for requests",
        "latencyMs": 25
      },
      {
        "name": "Group Customer",
        "status": "DOWN",
         "message": "GroupCustomer service is unavailable",
        "latencyMs": 3
      },
       {
        "name": "OutboundApplications",
        "status": "DOWN",
        "message": "OutboundApplications service is unavailable",
        "latencyMs": 3
      },
      {
        "name": "Plans",
     "status": "UP",
        "message": "Plans service is UP for requests.",
        "latencyMs": 12
      },
      {
        "name": "Policies",
        "status": "UP",
         "message": "Policies service is UP for requests",
        "latencyMs": 25
      },
    {
        "name": "Roles",
        "status": "UP",
          "message": "Roles service is UP for requests",
        "latencyMs": 25
      },
    {
        "name": "Requirements",
        "status": "UP",
           "message": "Requirements service is UP for requests",
        "latencyMs": 25
      },
      {
        "name": "ProcessPolicy",
        "status": "DOWN",
          "message": "ProcessPolicy service is unavailable",
        "latencyMs": 3
      },
      {
        "name": "Products",
        "status": "UP",
          "message": "Products service is UP for requests",
        "latencyMs": 12
      },
      {
        "name": "Queries",
        "status": "UP",
          "message": "Queries service is UP for requests",
        "latencyMs": 25
      },
      {
        "name": "Schemas",
        "status": "DOWN",
          "message": "Schemas service is unavailable",
        "latencyMs": 3
      },
      {
        "name": "Segments",
        "status": "UP",
          "message": "Segments service is UP for requests",
        "latencyMs": 25
      },
      {
        "name": "UsersAndSecurityGroups",
        "status": "DOWN",
        "message": "Users and SecurityGroups service is unavailable",
        "latencyMs": 3
      }
      ]
      }

     The following shows an example of the response body in JSON format for CycleService:

     {
      "status": "UP",
      "liveness": {
      "status": "UP",
      "timestamp": "2025-05-07T12:00:00Z",
      "checks": [
        {
          "server": "Server Name1",
          "status": "UP",
          "host": "linux server name"
        }
      ]
    },
      "readiness": {
      "status": "DOWN",
      "timestamp": "2025-05-07T12:00:00Z",
      "checks": [
        {
          "name": "Database",
          "status": "UP",
          "message": "Database is available"
        },
        {
        "name": "Tasks",
        "status": "UP",
         "message": "Tasks is UP for requests."
       }
    ]
    }
    }

Back to Top