Skip to main content
GET
/
virtual-accounts
/
admin
/
dashboard
/
system-health
Admin dashboard system health
curl --request GET \
  --url https://prod-api.pcxpay.com/v1/virtual-accounts/admin/dashboard/system-health \
  --header 'Authorization: <authorization>' \
  --header 'X-Api-Key: <x-api-key>'
{
  "status": "success",
  "message": "Operation completed successfully",
  "data": {}
}

Headers

​
Authorization
string
default:NONE
required

Bearer JWT for user-facing flows (Bearer eyJraWQ...), or the literal string NONE when authenticating via API key.

Example:

"Bearer eyJraWQ..."

​
X-Api-Key
string
default:NONE
required

API key for server-to-server flows, or the literal string NONE when authenticating via JWT.

Example:

"pcx_abc123_xxxx"

Response

System health status

​
status
enum<string>
Available options:
success,
error
Example:

"success"

​
message
string
Example:

"Operation completed successfully"

​
data
object