> ## Documentation Index > Fetch the complete documentation index at: https://docs.telegent.com/llms.txt > Use this file to discover all available pages before exploring further. # Health Status > Check that the Telegent platform and its upstream dependencies are reachable. Use this as a pre-flight check before a batch of provisioning calls, or as the target for an uptime monitor. **What this checks:** - **`Database`** — the Telegent platform database connection. - **`TMobile_Api`** — reachability of the upstream T-Mobile API, verified with a live available-products call. Each check reports its own `Status`, how long it took in `Duration_Ms`, and an `Error` string that is `null` while the dependency is healthy. The top-level `Status` summarises both, and `Checked_On_UTC` is the UTC timestamp the checks ran. **Reading the response:** A dependency being unreachable does not fail the request — this endpoint returns HTTP `200` and reports the problem in the payload. Always read `Status` rather than relying on the HTTP status code alone, and check each dependency's `Error` for the underlying cause. **Note on `Duration_Ms`:** these are live round-trip times against the dependency, not cached values, so a slow-but-healthy upstream shows up as a large `Duration_Ms` with `Status: "Ok"`. ## OpenAPI ````yaml /api-reference/openapi.json post /v1.0/health-status openapi: 3.0.3 info: title: mPaaS Core APIs version: 1.0.8 description: >- The Telegent mPaaS (Mobile Platform as a Service) API gives you full programmatic control over mobile phone numbers, messaging, voice routing, subscribers, and account management. Use these APIs to provision MVNO and IoT numbers, send and receive SMS/MMS, configure intelligent call routing, manage subscriber accounts, and apply AI Guardian controls. All requests require a Bearer token obtained from the Authentication endpoint. For support, visit https://support.telegent.com/support/home contact: name: Support email: support@telegent.com termsOfService: https://telegent.com/terms license: name: Use under LICX url: https://telegent.com/license servers: - url: https://api.telegent.com security: - BearerAuth: [] tags: - name: OAuth2 - name: AI Guardian - name: Accounts - name: Distributors - name: Message - name: Numbers - name: Voicemail - name: Packages - name: Products - name: Schedules - name: Services - name: Sims - name: Subscribers - name: Subscriptions - name: Voice - name: Workgroups - name: Health Status paths: /v1.0/health-status: post: tags: - Health Status summary: Health Status description: >- Check that the Telegent platform and its upstream dependencies are reachable. Use this as a pre-flight check before a batch of provisioning calls, or as the target for an uptime monitor. **What this checks:** - **`Database`** — the Telegent platform database connection. - **`TMobile_Api`** — reachability of the upstream T-Mobile API, verified with a live available-products call. Each check reports its own `Status`, how long it took in `Duration_Ms`, and an `Error` string that is `null` while the dependency is healthy. The top-level `Status` summarises both, and `Checked_On_UTC` is the UTC timestamp the checks ran. **Reading the response:** A dependency being unreachable does not fail the request — this endpoint returns HTTP `200` and reports the problem in the payload. Always read `Status` rather than relying on the HTTP status code alone, and check each dependency's `Error` for the underlying cause. **Note on `Duration_Ms`:** these are live round-trip times against the dependency, not cached values, so a slow-but-healthy upstream shows up as a large `Duration_Ms` with `Status: "Ok"`. parameters: [] requestBody: required: false content: application/json: schema: type: object properties: ProductId: type: string nullable: true description: >- Optional product identifier forwarded to the upstream T-Mobile available-products call. Leave blank — the usual case — to check against every available product. responses: '200': description: Success — returns platform and dependency health content: application/json: schema: type: object examples: example: value: Status: Healthy Checked_On_UTC: '2026-08-10T18:15:37.9459153Z' Database: Status: Ok Duration_Ms: 1335 Error: null TMobile_Api: Status: Ok Duration_Ms: 2157 Error: null '400': description: Bad Request content: text/plain: schema: $ref: '#/components/schemas/BadRequest_Result' application/json: schema: $ref: '#/components/schemas/BadRequest_Result' examples: example: value: StatusCode: 400 Message: >- Bad request: one or more required fields are missing or contain an invalid value. text/json: schema: $ref: '#/components/schemas/BadRequest_Result' '401': description: Unauthorized content: text/plain: schema: $ref: '#/components/schemas/Unauthorized_Result' application/json: schema: $ref: '#/components/schemas/Unauthorized_Result' examples: example: value: StatusCode: 401 Message: >- Unauthorized: Bearer token is missing, expired, or invalid. Re-authenticate via POST /v1.0/oauth2/tokens. text/json: schema: $ref: '#/components/schemas/Unauthorized_Result' '403': description: Forbidden content: text/plain: schema: $ref: '#/components/schemas/Forbidden_Result' application/json: schema: $ref: '#/components/schemas/Forbidden_Result' examples: example: value: StatusCode: 403 Message: >- Forbidden: your token does not have permission to access this resource. Check the ApiEndpoint scope. text/json: schema: $ref: '#/components/schemas/Forbidden_Result' '404': description: Not Found content: text/plain: schema: $ref: '#/components/schemas/NotFound_Result' application/json: schema: $ref: '#/components/schemas/NotFound_Result' examples: example: value: StatusCode: 404 Message: >- Not found: the requested resource does not exist or belongs to a different account. text/json: schema: $ref: '#/components/schemas/NotFound_Result' '405': description: Method Not Allowed content: text/plain: schema: $ref: '#/components/schemas/MethodNotAllowed_Result' application/json: schema: $ref: '#/components/schemas/MethodNotAllowed_Result' examples: example: value: StatusCode: 405 Message: >- Method not allowed: verify the HTTP method required for this endpoint. text/json: schema: $ref: '#/components/schemas/MethodNotAllowed_Result' '408': description: Request Timeout content: text/plain: schema: $ref: '#/components/schemas/RequestTimeout_Result' application/json: schema: $ref: '#/components/schemas/RequestTimeout_Result' examples: example: value: StatusCode: 408 Message: >- Request timeout: the server did not receive a complete request within the allowed time. Retry with exponential backoff. text/json: schema: $ref: '#/components/schemas/RequestTimeout_Result' '429': description: Too Many Requests content: text/plain: schema: $ref: '#/components/schemas/TooManyRequests_Result' application/json: schema: $ref: '#/components/schemas/TooManyRequests_Result' examples: example: value: StatusCode: 429 Message: >- Too many requests: rate limit exceeded. Slow your request cadence and retry after a short delay. text/json: schema: $ref: '#/components/schemas/TooManyRequests_Result' '500': description: Server Error content: text/plain: schema: $ref: '#/components/schemas/InternalServerError_Result' application/json: schema: $ref: '#/components/schemas/InternalServerError_Result' examples: example: value: StatusCode: 500 Message: >- Internal server error: an unexpected error occurred. If the problem persists contact support@telegent.com. text/json: schema: $ref: '#/components/schemas/InternalServerError_Result' '503': description: Service Unavailable content: text/plain: schema: $ref: '#/components/schemas/ServiceUnavailable_Result' application/json: schema: $ref: '#/components/schemas/ServiceUnavailable_Result' examples: example: value: StatusCode: 503 Message: >- Service unavailable: the API is temporarily unavailable. Retry after a short delay. text/json: schema: $ref: '#/components/schemas/ServiceUnavailable_Result' '504': description: Gateway Timeout content: text/plain: schema: $ref: '#/components/schemas/GatewayTimeout_Result' application/json: schema: $ref: '#/components/schemas/GatewayTimeout_Result' examples: example: value: StatusCode: 504 Message: >- Gateway timeout: an upstream service did not respond in time. Retry with exponential backoff. text/json: schema: $ref: '#/components/schemas/GatewayTimeout_Result' x-codeSamples: - lang: JSON source: '{}' - lang: cURL source: |- curl -X POST https://api.telegent.com/v1.0/health-status \ -H 'Authorization: Bearer YOUR_TOKEN' \ -H 'Content-Type: application/json' \ -d '{}' components: schemas: BadRequest_Result: required: - StatusCode type: object properties: StatusCode: type: integer format: int32 Message: type: string nullable: true additionalProperties: false Unauthorized_Result: required: - StatusCode type: object properties: StatusCode: type: integer format: int32 Message: type: string nullable: true additionalProperties: false Forbidden_Result: required: - StatusCode type: object properties: StatusCode: type: integer format: int32 Message: type: string nullable: true additionalProperties: false NotFound_Result: required: - StatusCode type: object properties: StatusCode: type: integer format: int32 Message: type: string nullable: true additionalProperties: false MethodNotAllowed_Result: required: - StatusCode type: object properties: StatusCode: type: integer format: int32 Message: type: string nullable: true additionalProperties: false RequestTimeout_Result: required: - StatusCode type: object properties: StatusCode: type: integer format: int32 Message: type: string nullable: true additionalProperties: false TooManyRequests_Result: required: - StatusCode type: object properties: StatusCode: type: integer format: int32 Message: type: string nullable: true additionalProperties: false InternalServerError_Result: required: - StatusCode type: object properties: StatusCode: type: integer format: int32 Message: type: string nullable: true additionalProperties: false ServiceUnavailable_Result: required: - StatusCode type: object properties: StatusCode: type: integer format: int32 Message: type: string nullable: true additionalProperties: false GatewayTimeout_Result: required: - StatusCode type: object properties: StatusCode: type: integer format: int32 Message: type: string nullable: true additionalProperties: false ````