API reference / Admin

get/v1/admin/system/submission-worker

Read the submission worker control

Operation
adminGetSubmissionWorkerControl
Authentication
API key

Reports whether the government submission worker is enabled and whether it has sent a recent heartbeat.

Request

Responses

200Submission worker control and health.

Free-form JSON object.

400The request body or query failed validation.
errorobjectrequired
401No key, an unknown key, a revoked key, or a key whose tenant is not active. All four return an identical body on purpose: distinguishing them would let a caller discover which partners we have.
errorobjectrequired
403`projects:write` is required. No partner key is ever issued this scope.
errorobjectrequired
404Not found, or not yours. A resource belonging to another tenant answers 404 rather than 403, because 403 would confirm the record exists.
errorobjectrequired
503The runtime control has not been created by the database migration.
errorobjectrequired

Example

curl
curl -X GET https://api.haavisa.com/v1/admin/system/submission-worker \
  -H "Authorization: Bearer $HAAVISA_API_KEY"

More in Admin

Something unclear? The eligibility guide explains the model behind the answers; the errors guide covers the envelope.