Skip to content
/Service Health

Service Health

Check that the Manual Journal Entry API is available.

Operations

Check service health

Request

Purpose

Confirms that the Manual Journal Entry API and the journal entry processing service behind it are reachable. Use it in monitoring or before a batch run.

When to use

  • Before starting a batch load or an automated close job, to fail fast if the service is unavailable.
  • From monitoring or alerting tools that poll API availability.
Security
OneIdOAuth
cURL
curl -i -X GET \
  https://one.zuora.com/revenue/services/v1/journal-entries/healthcheck \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Service is available

Headers
traceIdstring

Identifier of the request. Quote it when you contact Zuora Support.

Bodyapplication/json
successbooleanrequired

true when the service is available.

Example:true
statusstringrequired

UP when the journal entry processing service responded. (When it does not respond the API returns HTTP 502.)

Value:"UP"
Example:"UP"
targetstring or null

Identifier of the component that was checked.

Example:"mje-backend"
detailsstring or null

Optional detail, for example a failure summary.

Response
{
  "success": true,
  "status": "UP",
  "target": "mje-backend"
}