v1

latestOpenAPI 3.0.12026-07-243407211.3 MB
Transfers

Handles health check requests for the Single Commit transfer operation. Used to verify the readiness and availability of the Single Commit transfer infrastructure for a given program. Accepts the program code and request ID, and returns a Gd.Bos.DataTransfer.Response.SingleCommitHealthCheckResponse indicating the health status.

get/programs/{programCode}/transfers/singlecommit/healthcheck

Path parameters

programCodestring required

The program code for the partner implementation. Identifies the specific program whose Single Commit health is being checked.

Headers

X-GD-RequestIdstring required

A unique identifier (GUID) for tracking the request.

Response

OK

statusstring nullable

Represents the health check status (e.g., "Healthy", "Unhealthy", "Degraded").