Skip to content

ConceptsStatus

Status

The status endpoint tells you whether the API is up. It is the only endpoint that works without authentication.

Last updated

Request

GET/v1/status

Send it with no headers and no body.

Response

{
  "status": "operational",
  "version": "v1",
  "time": "2025-01-15T10:00:00.000Z",
  "request_id": "req_abc123"
}
FieldTypeDescription
statusstring"operational" when the API is healthy, or "maintenance" when planned maintenance is active.
versionstringCurrent API version.
timestringServer time in ISO 8601 UTC.
request_idstringID of this request. Include it when you report a problem.

Example

curl https://shipmail.to/api/v1/status

Point uptime monitors, health checks and load balancer probes here. Any response other than 200, or no connection at all, means the API is down.