Object storage health check

This section describes how to check object storage health.

GET service ostor-health

Description

Lists information about object storage health.

Requests

Syntax

GET /?ostor-health HTTP/1.1
Host: <host>

GET /?ostor-health&maintenance=<true|false> HTTP/1.1
Host: <host>

Parameters

GET service ostor-users parameters

Parameter	Description	Required
maintenance	Checks if the host running the S3 GW services is in the requested maintenance state. Type: boolean. Default value: none.	No

Headers

This implementation uses only common request headers.

Responses

Headers

This implementation uses only common response headers.

Body

If the service is healthy and reachable, returns 200 OK status code.

With the maintenance parameter, returns 200 OK if the host is in the requested maintenance state and 412 Precondition Failed if the host state differs.

Examples

Sample request #1

Returns information about object storage health.

GET /?ostor-health HTTP/1.1
Host: s3.example.com

Sample response #1

HTTP/1.1 200 OK
Server: nginx
Date: Wed, 15 Oct 2025 12:15:23 GMT
Transfer-Encoding: chunked
Connection: close

Sample request #2

Checks if the host is in the maintenance state.

GET /?ostor-health&maintenance=true HTTP/1.1
Host: s3.example.com

Sample response #2

HTTP/1.1 412 Precondition Failed
Server: nginx
Content-Type: application/xml
Transfer-Encoding: chunked
Connection: close
Date: Wed, 05 Nov 2025 12:19:19 GMT
x-amz-req-time-micros: 83
x-amz-request-id: 800000000000002e0002ba950159f905