integrations

Trigger a health check

Manually trigger a health check for an integration.

post/integration/{integration_id}/health-check/

Request

  • Base URL: https://api.getoneprofile.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.getoneprofile.ai/integration/{integration_id}/health-check/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

integration_idstring uuid required

Response

Successful Response

checked_atstring date-time required

When the health check was performed.

error_codestring nullable

Machine-readable error code.

error_messagestring nullable

Human-readable error message.

idstring uuid required
status'healthy' | 'warning' | 'error' required

Changes

No recorded changes to this operation across all 1 revision of this API.