---
updatedAt: 2026-05-28T20:32:37.000Z
agentTools:
  projectIndex: https://docs.salussafety.io/llms.txt
---

# Health

Performs a basic health check and returns a response indicating API health.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "SALUS Developer API",
    "version": "0.11.69"
  },
  "servers": [
    {
      "url": "https://developer.beta.salussafety.io"
    }
  ],
  "paths": {
    "/health/check": {
      "get": {
        "tags": [
          "Status"
        ],
        "summary": "Health",
        "description": "Performs a basic health check and returns a response indicating API health.",
        "operationId": "get_health_health_check_get",
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiGenericResponse_Health_"
                }
              }
            }
          },
          "400": {
            "description": "Business Logic Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiGenericResponse_ErrorDetail_"
                }
              }
            }
          },
          "403": {
            "description": "Permission Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiGenericResponse_ErrorDetail_"
                }
              }
            }
          },
          "409": {
            "description": "Integrity Error or Data Conflict",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApiGenericResponse_ErrorDetail_"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "ApiGenericResponse_ErrorDetail_": {
        "properties": {
          "error": {
            "type": "boolean",
            "title": "Error Indicator",
            "description": "A boolean error indicator.",
            "default": false
          },
          "message": {
            "title": "Response Message",
            "description": "Optional message.",
            "type": "string",
            "nullable": true
          },
          "data": {
            "title": "Response Data",
            "description": "The response data for any given request.",
            "$ref": "#/components/schemas/ErrorDetail",
            "nullable": true
          }
        },
        "type": "object",
        "title": "ApiGenericResponse[ErrorDetail]"
      },
      "ApiGenericResponse_Health_": {
        "properties": {
          "error": {
            "type": "boolean",
            "title": "Error Indicator",
            "description": "A boolean error indicator.",
            "default": false
          },
          "message": {
            "title": "Response Message",
            "description": "Optional message.",
            "type": "string",
            "nullable": true
          },
          "data": {
            "title": "Response Data",
            "description": "The response data for any given request.",
            "$ref": "#/components/schemas/Health",
            "nullable": true
          }
        },
        "type": "object",
        "title": "ApiGenericResponse[Health]"
      },
      "ErrorDetail": {
        "properties": {
          "requestPath": {
            "title": "Request Path",
            "description": "The path of the request that generated the error.",
            "type": "string",
            "nullable": true
          },
          "requestMethod": {
            "title": "Request HTTP Method",
            "description": "The HTTP method of the request that generated the error.",
            "type": "string",
            "nullable": true
          },
          "errorType": {
            "type": "string",
            "title": "The Error Type that Occurred",
            "description": "The type of error that occurred, broadly it can be 'Database', 'BusinessLogic', or 'Permissions`"
          },
          "errorTypeDetail": {
            "title": "Errortypedetail",
            "description": "If available, an additional categorization of the error that occurred.",
            "type": "string",
            "nullable": true
          },
          "errorDetail": {
            "title": "Errordetail",
            "type": "string",
            "nullable": true
          }
        },
        "type": "object",
        "required": [
          "errorType"
        ],
        "title": "ErrorDetail",
        "description": "Generic error detail object that the API will return where errors are encountered. Details will be extracted to\nmake error processing more straight forward."
      },
      "Health": {
        "properties": {
          "status": {
            "type": "string",
            "title": "Status",
            "default": "Online"
          }
        },
        "type": "object",
        "title": "Health",
        "description": "Indicates API status."
      }
    }
  },
  "tags": [
    {
      "name": "Status",
      "description": "\nEndpoints related to the overall health of the API, most of these endpoints should not need authentication to ascertain\nthe status of the SALUS Developer API.\n"
    }
  ]
}
```