Request Operations

GET1000 Get Overall Status (Ping)

Description

Returns the status of the service. This can be used for pinging the service.

Target Type

Collection

Request URL

Request URL defines the ping collection.

Example

• https://HOSTNAME/customerid-health/services/ping/

Request Method

GET

Request URL Parameters

No request specific request URL parameters.

Curl Example

curl --insecure -X GET "https://localhost:7443/customerid-health/services/ping/"

Response Document

These responses are plain text type responses. 

For success (HTTP Status: 200):

Status: OK

For failure (HTTP Status: 503):

Status: NOT OK

GET1001 Get Detailed Status

Description

Returns the status of the service. This can be used for checking if the service is down because of main/internal LDAP or SQL (or if it is up). Main LDAP can be either Ubisecure Directory or Active Directory. Internal LDAP is always Ubisecure Directory. So if Active Directory is not used then main LDAP directory is the same LDAP directory as internal LDAP directory.

Target Type

Collection

Request URL

Request URL defines the status collection.

Example

• https://HOSTNAME/customerid-health/services/status/

Request Method

GET

Request URL Parameters

No request specific request URL parameters.

Curl Example

curl --insecure -X GET "https://localhost:7443/customerid-health/services/status/"

Response Document

These responses are plain text type responses.

For Success (HTTP Status: 200):

Status: OK

SQL Monitor: OK:

Main LDAP Monitor: OK:

Internal LDAP Monitor: OK:

For Failure (HTTP Status: 503):

Status: NOT OK

SQL Monitor: NOT OK: <error message>

Main LDAP Monitor: NOT OK: <error message>

Internal LDAP Monitor: NOT OK: <error message>